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 .

/**
 * @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.