JSDuck 4.10.3 released
I've released a series of dot-releases to patch some bugs:
- IE10 not showing newlines in code examples.
- XSS vulnerability on error pages.
- Regression in handling of links like #/guide/somename in guides.
Though the XSS vulnerability should be a relatively minor one, this is still a strongly recommended upgrade.
See the changelog for other changes.
JSDuck 5.0 beta 3 released
After a long wait, I finally have a new 5.0 beta for you to try.
Most importantly it features a redesigned custom member types system. The member types output is now easily customizable and one can take more advantage of JSDuck auto-detection capabilities. Plus as a treat one can easily include an icon for the custom member type. See the docs for more.
I'm also introducing a new @fires tag for documenting events that can be fired when a method is called. Plus it comes with auto-detection, so most of the @fires tags should just get auto-detected.
Finally this release also includes all the changes that have happened in JSDuck 4.x line.
As always, there's also a changelog.
Is there a way to sort the guides. perhaps this was answered before but I have been looking and cant find
You can sort them in however you want in guides config file, but there is no way for a user of the docs to sort them.
Is there an easy way for me to include my server side api and or database info into JSDuck? I'm not expecting it to be auto generated or anything, but is there a way for me to add items to the API list that are just markdown documents, that will allow me to document other aspects of my application?
For instance I have a WCF service I would want to document and a SQL Database that I would like to describe to the user. I can kinda use a psuedo ExtJS class to describe my service class. But I might want to list out my database tables and their columns as well.
You could write this info into a guide. Like these: http://docs.sencha.com/extjs/4.2.1/#!/guide
See the JSDuck wiki for docs on how to create your own: https://github.com/senchalabs/jsduck/wiki/Guides
I'm working on the same thing, I had to write a c# console app that would loop though the service api and create the json file and all the directories that was needed for this though since we have over 200 services. take a look
Attachment 44586Attachment 44587
sorting config, will it go in myconfig.json? or in guides.json? I was not clear on that can you give me an example on sorting by name?
What I meant was: you can manually order the guides in config file. But there's no feature for automatically sorting of them.
JSDuck 5.0 beta 4 released
I'm expecting a few regressions, as replacing the whole parser engine has been a major undertaking, but I've given it a good slew of various test runs, so it's actually fairly solid.
A few other minor fixes have gone in too, see the changelog for that.