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 does not deduce type of property from returns doc #1450

Closed
kring opened this issue Feb 8, 2014 · 0 comments
Closed

jsdoc does not deduce type of property from returns doc #1450

kring opened this issue Feb 8, 2014 · 0 comments
Labels
category - doc good first issue An opportunity for first time contributors

Comments

@kring
Copy link
Member

kring commented Feb 8, 2014

Take a look at the Viewer documentation:
http://cesiumjs.org/Cesium/Build/Documentation/Viewer.html?classFilter=Viewer&show=js

The animation property has a handy link to the Animation documentation but the centralBody property does not have a link to the CentralBody documentation. That's because the animation property attempts to document the property type like this:

 * @type {Animation}

And the centralBody property does it like this:

 * @returns {CentralBody} The primary central body.

Only the approach used by animation actually makes the type show up in the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category - doc good first issue An opportunity for first time contributors
Projects
None yet
Development

No branches or pull requests

3 participants