Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kimwalisch committed Feb 11, 2024
1 parent db87dbb commit c18e217
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
14 changes: 12 additions & 2 deletions src/app/cmdoptions.cpp
Original file line number Diff line number Diff line change
@@ -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, <[email protected]>
///
Expand Down
13 changes: 12 additions & 1 deletion src/app/main.cpp
Original file line number Diff line number Diff line change
@@ -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, <[email protected]>
///
Expand Down

0 comments on commit c18e217

Please sign in to comment.