javascript - Is it possible to add tags to JSDoc? -

-

i using meteor has odd caveats compared normal javascript. want add tags in order make documentation more explicit.

meteor.methods({   /**   * upgrade user's role   *   * @where anywhere   * @rolerequired 'admin'   *   * @module meteor.methods   * @method roles.upgrade   * @param {string|object} user userid or user document update   * @param {string} role role add user   * @throws meteor.error 401 if user trying upgrade not authorized   *    * @example   * meteor.call('roles.upgrade', meteor.users.findone(), function (err) {     if (!err) {       console.log('user added role');     } else {       router.error(401);     }   })   */   'roles.upgrade': function (user, role) {     if (roles.userisinrole(this.userid, 'admin')) {       return roles.addusertoroles(user, role);     } else {       throw new meteor.error(401, "not authorized upgrade roles")     }   } });

the @where , @rolerequired more specific meteor based application. @where can seen in devdocs.io.

is possible add tags jsdoc?

yes, possible add custom tags jsdoc. need create javascript file defines tags want add:

custom_tags.js exports.definetags = function(dictionary) { dictionary.definetag('where', { musthavevalue: true, ontagged : function(doclet, tag) { doclet.where = doclet.where || []; doclet.where.push(tag.value); } }); };

then need add location javascript file conf.json has plugin listed part of path

conf.json { "plugins": [ "plugins/test" ], }

finally need update .tmpl file default templates render information in generated documents. or can create own template , define own parse add tags generated documentation.


Comments

Post a Comment

Popular posts from this blog

yii2 - Yii 2 Running a Cron in the basic template -

-
i have seen instructions on running cron in advanced template, cant figure out how on basic template. have following controller in basic controllers folder. <?php namespace app\controllers; use yii\console\controller; /** * cron controller */ class croncontroller extends controller { public function actionindex() { echo "cron service runnning"; } public function actionmail($to) { echo "sending mail " . $to; } } i have navigated root of application , tried these comands yii cron php yii cron im getting unknown comand "cron" i know old question failed find actual answer this. if @ code yii exec file you'll notice requires /common/config/aliases.php file console/config/main.php. can naturally change these or copy on these advanced template. hope solves problem wanting same thing.
Read more

asp.net - 'System.Web.HttpContext' does not contain a definition for 'GetOwinContext' Mystery -

-
i realize question might seem trivial some, it's these types of things find myself fighting quite bit , want make sense of despite seeming losing battle in .net (for me anyway). so, if following: using system.web; ... applicationuser user = system.web.httpcontext.getowincontext().getusermanager<applicationusermanager>().findbyid(system.web.httpcontext.user.identity.getuserid()); that produces error in title , red getowincontext() , error cannot resolve symbol 'getowincontext()' however, if following (remove system.web in front of httpcontext ), works expected (or @ least no errors): using system.web; ... applicationuser user = httpcontext.getowincontext().getusermanager<applicationusermanager>().findbyid(system.web.httpcontext.user.identity.getuserid()); however, if (same line that's working using system.web commented out): //using system.web; ... applicationuser user = httpcontext.getowincontext().getusermana...
Read more

mercurial graft feature, can it copy? -

-
there new feature in mercurial 3, called 'graft' (graft local). job of moving change-set different branch. is there way "copy" change-set branch? i interested in in moving stuff qa branch production branch, still need code reside in qa. want copy. found , have tried few things, maybe it'll become clear more tinkering , reading... does have better way of 'cherry picking' change-sets move cross branch (or trunk)??? graft copies changesets, doesn't move them. hg graft (emphasis mine): this command uses mercurial's merge logic copy individual changes other branches without merging branches in history graph. known 'backporting' or 'cherry-picking' . default, graft copy user, date, , description source changesets.
Read more