Improve documentation

kimwalisch · Feb 11, 2024 · a9d248a · a9d248a
1 parent c18e217
commit a9d248a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/app/cmdoptions.cpp b/src/app/cmdoptions.cpp
@@ -12,6 +12,8 @@
 ///         1) Add a new option enum in cmdoptions.h.
 ///         2) Add your option to parseOptions() in cmdoptions.cpp.
 ///         3) Add your option to main() in main.cpp.
+///         4) Document your option in help.cpp (--help option summary)
+///            and in doc/primesieve.txt (manpage).
 ///
 /// Copyright (C) 2024 Kim Walisch, <[email protected]>
 ///

diff --git a/src/app/main.cpp b/src/app/main.cpp
@@ -12,6 +12,8 @@
 ///         1) Add a new option enum in cmdoptions.h.
 ///         2) Add your option to parseOptions() in cmdoptions.cpp.
 ///         3) Add your option to main() in main.cpp.
+///         4) Document your option in help.cpp (--help option summary)
+///            and in doc/primesieve.txt (manpage).
 ///
 /// Copyright (C) 2024 Kim Walisch, <[email protected]>
 ///