search

CesiumGS / cesium

An open-source JavaScript library for world-class 3D globes and maps :earth_americas:
https://cesium.com/cesiumjs/
Apache License 2.0
12.73k stars 3.45k forks source link

Ease of access to API reference #3507

Open Parthesh opened 8 years ago

Parthesh commented 8 years ago

Technically its not an issue with the Cesium library, but it is with the access to the API reference documentation. On this link http://cesiumjs.org/refdoc.html in the search box, if user enters children class names such as "getHeight" which belongs to "viewer.scene.globe", there are no search results. It would be helpful if this is improved.

emackey commented 8 years ago

For what it's worth, this kind of search is available in the Sandcastle editor. Try entering the following line of code:

// getHeight

Double-click the word getHeight to select it. Once it's selected, a tooltip pops up with a link to the documentation. Clicking this link opens the docs in an embedded tab next to your globe, so you can view the docs alongside the source you're editing at the same time.

billwritescode commented 7 years ago

Thanks for the tip @emackey. Agree that it's useful and with @Parthesh that document content search would be good to have in the refdoc.

ggetz commented 1 year ago

In https://github.com/CesiumGS/cesium/issues/11518, a user was looking to be able to search for API specific to 2D mode vs 3D.

ggetz commented 3 weeks ago

From https://github.com/CesiumGS/cesium/issues/9609:

We got some feedback on our JS doc layout used for our API doc. It would be convenient to list all the properties and methods in a class at the top of the page instead of having to scroll through everything to see what methods exist. See the Android docs summary for an example.