Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
0x1618 opened this issue Jul 20, 2024 · 1 comment
Open

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

0x1618 opened this issue Jul 20, 2024 · 1 comment

Comments

@0x1618
Copy link

0x1618 commented Jul 20, 2024

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

@0x1618
Copy link
Author

0x1618 commented Jul 21, 2024

This happens only with the constructor. If I change the constructor to a normal function, it works. However, the issue still remains, and I cannot generate my documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant