"Invalid tags found" warnings from @methoOf? about dgeni-packages HOT 9 CLOSED

Hi @c0bra

So what this message is saying is that there is no definition of the @methodOf tag in your dgeni configuration.

If you are using the latest version of dgeni-packages (0.10.0-rc.6) there is no such tag defined. We have got @memberof instead, defined in the jsdoc Package. See https://github.com/angular/dgeni-packages/blob/master/jsdoc/tag-defs/memberof.spec.js

So you either need to change your tags or add in this tag-def yourself into your configuration.

Does that help?

from dgeni-packages.

By the way methodof is not a supported JSDoc 3 tag either. I would try changing your tags to:

  /**
   * @ngdoc method
   * @name registerStyleComputation
   * @memberof ui.grid.class:Grid
   * @description registered a styleComputation function
   * 
   * If the function returns a value it will be appended into the grid's `<style>` block
   * @param {function($scope)} styleComputation function
   */

from dgeni-packages.

@petebacondarwin That helps a lot; thanks. I'm not sure how I would have found that out on my own, though. I couldn't find the latest syntax for ngdoc documented anywhere and was just going by what I was finding in the angular.js source and the wiki: https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation

from dgeni-packages.

I don't think @methodOf appears in the latest Angular source either.

from dgeni-packages.

Or even easier:

  /**
   * @ngdoc method
   * @name ui.grid.class:Grid#registerStyleComputation
   * @description registered a styleComputation function
   * 
   * If the function returns a value it will be appended into the grid's `<style>` block
   * @param {function($scope)} styleComputation function
   */

from dgeni-packages.

By the way I am not sure that the class: modifier is supported in the ngdoc Package out of the box.

from dgeni-packages.

Yea I think class: was from using grunt-ngdocs. @methodOf is still on that angular.js wiki page, which is where I was erroneously looking.

Is a guide for forward-porting older ngdoc'ed projects something that would be useful? I've tried this at least twice before and gave up but I'd really like to get past it. I've seen talk about the need for documenting how to use dgeni in a couple places. Is there anyone currently taking that on, or looking to?

from dgeni-packages.

Watch this space...

from dgeni-packages.

Closing for now as I think we have covered this particular issue.

from dgeni-packages.