diff --git a/documentation/src/cmp.dox b/documentation/src/cmp.dox index 21179df10..6c10762d8 100644 --- a/documentation/src/cmp.dox +++ b/documentation/src/cmp.dox @@ -38,7 +38,7 @@ It is wise for all developers to monitor these github related mailing list/newsg - fltk.bugs — (nntp/web) The "Old STR Bug Management System" activity (replaced by GitHub Issues). See "Managing Old STR's" To monitor these groups, either configure github to cc you on activity, or see the https://www.fltk.org/newsgroups.php page -and use either the web interface or NNTP instructions. +and use either the web interface or NNTP instructions. \section cmp_goals Specific Goals @@ -221,7 +221,7 @@ public: }; \endverbatim -Essentially, a comment starting with `/**` before the class or method defines the documentation for that class or method. These comments should appear in the header file for classes and inline methods and in the code file for non-inline methods. +Essentially, a comment starting with `/\**` before the class or method defines the documentation for that class or method. These comments should appear in the header file for classes and inline methods and in the code file for non-inline methods. In addition to Doxygen comments, block comments must be used liberally in the code to describe what is being done. If what you are doing is not "intuitively obvious to a casual observer", add a comment! Remember, you're not the only one that has to read, maintain, and debug the code. @@ -291,7 +291,7 @@ This means don't put the docs with the prototypes in the .H file, unless that's \verbatim /** - Here's a bullet list: + Here's a bullet list: - Apples - Oranges @@ -306,7 +306,7 @@ This means don't put the docs with the prototypes in the .H file, unless that's \verbatim /** - Here's a bullet list: + Here's a bullet list: