Как документировать литералы объектов в AngularJS, используя ngdoc?

После 2 дней поиска я не могу понять это. Допустим, у меня есть следующий контроллер:

/**
 * Sample Controller
 *
 * @ngdoc controller
 * @name module.sampleController
 * @requires $scope
 */

angular.module('module').controller('sampleController',

['$scope', function ($scope) {
    /**
     * Test function that renders correctly
     *
     * @function testFunction
     * @memberof sampleController
     */
    $scope.testFunction = function(){
        //do something...
    };

    /**
     * Object literal that doesn't show up in the doc
     *
     * @ngdoc object
     * @name testObject
     * @memberof sampleController
     * @property {string} foo first test prop
     * @property {number} bar hsecond test prop
     */
    $scope.testObject = {
        foo: null,
        bar: false,
        /**
         * method of testObject
         *
         * @ngdoc method
         * @methodOf sampleController.testObject
         */
        baz: function() {
            //do something else
        }
    };
}]);

Как я могу документировать литерал объекта, его свойства и методы?

0 ответов

Другие вопросы по тегам