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

5.x Client Catalog API and Docs #190

Open
lesserwhirls opened this issue Jan 21, 2020 · 0 comments
Open

5.x Client Catalog API and Docs #190

lesserwhirls opened this issue Jan 21, 2020 · 0 comments
Assignees
Labels
docs: content Content related documentation tasks

Comments

@lesserwhirls
Copy link
Collaborator

API docs need to be added to several of the classes down in thredds.catalog.client. For example, in:

https://github.com/Unidata/netcdf-java/blob/master/cdm/core/src/main/java/thredds/client/catalog/Catalog.java

The docs should at least point out that you need to use the builders:

https://github.com/Unidata/netcdf-java/tree/master/cdm/core/src/main/java/thredds/client/catalog/builder

(specifically CatalogBuilder for those wanting to read a THREDDS Client Catalog).

Also need to move https://github.com/Unidata/netcdf-java/blob/master/docs/src/private/website/netcdf-java/reference/ThreddsCatalogs.adoc into the main documentation set, as well as beef it up with some tangible examples (e.g. working with THREDDS Metadata, following catalogRef's).

Need to add thredds.catalog.client to the public API generation so that it is accessible via https://docs.unidata.ucar.edu/netcdf-java/<version>/javadoc/

@lesserwhirls lesserwhirls self-assigned this Jan 21, 2020
@JohnLCaron JohnLCaron added the docs: content Content related documentation tasks label Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs: content Content related documentation tasks
Projects
None yet
Development

No branches or pull requests

2 participants