-
Notifications
You must be signed in to change notification settings - Fork 6
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
Added isis class documentation guidelines #72
Closed
AustinSanders
wants to merge
4
commits into
DOI-USGS:main
from
AustinSanders:developer_references_class_documentation
Closed
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
4dd6191
Added isis class documentation guidelines
AustinSanders 524ce76
Added header
AustinSanders 89b6563
Merge branch 'main' of github.com:DOI-USGS/asc-public-docs into devel…
AustinSanders 1a853df
Removed author/date tags and description
AustinSanders File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
30 changes: 30 additions & 0 deletions
30
docs/how-to-guides/isis-developer-guides/isis-class-documentation.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# ISIS Class Documentation with Doxygen | ||
|
||
A new ISIS3 class needs to have the following Doxygen tags filled out just above the class declaration, as in this example below: | ||
|
||
```/** | ||
* @brief Add map templates to a project | ||
* Asks the user for a map template and copies it into the project. | ||
* | ||
* @author 2018-07-05 Summer Stapleton | ||
* @internal | ||
* @history 2018-07-05 Summer Stapleton - Created ImportMapTemplateWorkOrder | ||
* class | ||
* | ||
*/ | ||
class ImportMapTemplateWorkOrder : public WorkOrder {.... | ||
``` | ||
Sometimes, classes are declared inside the header files for other classes. This happens a lot in the $ISISROOT/src/qisis/objs directory where internal XmlHandler classes are defined to handle object serialization. | ||
These classes need to be documented as well (as in this example from the ImageList header file): | ||
|
||
```/** | ||
* This class is used to read an images.xml file into an image list | ||
* | ||
* @author 2012-07-01 Steven Lambright | ||
* | ||
* @internal | ||
*/ | ||
class XmlHandler : public XmlStackedHandler { | ||
``` | ||
|
||
All dates need to be filled out the way they are in the examples above (YYYY-MM-DD). Sometimes you will see dates in this format: 2012-??-???? or ????-??-??. Do not do this. Also, do not put any dashes or other symbols between the date and the name of the programmer. | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I remember when we transitioned to github this was something that we decided we weren't going to do anymore. Do we still want to include it here? @Kelvinrr thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Honestly I'm not a fan of this doc page in general. It seems like this should a be one-line blurb somewhere in a "code style" or "standards" doc rather than a separate page. I removed the outdated references, but we might consider just closing this PR rather than merging.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah we ended the history comments completely.
+1 to what Austin said, this should go under ISIS contributing docs on the repo. Any tutorial about contributing here should just link to it.