Skip to content

@returns object only support text, it does not provide a default return value formatted with code #1285

Open
@kopax

Description

@kopax

I have been trying to use @returns with an object and write the documentation.

I always get the same output, for instance:

* @returns {Object} result - The result state.
 * @returns {boolean} result.success - True if no errors.
 * @returns {boolean} result.generatedPdfFilePathList - List of generated PDF filepath.
 * @returns {Object} result.generatedLatexFilePathList - List of generated LaTeX filepath or undefined if nothing.
 * @returns {string} result.errors - List of errors or undefined if no errors.

It will not use <code> for result, after {object} everything is considered as text.

I have also tried:

 * @return {object} [result={
 *  success, // True if no errors.
 *  generatedPdfFilePathList, // List of generated PDF filepath.
 *  generatedLatexFilePathList, // List of generated LaTeX filepath or undefined if nothing.
 *  errors, // List of errors or undefined if no errors.
 * }] - The result object.

Same result.

This force us to write text while we wan't to describe the returned object:

 * @return {object} including success, generatedPdfFilePathList, generatedLatexFilePathList and errors

Is there a way to write documentation for this properly?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions