diff --git a/docs/how-to-guides/isis-developer-guides/class-requirements-for-using-doxygen-tags.md b/docs/how-to-guides/isis-developer-guides/class-requirements-for-using-doxygen-tags.md index 16aaeff..6d5848d 100644 --- a/docs/how-to-guides/isis-developer-guides/class-requirements-for-using-doxygen-tags.md +++ b/docs/how-to-guides/isis-developer-guides/class-requirements-for-using-doxygen-tags.md @@ -4,28 +4,8 @@ A new ISIS3 class needs to have the following Doxygen tags filled out just above /** * @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): - -```C++ - /** - * 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. If these documentation standards are not followed, PHP warnings get output when the nightly builds are run. \ No newline at end of file diff --git a/docs/how-to-guides/isis-developer-guides/isis-class-documentation.md b/docs/how-to-guides/isis-developer-guides/isis-class-documentation.md new file mode 100644 index 0000000..d7514fd --- /dev/null +++ b/docs/how-to-guides/isis-developer-guides/isis-class-documentation.md @@ -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. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 0f135f1..0dede20 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -76,6 +76,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 - Obtaining, Maintaining, and Submitting Test Data: how-to-guides/isis-developer-guides/obtaining-maintaining-submitting-test-data.md - ISIS Programming Exercises: - Exercise 1: how-to-guides/isis-developer-guides/exercise-1.md