[DOCS-3001] improve javascript docs in the server (http://api.mongodb.org/js/) Created: 26/Mar/14  Updated: 11/Jan/17  Resolved: 20/Aug/14

Status: Closed
Project: Documentation
Component/s: drivers, ecosystem, manual
Affects Version/s: None
Fix Version/s: 01112017-cleanup

Type: Improvement Priority: Major - P3
Reporter: Daniel Pasette (Inactive) Assignee: Unassigned
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
duplicates DOCS-1425 Document the JS test framework helper... Closed
duplicates DOCS-329 Document JS API Closed
Participants:
Days since reply: 9 years, 45 weeks, 1 day ago

 Description   

There are a couple options:

This is what we currently use, but we need to conform to the standard doc'ing format:
See: http://usejsdoc.org/
example: http://dygraphs.com/jsdoc/symbols/Dygraph.html

Could also get fancier and use JSDuck:
See:
http://stackoverflow.com/questions/14227339/can-jsduck-be-used-to-document-code-that-doesnt-use-sencha-frameworks

Here's an example:
http://docs.appcelerator.com/titanium/3.0/#!/api/Global.String



 Comments   
Comment by Sam Kleinman (Inactive) [ 08/Apr/14 ]

https://github.com/lunant/sphinxcontrib-autojs

Generated at Thu Feb 08 07:44:45 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.