search

cds-astro / aladin-lite

An astronomical HiPS visualizer in the browser
https://aladin.cds.unistra.fr/AladinLite/
GNU General Public License v3.0
103 stars 42 forks source link

document class methods for the API #186

Closed havok2063 closed 1 month ago

havok2063 commented 3 months ago

Is it possible to document the available public methods for object classes on the API? For example, the documentation for a Catalog, https://cds-astro.github.io/aladin-lite/Catalog.html, does not show any of the available methods. Currently you have to navigate the source code to find them. This makes it challenging to figure out how to develop programmatically.

bmatthieu3 commented 3 months ago

Sure the documentation has to be completed. Main important types I see are: Catalog, Image, HiPS, GraphicOverlay, MOC

bmatthieu3 commented 1 month ago

I added the documentation of the public methods for Catalog, Image, HiPS, GraphicOverlay, MOC classes.

havok2063 commented 1 month ago

Thank you! It's very helpful!