update for attribute documentation#1515
Merged
WardF merged 11 commits intoUnidata:masterfrom Nov 15, 2019
Merged
Conversation
… to them, also changed order of files in Doxygen.in
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.,;-) |
Contributor
Author
|
@WardF working late on a Friday night! ;-) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

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:
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):
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.