Skip to content

@doc annotation not working, @ngdoc works just fine #30

@mcos

Description

@mcos

I'm trying to run some of the examples using 0.2.4 version of grunt-docular. When I use the @doc annotation, nothing gets generated, but if I use @ngdoc, then it works just fine. Here are two examples I'm trying to run. First one has no documentation generated, second works just fine.

/**
 * @doc module
 * @id docular
 * @todo foobar
 * @description This module contains all the logic for the workflow of generating
 * partials and front end resources for display of docular documentation.
 *
 * Based off of Angular.js original implementation of gen-docs.js
 * Documentation code licensed under CC BY 3.0
 * http://creativecommons.org/licenses/by/3.0/
 */
/**
 * @ngdoc module
 * @id docular
 * @todo foobar
 * @description This module contains all the logic for the workflow of generating
 * partials and front end resources for display of docular documentation.
 *
 * Based off of Angular.js original implementation of gen-docs.js
 * Documentation code licensed under CC BY 3.0
 * http://creativecommons.org/licenses/by/3.0/
 */

My grunt config:

docular: {
      useHtml5Mode: false,
      docular_webapp_target : 'docs',
      groupTitle: 'App Test Docs',
      examples: {},
      groups: [
        {
          groupTitle: 'App Test Group',
          groupId: 'apptestgroup',
          groupIcon: 'book',
          sections: [
            {
              id: 'apptest',
              title: 'App Test',
              scripts: [
                'app.js'
              ],
            },
          ],
        },
      ],
    },

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions