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

Fix jsDoc to allow @exception tag on ECMAScript 5 properties... #832

Closed
mramato opened this issue Jun 3, 2013 · 10 comments
Closed

Fix jsDoc to allow @exception tag on ECMAScript 5 properties... #832

mramato opened this issue Jun 3, 2013 · 10 comments
Labels
category - doc category - tooling good first issue An opportunity for first time contributors

Comments

@mramato
Copy link
Contributor

mramato commented Jun 3, 2013

Documenting an exception on an ES5 property changes the property type to the exception type. In the below example, aValue shows up in the generated doc as type DeveloperError, instead of type Element. Removing the exception doc makes the problem go away.

/**
 * Gets or sets a value
 * @memberof MyClass.prototype
 * @type {Element}
 * @exception {DeveloperError} an error!
 */
aValue : {
    get : function() {
        return this._value;
    },
    set : function(value) {
        if (typeof value === 'undefined') {
            throw new DeveloperError('an error!');
        }
        this._value = value;
    }
}
@mramato
Copy link
Contributor Author

mramato commented Jun 3, 2013

@pjcozzi
Copy link
Contributor

pjcozzi commented May 29, 2014

@shunter is this fixed after the JSDoc upgrade?

@shunter
Copy link
Contributor

shunter commented May 29, 2014

No.

@pjcozzi pjcozzi removed the beginner label Jun 6, 2014
@pjcozzi
Copy link
Contributor

pjcozzi commented Jun 6, 2014

@shunter should this be listed as a JSDoc-specific problem in #1684?

@pjcozzi
Copy link
Contributor

pjcozzi commented Jun 24, 2014

@shunter should this be listed as a JSDoc-specific problem in #1684?

?

@shunter
Copy link
Contributor

shunter commented Jun 24, 2014

I think so. I don't think we can fix it externally.

@pjcozzi pjcozzi mentioned this issue Jun 24, 2014
5 tasks
@pjcozzi pjcozzi removed 1.0 labels Jun 24, 2014
@pjcozzi
Copy link
Contributor

pjcozzi commented Jan 2, 2017

Does anyone know if this is still an issue?

@pjcozzi pjcozzi added category - tooling good first issue An opportunity for first time contributors labels Jun 14, 2017
@pjcozzi
Copy link
Contributor

pjcozzi commented Jun 14, 2017

Upgrading to the latest JSDoc should fix this, #1859 (comment)

For a test case, check http://cesiumjs.org/releases/1.34/Build/Documentation/Model.html?classFilter=Model#boundingSphere

@ggetz ggetz moved this to Potential Onramping in CesiumJS Issue/PR backlog Jun 6, 2022
@ggetz ggetz moved this from Potential Onramping to Notable backlog items in CesiumJS Issue/PR backlog Jun 6, 2022
@mramato mramato removed their assignment Jan 5, 2023
@andynines
Copy link

Can this issue be closed? I can reconfirm @bampakoa's comment on #1859 that the problem is no longer present; I generated a test doc page using JSDoc 3.6.11 (the version my NPM resolved to from the version requirements of the package.json in the main branch) and the configuration found in Tools/jsdoc/conf.json.

@ggetz
Copy link
Contributor

ggetz commented Mar 13, 2023

Yes, I can confirm the issue is fixed prior to the minimum version of jsdoc in package.json.

Thanks @andynines!

@ggetz ggetz closed this as completed Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category - doc category - tooling good first issue An opportunity for first time contributors
Projects
No open projects
Archived in project
Development

No branches or pull requests

5 participants