कोणीय सेवा में फ़ंक्शन घोषणा को दस्तावेज़ित करने के लिए ngdoc का उपयोग कैसे किया जा सकता है?

Question

मैं एक कोणीय सेवा के भीतर एक समारोह घोषणा में ngdoc दस्तावेज जोड़ना चाहता हूं। मैं नीचे दिए गए उदाहरण में अपने समारोह के लिए यह कैसे कर सकता हूं?

मुझे लगता है कि मुझे @closure, @functionOf या @functionIn जैसे कुछ चाहिए।

कृपया ध्यान दें कि (myMethod के विपरीत) myFunction एक विधि नहीं है।

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

जो कुंजी नाम आप खोज रहे हैं वह @methodOf एनोटेशन है। जब मैं एक सेवा यह समाप्त होता है निम्नलिखित की तरह लग रही के लिए घुरघुराना-ngdocs का उपयोग करके दस्तावेज़ लिख रहा हूँ:

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

मैं केवल JSDoc, नहीं ngdoc के साथ अनुभव है, लेकिन आप @memberOf बजाय @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 
    } 

}]);