Skip to content

JSDoc and Documentation.js weird $0. output #1643

Description

@0x1618

I'm currently writing the documentation for my codebase, but I'm getting weird output when trying to unpack an Object in JSDoc to describe its properties.

/**
 * Foundational class for sending requests and managing responses.
 */
class AjaxRequest {
	/**
	 * Constructs a new instance with the given configuration.
	 *
	 * @constructor
	 * @param {Object} config - The configuration object.
	 * @param {string} config.endpoint - The endpoint URL for the request.
	 * @param {string} config.method - The HTTP method to use for the request (e.g., 'GET', 'POST').
	 * @param {string} config.contentType - The content type of the request (e.g., 'application/json').
	 * @param {Object} config.payload - The payload to be sent.
	 */
	constructor({ endpoint, method, contentType, payload }) {
    //code here
    }
}

This produces

Why do I get $0. ?

Documentation was generated using: documentation build ajax.js -f html -o docs

I am using the latest version of Documentation.js

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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