NgDocs Provider Come si usa?

Question

Lavoro su una documentazione per un framework sul mio team e voglio aggiungere provider. quando aggiungo fornitore @ngdoc che mi dicono:

Non so come formattare @ngdoc: fornitore

I hav sguardo sul modulo ngRoute di angolari e usano questa sintassi. Non capisco davvero ...

E una cosa ancora, sulla documentazione angolare usano il modulo @ngdoc, ho bisogno di usare invece l'oggetto. Penso di usare il modulo ngdoc npm sbagliato ma è l'ultima versione che ho trovato ...

Grazie se puoi aiutarmi!

PS: Uso il modulo npm grunt-ngdocs, se vuoi le mie opzioni di attività mi chiedono.

/** 
* @ngdoc object // module ? 
* @name App 
*/ 
"use strict"; 
angular.module('App', []) 

/** 
* @ngdoc provider 
* @name App.provider:AppConfigProvider 
*/ 
.provider('AppConfig', function() 
{ 
    //Some stuff 
}); 

Answer 1

Questa è una risposta in ritardo, ma ho appena capito io stesso così ho pensato che qualcun altro potrebbe rivelarsi utile.

Ho configurato due blocchi JSDoc nel mio file service.js. Uno è stato utilizzato per i metodi di servizio effettivi e l'altro è stato utilizzato per il provider.

Se lo si configura come nell'esempio qui sotto, nel file HTML generato, vedrai il nome del servizio che conterrà qualunque cosa tu abbia usato con 'servicename', e l'icona dei piccoli ingranaggi a destra del nome del servizio, e che sarà contiene tutto ciò che hai usato con 'servicenameProvider'.

Penso di averlo spiegato un po 'confuso, ma spero che tu abbia capito il punto.

/** 
    * @ngdoc service 
    * @module app 
    * @name servicename 
    * @description 
    * Service description 
    */ 

    /** 
    * @ngdoc service 
    * @module app 
    * @name servicenameProvider 
    * @description 
    * Service description 
    */