From c18e217ed07b6158e91480772d8dec401207b10a Mon Sep 17 00:00:00 2001 From: Kim Walisch Date: Sun, 11 Feb 2024 09:51:05 +0100 Subject: [PATCH] Improve documentation --- src/app/cmdoptions.cpp | 14 ++++++++++++-- src/app/main.cpp | 13 ++++++++++++- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/src/app/cmdoptions.cpp b/src/app/cmdoptions.cpp index 8def02e03..7796197ea 100644 --- a/src/app/cmdoptions.cpp +++ b/src/app/cmdoptions.cpp @@ -1,7 +1,17 @@ /// /// @file cmdoptions.cpp -/// @brief Parse command-line options for the primesieve console -/// (terminal) application. +/// @brief Command-line option handling for the primesieve +/// command-line application. The command-line options are +/// first parsed in cmdoptions.cpp and stored in a CmdOptions +/// object. Afterwards we execute the function corresponding +/// to the user's command-line options in the main() function +/// in main.cpp. +/// +/// How to add a new command-line option: +/// +/// 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. /// /// Copyright (C) 2024 Kim Walisch, /// diff --git a/src/app/main.cpp b/src/app/main.cpp index fd7265be1..7e5232c70 100644 --- a/src/app/main.cpp +++ b/src/app/main.cpp @@ -1,6 +1,17 @@ /// /// @file main.cpp -/// @brief primesieve console application. +/// @brief Command-line option handling for the primesieve +/// command-line application. The command-line options are +/// first parsed in cmdoptions.cpp and stored in a CmdOptions +/// object. Afterwards we execute the function corresponding +/// to the user's command-line options in the main() function +/// in main.cpp. +/// +/// How to add a new command-line option: +/// +/// 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. /// /// Copyright (C) 2024 Kim Walisch, ///