search

google-code-backups / proveit-js

Automatically exported from code.google.com/p/proveit-js
0 stars 0 forks source link

Generate method documentation from code #37

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago 
Use a tool to generate API documentation from code and JavaDoc comments.  I 
tried jsdoc-toolkit (http://code.google.com/p/jsdoc-toolkit/), but couldn't get 
it to pick anything up.

Getting this working may require modifying the comments and/or using another 
tool.

Some methods do not yet have any JavaDoc yet, and it must be added.

Original issue reported on code.google.com by matthew....@gatech.edu on 3 Sep 2010 at 7:53

GoogleCodeExporter commented 8 years ago 
I got both jsdoc_toolkit and YUI Doc (http://developer.yahoo.com/yui/yuidoc/) 
working with minor changes.  YUI seems a little nicer, and seems to support 
more flexible structure, but both would probably work fine.

I've attached a zip so you can do a quick comparison.  Both seem to have some 
configurability (templates, etc.), but I haven't investigated too closely.

Original comment by matthew....@gatech.edu on 3 Sep 2010 at 8:43

Attachments:

GoogleCodeExporter commented 8 years ago 
We decided to use YUI, and I committed the initial version in d61e2.

Original comment by matthew....@gatech.edu on 7 Sep 2010 at 8:24

GoogleCodeExporter commented 8 years ago 
Customize appearance of documentation to look more like website.

Original comment by kurt.luther on 21 Sep 2010 at 7:42

GoogleCodeExporter commented 8 years ago

Original comment by kurt.luther on 21 Sep 2010 at 7:52

GoogleCodeExporter commented 8 years ago 
All of the methods should have solid JavaDocs, as of a15b4.

Original comment by matthew....@gatech.edu on 12 Oct 2010 at 6:22

GoogleCodeExporter commented 8 years ago 
A version of the documentation needs to be on the website and linked from the 
Documentation link.

Original comment by kurt.luther on 26 Oct 2010 at 4:43

GoogleCodeExporter commented 8 years ago 
I just sent out a zip of the latest documentation, but we should decide on a 
process for this.

Original comment by matthew....@gatech.edu on 29 Oct 2010 at 8:19

GoogleCodeExporter commented 8 years ago 
When the site has permanent hosting, we will modify deploy.php to also deploy 
method documentation at the same time.  Configuration for this will also be 
stored in deploy_configuration.json.

Original comment by matthew....@gatech.edu on 2 Nov 2010 at 8:23

GoogleCodeExporter commented 8 years ago 
This issue was closed by revision e47422527c.

Original comment by matthew....@gatech.edu on 21 Nov 2010 at 1:16