Re: JSDoc templates to output XML format OR a good example/tutorial on how to build a JSDoc template from scratch

[Venkatram Akkineni]

How about this.

./jsdoc myscript.js -t templates/haruki -d console -q format=xml

https://github.com/jsdoc3/jsdoc/tree/master/templates/haruki

On Wed, Mar 6, 2013 at 8:12 PM, Ishita jain <its...@gmail.com> wrote:

Hi,

So I am trying to create a JSDoc template to ouput a XML representation of our code module comments.

I couldn't find any template online or any good tutorial or exxample on how can we build that from scratch.

Can anyone please help me and direct to right resource?

Thanks

--
You received this message because you are subscribed to the Google Groups "JSDoc Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jsdoc-users...@googlegroups.com.
To post to this group, send email to jsdoc...@googlegroups.com.
Visit this group at http://groups.google.com/group/jsdoc-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

--

Sincerely

Venkat R Akkineni

585 489 3259

[Jeff Williams]

I was just writing a very similar reply! Ishita, here's a little more information in case the Haruki template does not meet your needs:

The code for the Haruki template is pretty straightforward. Most of it is a giant forEach() statement that loops through the parse results and extracts information from them.

The Haruki template supports a subset of JSDoc tags; see the template overview for details. Adding support for new tags would be relatively easy--just update the forEach() statement to handle additional tags.

To generate XML, Haruki uses a library called js2xmlparser, which is included with JSDoc.

I hope that helps!

- Jeff

[Venkatram Akkineni]

:) Apologies for the telepathic malfuncition there Jeff.

[Ishita jain]

Thanks everyone for your help.

Jeff:

I just wonder that why do they have only publish file and not any template file (file with extension .tmpl).
I believe that these "tmpl" files are the one those shapes and structures the final output documentation.

[Jeff Williams]

Hi Ishita,

The Haruki template works a little differently. It just builds a JavaScript object, then converts the object to JSON or XML. The output has the same information as the JavaScript object, and it's organized in the same way; for example, the object's property names are mapped directly to XML element names.

In contrast, the default template generates output by extracting lots of bits and pieces from the parse tree; wrapping those bits and pieces with HTML; and combining them into output files. The .tmpl files define the logic and the HTML structure for the conversion process.

You could certainly create a template that uses .tmpl files to generate XML, but Haruki's approach is simpler.

- Jeff

[Michael Mathews]

Yes, that. You could even write your own app or process that consumes haruki XML or JSON and turns it into something else.

Michael Mathews
mic...@gmail.com

[Ishita jain]

Aaahhh..that explans it!

Moreover it only extracts a very few tags (whihc is already mentioned in readme file)

Thanks for your help .. I will try to build on top of that!

In case if you come across any other template that extracts document in XML format..please do let me know

Thanks a lot! :)

[Ishita jain]

So, I am trying to run the Haruki template but it throws a reference error.

It doesnt validate the template and says "publish" is not defined and "exports" is not defined in the line below:

exports.publish = function (data, opts) {

Please can any one tell me what am i doing wrong?

Thanks