Skip to content
This repository has been archived by the owner on Sep 6, 2023. It is now read-only.

choose a jsdoc framework #27

Open
aerhard opened this issue Apr 26, 2014 · 4 comments
Open

choose a jsdoc framework #27

aerhard opened this issue Apr 26, 2014 · 4 comments

Comments

@aerhard
Copy link

aerhard commented Apr 26, 2014

While adding further javascript documentation, I experimented a little bit with the jsDuck documentation framework, which appears to be quite powerful. Do you think this might be a good choice of a documentation framework or do you think other frameworks could be more suitable? For a demo of mei2vf with jsDuck, check out my jsdoc branch at https://github.com/aerhard/MEItoVexFlow/tree/jsdoc, where I added the generated website (click on Show private classes on the left and check private in the Show combo box on the right to display the documentation for non-public items).
The VexFlow jsdoc comments seem to target Docco.

@raffazizzi
Copy link

jsDuck seems a bit overkill to me. I'd rather use Docco to provide an annotated source. Backbone.js has a good example.

@aerhard
Copy link
Author

aerhard commented May 10, 2014

Yeah jsDuck might be too much.There's one thing I don't like about Docco: It doesn't support JSDoc style comments which I find really helpful, for example with their standardized way of documenting data types in function parameters. I created some sample documentations with other frameworks, see https://github.com/aerhard/MEItoVexFlow/tree/jsdoc. dox-docco looks just like Docco but supports JSDoc comments. Do you think that could be an option? YUIDoc seems to arrange the data in a very clear way.

@raffazizzi
Copy link

I'm now thinking that the generated docs shouldn't be added to the repositories. We can generate them and add the to the github pages. Doxx seemed the easiest to navigate to me.

@bwbohl
Copy link

bwbohl commented Jun 27, 2014

I've been experimenting with docco a bit, but apparently the block style comments are missing. If this is fine with dox-docco, I'd go for it.
As for the generated documentation, I wouldn't incude them either gitHub pages seems the right place

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants