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

update for attribute documentation #1515

Merged
merged 11 commits into from
Nov 15, 2019

Conversation

edhartnett
Copy link
Contributor

@edhartnett edhartnett commented Nov 8, 2019

Fixes #1512

Previously we had been trying to get by with one documentation block for all the different types of nc_get_att_, and another for nc_put_att_. But this was an imperfect solution.

Some problems:

  • many functions do not get correct links throughout the documentation (though some of them are working).
  • documentation had to be confusingly general.
  • nearly-duplicate documentation blocks were needed to handle typeless and string type functions.

So, after this PR, each att fucntion gets its own doxygen documentation, which makes doxygen happy. I have edited the documentation to take repeated parts out and put them in the member group for "Reading Attributes" and "Writing Attributes" and have added achors to them so they can be referred to from each function definion, which now include (for the gets):

 * Also see @ref getting_attributes "Getting Attributes"
 *

Now we have a place to put documentation about getting attributes that applies to all types, and also the function documentation for each type, to note type-specific info as with text or string types.

@edhartnett edhartnett requested a review from WardF as a code owner November 8, 2019 11:50
… to them, also changed order of files in Doxygen.in
@edhartnett
Copy link
Contributor Author

@WardF if we could get this merged soon, similar fixes are needed for the var functions, and I would like to get them in before your next release.,;-)

@WardF WardF merged commit e4003be into Unidata:master Nov 15, 2019
@edhartnett
Copy link
Contributor Author

@WardF working late on a Friday night! ;-)

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

better documentation required for the _text attribute calls, in C and Fortran
2 participants