¿Cómo documento un objeto privado dentro de otro objeto privado con JSDoc?

Estoy usando el kit de herramientas jsdoc para documentar un proyecto, y tengo un problema al documentar un objeto privado dentro de otro objeto privado.

Recibí esta advertencia:

ADVERTENCIA: Intentando documentar la conexión como miembro de testObject de símbolo no documentado.

Pero el testObject aparece bien en mi salida de Docs como '{Object} testObject'

Aquí está la prueba del archivo javascript:

/* 
 * @fileOverview Various Test functions.
 * @author Regards
 */

 /**
 * @description testUtilsNameSpace 'namespace' helps 
 * @name testUtils
 * @type Object
 * @namespace
 **/
(function($) {
'use strict';

    /**
    * @description minPageReached private var
    * @private
        * @type number
    * @name testUtils#minPageReached
    * @field
    */
    var minPageReached = 0;

    /**
     * @description maxPageReached public var
     * @type number
     */
    testUtils.maxPageReached = 0;

    /**
     * @description testPrivate private function
     * @inner
     * @param {page} page Info on the page you want to request
     * @type Function
     * @memberOf testUtils
     */
    var testPrivate = function(page){
        console.log("testPrivate");
    };

    /**
     * @description testPublic public function
     * @param {page} page Info on the page you want to request
     * @type Function
     * @memberOf testUtils
     */
    testUtils.testPublic = function(page){
            console.log("testPublic");
    }


    /**
     * @description loadDependencies function
     * @type Function
     * @memberOf testUtils
     */
    var loadDependencies = function() {

    };

    /**
    * @description testObject
    * @private
    * @field
    * @name testUtils#testObject
    * @type Object
    */
    var testObject = {

            /**
             * @description connection object
             * @field
             * @name testObject#connection
             * @type Object
             */
            connection: {

            }

    }

})(window.jQuery);

preguntado el 26 de abril de 12 a las 08:04

No tengo experiencia con JSDoc, pero tal vez esté esperando testUtils#testObject#connection? Por cierto, documentar una variable privada es extraño. -

@Domenic ya probó esas cosas, bien porque la advertencia desaparece, pero no hubo suerte porque no hay rastro de mi objeto en la salida de la documentación:

¿Estás seguro de que JSDoc admite la documentación de variables privadas? -

Creo que hay una etiqueta @private en el documento:

¿Podría agregar la línea de comando que estaba usando para reproducir esto? Lo he reproducido con jsdoc.js test.js -a all-

0 Respuestas

No es la respuesta que estás buscando? Examinar otras preguntas etiquetadas or haz tu propia pregunta.