apify
apify copied to clipboard
Only comments starting with "/**" should be recognized
According to http://usejsdoc.org/about-getting-started.html:
"JSDoc comments should generally be placed immediately before the code being documented. It must start with a /**
sequence in order to be recognized by the JSDoc parser. Comments beginning with /*
, /***
, or more than 3 stars will be ignored. This is a feature to allow you to suppress parsing of comment blocks. "
For example:
/*global define, $, brackets, window */
define(function (require, exports, module) {
The show code button for the following block of code is truncated after the function signature. If I remove the comment block the show code button shows the entire function.
function registerCustomViewer(langId, provider) {
/*
* Custom View Providers must register an object which has the following method signatures:
* render(fullpath, $holder) is called to render the HTML Dom Node for the custom viewer at $holder for fullpath.
* onRemove() is called when it's time to remove the DOM node
*/
if (!_customViewerRegistry[langId]) {
_customViewerRegistry[langId] = provider;
} else {
console.error("There already is a custom viewer registered for language id \"" + langId + "\"");
}
}