docs(data-point): add @class tags #431
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
added 2 commits
September 18, 2019 23:22
Replaced @alias tags with @Class and @classdesc tags. Added DataPoint temporary favicon. Closes issue no. 422
…or unstable version.
Codecov Report
@@ Coverage Diff @@
## canary #431 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 29 29
Lines 482 482
Branches 74 74
=====================================
Hits 482 482
Continue to review full report at Codecov.
|
csarnataro
changed the title
acatl
approved these changes
Sep 19, 2019
| @@ -5,10 +5,11 @@ function normalizeName(name) { | |||
| } | |||
|
|
|||
| /** | |||
| * @alias Reducer | |||
| * @class | |||
| * @classdesc This class is never instantiated directly, it is used to create | |||
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
What:
Replaced jsdoc
@aliastag with more meaningful@classand@classdesctagsApparently the reason why
@aliaswas used is that it allows to create automatic links between jsdoc pages. But after doing some experiments, it just turned out that also@classtags generate automatic links between pages.See here for example:
https://csarnataro.github.io/data-point/jsdoc/Reducer.html#resolveReducer
If you click on
Accumulator, it will take you to the Accumulator documentation page https://csarnataro.github.io/data-point/jsdoc/Accumulator.htmlWhy:
To use the more semantically appropriate tag.
How:
Just replacing
@aliaswith@classand adding@classdescwhere applicable.Checklist:
Closes #422
Please see https://csarnataro.github.io/data-point/jsdoc/ or https://csarnataro.github.io/data-point/jsdoc/Reducer.html#resolveReducer to check if this is the intended behaviour of internal links