-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix jsdoc of style.get and similar get functions.
jsdoc attempts to put `style.get` into the `geo.feature.style` namespace, but `geo.feature.style` is a function, not a namespace, so it doesn't appear. This adds a jsdoc plugin that allows putting a dot in the name of a doclet that appears in the rendered documentation. This results ins `style.get` appearing in the list of `geo.feature`'s methods.
- Loading branch information
Showing
5 changed files
with
25 additions
and
0 deletions.
There are no files selected for viewing
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
/** | ||
* Allow doclet names to include a dot. The text '_DOT_' is replaced by a dot | ||
* in the documentation. | ||
*/ | ||
var dotToken = '_DOT_'; | ||
|
||
exports.handlers = { | ||
processingComplete: function (e) { | ||
e.doclets.forEach(function (doclet) { | ||
if (doclet.name.indexOf(dotToken) >= 0) { | ||
doclet.name = doclet.name.replace(new RegExp(dotToken, 'g'), '.'); | ||
} | ||
}); | ||
} | ||
}; |
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 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 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