ngdoc 

Send to Kindle
home » snippets » angularjs » ngdoc



Tag Description
@ngdoc specifies the type of thing being documented. See below for more detail.
@scope specifies that the documented directive will create a new scope
@priority specifies the documented directive's priority
@animations specifies the animations that the documented directive supports
@methodOf type links a method to the object/service where it is defined
@propertyOf type links a property to the object/service where it is defined
@eventOf type links a method to the object/service where it is defined
@eventType emit | broadcast specifies whether the event is emitted or broadcast

Snippets

/**
 * @ngdoc directive
 * @ngdoc event
 * @ngdoc filter
 * @ngdoc function
 * @ngdoc inputType
 * @ngdoc interface
 * @ngdoc method
 * @ngdoc object
 * @ngdoc overview
 * @ngdoc property
 * @ngdoc service
 */

@example

<example module="deepLinking" deps="angular-sanitize.js">

Examples

From src/ng/rootElement.js

/**
 * The root element of Angular application. This is either the element where {@link
 * ng.directive:ngApp ngApp} was declared or the element passed into
 * {@link angular.bootstrap}. The element represent the root element of application. It is also the
 * location where the applications {@link AUTO.$injector $injector} service gets
 * published, it can be retrieved using `$rootElement.injector()`.
 */
{@link ng.directive:form `form`}
{@link ng.directive:form form}
{@link ng.directive:form.FormController FormController}
{@link ng.directive:input input element}
{@link ng.directive:input.checkbox checkbox}
{@link ng.directive:ngAnimate ngAnimate}
{@link ng.directive:ngAnimate#Description common ng directives}
{@link ng.directive:ngApp ngApp}
{@link ng.directive:ngIf#animations ngIf}
{@link ng.directive:script inlined templates}