yadop/built/lib/ngdoc/tags.d.ts

Yet another Doc Parser

import * as doctrine from 'doctrine';
export declare namespace tags {
    namespace annotations {
        /**
         * Indicates if the tag is contains a @description tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function description(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the tag is contains a @deprecated tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function deprecated(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the tag is contains a @methodOf tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function methodOfTag(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the tag is contains a @module tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function module(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the tag is contains a @name tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function name(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the tag is contains a @ngdoc tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function ngdoc(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the tag is contains a @param tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function param(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the tag is contains a @requires tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function requires(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the tag is contains a @return tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function returns(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the tag is contains a @name tag.
         * @param tag The tag.
         * @param tagNames List of tag name aliases
         * @return {boolean} indicator The indicator.
         * @private
         */
        function _onlyAtTags(tag: doctrine.Tag, tagNames: string[]): boolean;
    }
    namespace values {
        /**
         * Indicates if the tag is contains a @method tag.
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function method(tag: doctrine.Tag): boolean;
        /**
         * Indicates if the has description module. -> @ngdoc module
         * @param tag The tag.
         * @return {boolean} indicator The indicator.
         */
        function module(tag: doctrine.Tag): boolean;
    }
}