Adding more documentation to fix some warnings

Henry Fredrick Schreiner
1 parent 9d6830e8
Showing 5 changed files with 16 additions and 5 deletions
docs/Doxyfile
include/CLI/FormatterFwd.hpp
include/CLI/Option.hpp
include/CLI/Timer.hpp
include/CLI/Validators.hpp
@@ -334,7 +334,7 @@ BUILTIN_STL_SUPPORT    = NO
 # enable parsing support.
 # The default value is: NO.
-CPP_CLI11_SUPPORT        = NO
+CPP_CLI_SUPPORT        = NO
 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
@@ -86,9 +86,11 @@ class FormatterBase {
 class FormatterLambda final : public FormatterBase {
     using funct_t = std::function<std::string(const App *, std::string, AppFormatMode)>;
+    /// The lambda to hold and run
     funct_t lambda_;
   public:
+    /// Create a FormatterLambda with a lambda function
     explicit FormatterLambda(funct_t funct) : lambda_(std::move(funct)) {}
     /// This will simply call the lambda function
@@ -51,6 +51,7 @@ template &lt;typename CRTP&gt; class OptionBase {
     /// Policy for multiple arguments when `expected_ == 1`  (can be set on bool flags, too)
     MultiOptionPolicy multi_option_policy_{MultiOptionPolicy::Throw};
+    /// Copy the contents to another similar class (one based on OptionBase)
     template <typename T> void copy_to(T *other) const {
         other->group(group_);
         other->required(required_);
@@ -440,7 +441,7 @@ class Option : public OptionBase&lt;Option&gt; {
     /// The number of times the option expects to be included
     int get_expected() const { return expected_; }
-    /// \breif The total number of expected values (including the type)
+    /// \brief The total number of expected values (including the type)
     /// This is positive if exactly this number is expected, and negitive for at least N values
     ///
     /// v = fabs(size_type*expected)
@@ -83,6 +83,7 @@ class Timer {
     }
     // LCOV_EXCL_START
+    /// This prints out a time string from a time
     std::string make_time_str(double time) const {
         auto print_it = [](double x, std::string unit) {
             char buffer[50];
@@ -30,11 +30,14 @@ namespace CLI {
 struct Validator {
     /// This is the type name, if empty the type name will not be changed
     std::string tname;
-    std::function<std::string(const std::string &filename)> func;
+
+    /// This it the base function that is to be called.
+    /// Returns a string error message if validation fails.
+    std::function<std::string(const std::string &)> func;
     /// This is the required operator for a validator - provided to help
-    /// users (CLI11 uses the func directly)
-    std::string operator()(const std::string &filename) const { return func(filename); };
+    /// users (CLI11 uses the member `func` directly)
+    std::string operator()(const std::string &str) const { return func(str); };
     /// Combining validators is a new validator
     Validator operator&(const Validator &other) const {
@@ -165,6 +168,10 @@ const detail::NonexistentPathValidator NonexistentPath;
 ///  Produce a range (factory). Min and max are inclusive.
 struct Range : public Validator {
+    /// This produces a range with min and max inclusive.
+    ///
+    /// Note that the constructor is templated, but the struct is not, so C++17 is not
+    /// needed to provide nice syntax for Range(a,b).
     template <typename T> Range(T min, T max) {
         std::stringstream out;
         out << detail::type_name<T>() << " in [" << min << " - " << max << "]";