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

API documentation #4571

Closed
wants to merge 9 commits into from
Closed

API documentation #4571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
13c7e6d
added documentation comment block to isEOF function located at src/co…
pablofiumara Apr 7, 2014
571cfef
completed documentation of isEOF function located at src/core/parser.js
pablofiumara Apr 7, 2014
6abb61b
completed documentation of isEOF function located at src/core/parser.js
pablofiumara Apr 7, 2014
ef2d7e9
moved API docs from ./out to ./external/jsdoc
pablofiumara Apr 8, 2014
632be58
added comments to document EOF function at /src/core/parser.js
pablofiumara Apr 10, 2014
b361e76
API documentation designed based on src/display/api.js
pablofiumara Apr 13, 2014
c713a7c
added strict mode
pablofiumara Apr 13, 2014
ce86b21
added strict mode
pablofiumara Apr 13, 2014
fa796ce
deleted output of JSDoc
pablofiumara Apr 13, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ tags
.DS_Store
Makefile
node_modules/
nbproject/
.project
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

non related changes

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right. My mistake. I am sorry.

9 changes: 9 additions & 0 deletions src/core/parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,17 @@

'use strict';

/**
*
* @global creation of EOF blank object
*/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This adds 4 lines of the code, which brings no value to the developers. A developer can read the following single line understand that without reading previous 4 lines.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yury, please, remember that this was a preview. This was not a "final version" of how API docs comments. I have just commited this so that some of you agreed on making the API Docs.

var EOF = {};


/** @function
* @name isEOF
* @param v
* @return {boolean} true or false */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No function description, what it's for and what it does.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yury, please, remember that this was a preview. This was not a "final version" of how API docs comments. I have just commited this so that some of you agreed on making the API Docs.

function isEOF(v) {
return (v == EOF);
}
Expand Down