W jaki sposób można użyć ngdoc do dokumentowania deklaracji funkcji w usłudze kątowej?

Question

Chciałbym dodać dokumentację ngdoc do deklaracji funkcji w ramach usługi kątowej. Jak mogę to zrobić dla mojej funkcji w poniższym przykładzie?

Podejrzewam, że potrzebuję czegoś takiego jak @klasowanie, @functionOf lub @functionIn.

Należy pamiętać, że (w przeciwieństwie do myMethod) myFunction nie jest metodą.

/** 
* @ngdoc service 
* @name myApp.service:myService 
* @description 
* My application. 
*/ 
angular 
    .module('myApp') 
    .factory('myService', function() { 
    'use strict'; 

    var x = 0; 

    /** 
    * @ngdoc function 
    * @name ? 
    * @description 
    * How can this be identified as being within the closure of 
    * myService, and not be described as a constructor? 
    */ 
    function myFunction (z) { 
     x++; 
     x += z; 
    } 

    return { 
     /** 
     * @ngdoc method 
     * @name myMethod 
     * @methodOf myApp.service:myService 
     * @description 
     * A method of myService. 
     */ 
     myMethod : function (x) { 
     myFunction(x); 
     } 
    }; 
    }) 

Answer 1

Nazwa klucza, której szukasz, to adnotacja @methodOf. Kiedy piszę dokumentację używając Grunt-ngdocs za usługę kończy się wyglądać jak następuje:

/** 
    * @ngdoc overview 
    * @name module 
    * @description A small module containing stuff 
    */ 
angular 
    .module(module, []) 
    .factory('name', factory); 

/** 
    * @ngdoc object 
    * @name module.name 
    * @description Its a pretty bad factory 
    */ 
function factory() { 
    return { 
    doSomething: doSomething 
    }; 

    /** 
    * @ngdoc function 
    * @name module.name#doSomething 
    * @methodOf module.name 
    * @description Does the thing 
    * @param {string=} [foo='bar'] This is a parameter that does nothing, it is 
            optional and defaults to 'bar' 
    * @returns {undefined} It doesn't return 
    */ 
    function doSomething(foo){...} 
} 

Answer 2

mam tylko doświadczenie z JSDoc, nie ngdoc, ale czy próbowałeś @memberOf zamiast @methodOf?

Link to JSDoc page for memberOf

Answer 3

/** 
* @ngdoc controller 
* @name MyApp.myController:myController 
* @description 
* This is myController controller. 
**/   
angular.module('MyApp').controller('myController', ['$scope', function($scope) {  

    /** 
    * @ngdoc function 
    * @name myFunction 
    * @methodOf MyApp.controller:myController 
    * @description 
    * This function does something 
    */ 
    function myFunction(){ 
    // do something 
    } 

}]);