@doc overview @id index @name DocTypes Intro @description #Documentation Types (DocTypes) Things to know about ``docTypes``. 1. ``DocTypes`` are what Docular uses to determine how to render the document. 2. ``DocTypes`` are the value specified next to the ``documentation identifier``. ```js /** * @ngdoc directive */ ``` So in the above example "@ngdoc" is the ``documentation identifier`` and "directive" is the ``docType``. And this would be like saying hey "@ngdoc" plugin, I want you to render this document as a "directive". Then the "@ngdoc" plugin would say, "Dude, no problem, I'm on it." ### DocTypes Need Params to Render So just because you said "Yo! Render a service for me." doesn't mean the plugin will be able to. You may need to provide some mandatory and/or optional parameters by giving it the proper "@<key>" value pairs. Check out the next two sections to see the types of params expected for each docType. @doc overview @id types_doc @name @doc DocTypes @description ## @doc DocTypes are the Default DocTypes `@doc` documentation plugin contain the default docTypes that all plugins inherit from. Unless they are overriden, they will be available for every documentation plugin. ## DocTypes

@doc overview ( {@link docularinstall/installnode example} )
The ``overview`` docType is meant to simply render whatever is within the "@description". Note, this page was rendered as an overview.

Expected Params
- ``id`` : Must be provided, or "@name" must be provided.
```
@id 
```
- ``name`` : Optional, unless "@id" is not provided. Value displays in menus and as the titles.
```
@name 
```
- ``description`` :
```
@description  
```

@doc module ( {@link docular/docular example} )
The ``module`` docType generates a bit of a 'splash' page where you can talk generally about the module. It will print out the "@name" attribute which should match the "@id" of the module. You can then use the "@description" to provide more information and quick links.

Expected Params
- ``id`` : Must be provided, or "@name" must be provided.
```
@id 
```
- ``name`` : Optional, unless "@id" is not provided. Value displays in menus and as the titles.
```
@name 
```
- ``description`` :
```
@description  
```

@doc function ( {@link /documentation/example/doctypes/doctypes_doc.class:doc_function example} )
The ``function`` docType is used as a single function or method

Expected Params
- ``id`` : Must be provided, or "@name" must be provided.
```
@id 
```
- ``name`` : Optional, unless "@id" is not provided. Value displays in menus and as the titles.
```
@name 
```
Optional Params
- ``returns``:
```
@returns {} 
```
- ``param`` : Provide one param for each param that the function accepts
```
@param {} 
```
- ``description`` :
```
@description  
```

@doc method ( {@link /documentation/example/doctypes/doctypes_doc.class:doc_method example} )

SEE `@doc function`

@doc interface ( {@link /documentation/example/doctypes/doctypes_doc.class:doc_interface example} )
Expected Params
- ``id`` : Must be provided, or "@name" must be provided.
```
@id 
```
- ``name`` : Optional, unless "@id" is not provided. Value displays in menus and as the titles.
```
@name 
```
Optional Params
- ``property`` : Provide as many as necessary
```
@property {}   
```
- ``description`` :
```
@description  
```

@doc object ( {@link /documentation/example/doctypes/doctypes_doc.class:doc_object example} )

SEE `@doc interface`

@doc overview @id types_ngdoc @name @ngdoc DocTypes @description 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 ( {@link /documentation/example/doctypes/doctypes_ngdoc.directive:directive_example example} )
The ``directive`` docType provides an overview for the usage of an {@link /documentation/angular/guide/directive AngularJS directive}.

Expected Params
- ``id`` : Must be provided, or "@name" must be provided.
```
@id 
```
- ``name`` : Optional, unless "@id" is not provided. Value displays in menus and as the titles.
```
@name 
```
- ``element`` : Describes how this directive is used by specifying one of the following element types: "ANY", "ELEMENT, or "ATTRIBUTE".
```
@element 
```
Optional Parameters
- ``description`` :
```
@description  
```
- ``example`` :
```
@example  
```
  More documentation coming here. This may not be usable easily for third party code without a lot of effort.
Sample Doc
```
/**
 * @ngdoc directive
 * @name module.directive:sample
 * @element ANY
 * @description
 * This is a sample description.
 */
            
```
@ngdoc filter ( {@link /documentation/example/doctypes/doctypes_ngdoc.filter:filter_example example} )
The ``filter`` docType provides an overview for the usage of an {@link /documentation/angular/guide/dev_guide.templates.filters AngularJS filter}.

Expected Params
- ``id`` : Must be provided, or "@name" must be provided.
```
@id 
```
- ``name`` : Optional, unless "@id" is not provided. Value displays in menus and as the titles.
```
@name 
```
Optional Parameters
- ``description`` :
```
@description  
```
Sample Doc
```
/**
 * @ngdoc filter
 * @name module.filter:sample
 * @description
 * This is a sample description.
 */
            
```
@ngdoc service ( {@link /documentation/example/doctypes/doctypes_ngdoc.service:service_example example} )
The ``service`` docType provides an overview for the usage of an {@link /documentation/angular/guide/dev_guide.services AngularJS service}.

Expected Params
- ``id`` : Must be provided, or "@name" must be provided.
```
@id 
```
- ``name`` : Optional, unless "@id" is not provided. Value displays in menus and as the titles.
```
@name 
```
Optional Parameters
- ``description`` :
```
@description  
```
Sample Doc
```
/**
 * @ngdoc service
 * @name module.service:sample
 * @description
 * This is a sample description.
 */
            
```

@doc overview ( {@link docularinstall/installnode example} )

Expected Params

@doc module ( {@link docular/docular example} )

Expected Params

@doc function ( {@link /documentation/example/doctypes/doctypes_doc.class:doc_function example} )

Expected Params

Optional Params

@doc method ( {@link /documentation/example/doctypes/doctypes_doc.class:doc_method example} )

@doc interface ( {@link /documentation/example/doctypes/doctypes_doc.class:doc_interface example} )

Expected Params

Optional Params

@doc object ( {@link /documentation/example/doctypes/doctypes_doc.class:doc_object example} )

@ngdoc directive ( {@link /documentation/example/doctypes/doctypes_ngdoc.directive:directive_example example} )

Expected Params

Optional Parameters

Sample Doc

@ngdoc filter ( {@link /documentation/example/doctypes/doctypes_ngdoc.filter:filter_example example} )

Expected Params

Optional Parameters

Sample Doc

@ngdoc service ( {@link /documentation/example/doctypes/doctypes_ngdoc.service:service_example example} )

Expected Params

Optional Parameters

Sample Doc