Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Annotated source code? #176

Open
mercmobily opened this issue Sep 20, 2013 · 3 comments
Open

Annotated source code? #176

mercmobily opened this issue Sep 20, 2013 · 3 comments

Comments

@mercmobily
Copy link

Hi,

I fell in love with yuidoc -- thank you for writing it!
Along with the source documentation, I would love to see annotated documentation. This would be the "documentator's heaven", so that rather than showing the source as, I would have the option to show something like this:

http://backbonejs.org/docs/backbone.html

If you are not so inclined, could you please give me a few hints to go through the source and tell me how you'd go about it?

Thank you!

Merc.

@mercmobily
Copy link
Author

A few hints on how to go about this one would be great, so that I can make a pull request!

@caridy
Copy link
Member

caridy commented Jan 14, 2014

Hmm, that will be great, but I don't have a clue where to start.

@mercmobily
Copy link
Author

Sorry, my question seemed designed to make me look dumb. My actual question: assume that I have a function that goes annotate( string, cb ), which will call cb( err, annotatedResult) with the annotated result. Where would you slot it, in the code?

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

No branches or pull requests

2 participants