8000 Document "nested property" syntax for the `param` tag · Issue #52 · jsdoc/jsdoc.github.io · GitHub
[go: up one dir, main page]
Skip to content
/ jsdoc.github.io Public
Document "nested property" syntax for the param tag #52
New issue
New issue
Closed
Closed
Document "nested property" syntax for the param tag#52
Milestone
 
3.3.0
@hegemonic

Description

@hegemonic
hegemonic
opened on Mar 9, 2014

The docs for @param need to show the "nested property" syntax for documenting an object's properties:

/**
 * Sample method.
 * @param {Object} options - Options for the sample method.
 * @param {string} options.foo - The name of the foo.
 */
function sampleMethod(options) {
    // ...
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions
      0