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.

Sign up for GitHub

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

Jump to bottom

API Documentation with JSDoc #37

Open
bruderol opened this issue Oct 9, 2016 · 2 comments
Open

API Documentation with JSDoc #37

bruderol opened this issue Oct 9, 2016 · 2 comments
Labels
2 - Working 4.0.x enhancement

Comments

@bruderol
Copy link
Member

bruderol commented Oct 9, 2016 •
edited
Loading

Currents JSDoc is useless, it does not provide nice types and descriptions for them and no good entry points, like globals etc.
bruderol added a commit that referenced this issue Oct 9, 2016
@bruderol
#37 improve jsdoc and understandability of our code (1st try)
0d48e87
@bruderol
Copy link
Member Author

bruderol commented Oct 9, 2016

@dola @adiherzog
I started to optimize our code for JSDoc a little bit.
Work in progress, see Branch: feature/jsdoc
Feedback or even help appreciated.

@bruderol
Copy link
Member Author

bruderol commented Oct 9, 2016

This is far from finished, but at least you can see in my comment above, what we have to change to make the jsDoc usable.

bruderol added a commit that referenced this issue Oct 9, 2016
@bruderol
#37 documented JSDoc API Documentration again with a link to give fee…
0614cbf 
…dback about ScenariooJS
bruderol added a commit that referenced this issue Oct 9, 2016
@bruderol
#37 ignore internal functions for JSDoc API documentation
9c1e510
bruderol added a commit that referenced this issue Oct 9, 2016
@bruderol
#37 document scenarioo top level namespace
f12d9cc
bruderol added a commit that referenced this issue Oct 9, 2016
@bruderol
#37 rebuilt
f8c5d19
@bruderol bruderol changed the title JSDoc for ScenariooJS 2.2 API Documentation with JSDoc Dec 4, 2016
@bruderol bruderol added 3.0.1 and removed 3.0.0 labels Dec 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
2 - Working 4.0.x enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bruderol