Improve jsdoc documentation. #738
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This fixes the jsdoc linting errors for several files and improves the auto-generated documentation.
manthey
force-pushed
the
improve-docs
branch
from
6832fbd
to
86c6590
Compare
aashish24
reviewed
Sep 23, 2017
src/camera.js
Outdated
| @@ -649,6 +655,14 @@ | |||
|
|
|||
| /** | |||
| * Public exposure of the viewFromCenterSizeRotation function. | |||
| * @param {object} center | |||
| * @param {number} center.x | |||
| * @param {number} center.y | |||
There was a problem hiding this comment.
should we make a note of units for size (pixels) and center?
There was a problem hiding this comment.
Also, the private function has the explanation of what the function does but not the public function. The API docs generated shows only one line. thoughts?
aashish24
reviewed
Sep 23, 2017
src/featureLayer.js
Outdated
| */ | ||
| this._exit = function () { | ||
| m_this.clear(); | ||
| s_exit(); | ||
| }; | ||
|
|
||
| /** | ||
| * Draw | ||
| * Draw. If the layer is visible, call the parent class's draw function and | ||
| * the renderer's _render function. |
There was a problem hiding this comment.
I am thinking that mentioning a private method might be less useful. We could just state the this calls the renderer render function.
aashish24
reviewed
Sep 26, 2017
src/layer.js
Outdated
| @@ -428,7 +454,7 @@ var layer = function (arg) { | |||
| }; | |||
|
|
|||
| /** | |||
| * Clean up resouces | |||
| * Clean up resouces. | |||
aashish24
reviewed
Sep 26, 2017
src/layer.js
Outdated
| */ | ||
| this.height = function () { | ||
| return m_this.map().size().height; | ||
| }; | ||
|
|
||
| /** | ||
| * Get or set the current layer opacity. | ||
| * Get or set the current layer opacity. The opacity is in teh range [0-1]. |
aashish24
reviewed
Sep 26, 2017
aashish24
approved these changes
Sep 26, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes the jsdoc linting errors for several files and improves the auto-generated documentation.