Documentation generation for function callbacks #482
Merged
Conversation
This file contains 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
…ocument_callbacks
docs: update comments explaining specialized traversal logic
kennyweiss
reviewed
Feb 25, 2021
white238
reviewed
Feb 25, 2021
src/axom/inlet/Inlet.cpp
Outdated
| @@ -73,9 +73,28 @@ void writerHelper(Writer& writer, const Container& container) | |||
| { | |||
| // Use a pre-order traversal for readability | |||
| writer.documentContainer(container); | |||
| for(const auto& sub_container_entry : container.getChildContainers()) | |||
| // If the current container contains a collection, visit that last to ensure | |||
white238
reviewed
Feb 25, 2021
white238
reviewed
Feb 25, 2021
| - Default Value | ||
| - Range/Valid Values | ||
| - Required | ||
| * - 0 |
white238
reviewed
Feb 25, 2021
| - Required | ||
| * - coef | ||
| - The function representing the BC coefficient | ||
| - Double(Vector, Double) |
There was a problem hiding this comment.
This is great! Should we have two columns? one for return type and one for parameters? Is this clear enough that the first double is the return type?
white238
approved these changes
Feb 25, 2021
There was a problem hiding this comment.
While still not perfect. This is a definite improvement. The array of primitives is probably going to need a large amount of work that is out of the scope of this PR. Thanks @joshessman-llnl !
…ng schemas for nested structures
…e more interesting syntax help
|
This should get merged after #490 due to the changes made in that PR relating to traversal logic. |
…document_callbacks
agcapps
approved these changes
Mar 29, 2021
1 task
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.
Summary
Containerto record function signature information to the datastoreTo save space and maintain generality function arguments/return types are stored as integers (corresponding to the
FunctionTagenum) in the datastore.To produce legible documentation for the MFEM coefficient and nested struct examples this PR also modifies the
SphinxWriterto only display documentation for the first element of an array/dictionary instead of the same schema for each element. This logic is currently part of the sphinx-specific generation logic but could be simplified considerably if moved to theWriter-independent traversal logic.