Set up documentation generator
-
Andor Salga- Milestone set to 0.4
- Milestone order changed from 3 to 0
-
aSydiK- State changed from open to new
-
aSydiK
- Milestone cleared.
-
Andor Salga
- State changed from new to assigned
- Milestone set to 0.6
- Assigned user set to Andor Salga
- Milestone order changed from 2 to 0
The new version of JSDoc-toolkit seems to properly document closures, so we can use it to generate our docs!
-
Andor Salga
- State changed from assigned to review-requested
- Tag set to docs
I set up jsdoc-toolkit and added a bunch of comments to the PointStream and ASCParser classes.
Branch: http://github.com/asalga/XB-PointStream/tree/bug15
There are two ways in which the docs can be generated:
You can run make, which will make a release and generate the docs.
OR, you can also cd into tools/jsdoc-toolkit and run gendocs.sh.
Both those scripts should generate the documentation in the docs/ folder.Make sure to delete the docs folder between running the scripts.
-
Andor Salga
- State changed from review-requested to staged
-
Andor Salga
- State changed from staged to checked-in
Please Sign in or create a free account to add a new ticket.
With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.