@ngdoc DocTypes

The @ngdoc documentation plugin inherits all docTypes from the default @doc documentation plugin and adds in the following docTypes. Check out the 'expected', and 'optional' fields each docType expects and click 'example' to view a rendered example.

DocTypes

• @ngdoc directive ( example )

  The directive docType provides an overview for the usage of an AngularJS directive.

  Expected Params

  • id : Must be provided, or "@name" must be provided.

    @id <id>

  • name : Optional, unless "@id" is not provided. Value displays in menus and as the titles.

    @name <name>

  • element : Describes how this directive is used by specifying one of the following element types: "ANY", "ELEMENT, or "ATTRIBUTE".

    @element <element type>

  Optional Parameters

  • description :

    @description <multi-line description> 

  • example :

    @example <multi-line markup parsed as an example object> 

    Here is an example: