Set up documentation generator
Reported by Andor Salga | June 27th, 2010 @ 04:35 PM | in 0.6
We can probably go with jsdoc-toolkit: http://code.google.com/p/jsdoc-toolkit/
Comments and changes to this ticket
-
Andor Salga June 28th, 2010 @ 03:30 PM
- Milestone set to 0.4
- Milestone order changed from 3 to 0
-
aSydiK July 21st, 2010 @ 09:01 PM
- State changed from open to new
-
aSydiK July 22nd, 2010 @ 03:21 PM
- Milestone cleared.
-
Andor Salga February 10th, 2011 @ 03:12 AM
- 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 February 14th, 2011 @ 06:46 PM
- 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 March 17th, 2011 @ 09:38 PM
- State changed from review-requested to staged
-
Andor Salga March 27th, 2011 @ 07:05 PM
- 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.
Create your profile
Help contribute to this project by taking a few moments to create your personal profile. Create your profile ยป
<b>XB PointStream</b> (working name)
A cross-browser JavaScript tool which will emulate Arius3D's PointStream viewer. It will be able to quickly render a large amount of point cloud data to the <canvas> tag using WebGL.<br />
Current release <a href="http://scotland.proximity.on.ca/asalga/releases/0.8/xbps-min-0.8.zip">XBPS 0.8</a>