From a9d248a40533c37005c75ccae60951fc405281c7 Mon Sep 17 00:00:00 2001 From: Kim Walisch Date: Sun, 11 Feb 2024 10:06:26 +0100 Subject: [PATCH] Improve documentation --- src/app/cmdoptions.cpp | 2 ++ src/app/main.cpp | 2 ++ 2 files changed, 4 insertions(+) diff --git a/src/app/cmdoptions.cpp b/src/app/cmdoptions.cpp index 7796197ea..21546f8e6 100644 --- 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, /// diff --git a/src/app/main.cpp b/src/app/main.cpp index 7e5232c70..4a049c683 100644 --- 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, ///