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

Added isis class documentation guidelines #72

Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.

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?

Copy link
Contributor Author

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.

Copy link
Collaborator

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.

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ nav:
- Class Requirements For Using Doxygen Tags: how-to-guides/isis-developer-guides/class-requirements-for-using-doxygen-tags.md
- Developing ISIS3 with cmake: how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md
- ISIS Development on the Mac M1 ARM System: how-to-guides/isis-developer-guides/developing-mac-m1-arm-systems.md
- ISIS Class Documentation: how-to-guides/isis-developer-guides/isis-class-documentation.md
- ALE Developer Guides:
- Creating Ale Drivers: how-to-guides/ale-developer-guides/creating-ale-drivers.md
- Concepts:
Expand Down
Loading