misc: some docs

Author: Toni500github

include/libcufetch/common.hh

@@ -31,14 +31,15 @@
 
 constexpr const char NOCOLOR[]      = "\033[0m";
 constexpr const char NOCOLOR_BOLD[] = "\033[0m\033[1m";
+
+// Didn't find what you were looking for.
 constexpr const char UNKNOWN[]      = "(unknown)";
 
-// Usually in neofetch/fastfetch when some infos couldn't be queried,
-// they remove it from the display. With customfetch is kinda difficult to know when to remove
-// the info to display, since it's all modular with tags, so I have created
-// magic line to be sure that I don't cut the wrong line.
+// Usually in neofetch/fastfetch when some infos couldn't be queried, they remove it from the display.
+// With customfetch is kinda difficult to know when to remove the info to display,
+// since it's all modular with tags, so I have created a "magic line" to be sure that I don't cut the wrong line.
 //
-// Every instance of this string in a layout line, the whole line will be erased.
+// Every instance of this string found in a layout line, the whole line will be erased.
 constexpr const char MAGIC_LINE[] = "(cut this line NOW!! RAHHH)";
 
 #define APICALL extern "C"
@@ -52,39 +53,50 @@ inline bool debug_print = true;
 inline bool debug_print = false;
 #endif
 
+// std::format function arguments
+// Print to stderr an error with header 'ERROR:' in red
 template <typename... Args>
 void error(const std::string_view fmt, Args&&... args) noexcept
 {
     fmt::print(stderr, "\033[1;31mERROR: {}\033[0m\n",
                fmt::format(fmt::runtime(fmt), std::forward<Args>(args)...));
 }
 
+// std::format function arguments
+// Print to stderr an error with header 'FATAL:' in red and exit with failure code
 template <typename... Args>
 void die(const std::string_view fmt, Args&&... args) noexcept
 {
     fmt::print(stderr, "\033[1;31mFATAL: {}\033[0m\n",
                fmt::format(fmt::runtime(fmt), std::forward<Args>(args)...));
-    std::exit(1);
+    std::exit(EXIT_FAILURE);
 }
 
+// std::format function arguments
+// Print to stdout a debug msg with header '[DEBUG]' in hot-pink color
+// only if debug_print is set (do not modify it).
 template <typename... Args>
 void debug(const std::string_view fmt, Args&&... args) noexcept
 {
     if (debug_print)
-        fmt::print("\033[1;38;2;255;105;180m[DEBUG]:\033[0m {}\n",
+        fmt::print(stdout, "\033[1;38;2;255;105;180m[DEBUG]:\033[0m {}\n",
                    fmt::format(fmt::runtime(fmt), std::forward<Args>(args)...));
 }
 
+// std::format function arguments
+// Print to stderr a warning with header 'WARNING:' in yellow
 template <typename... Args>
 void warn(const std::string_view fmt, Args&&... args) noexcept
 {
-    fmt::print("\033[1;33mWARNING: {}\033[0m\n",
+    fmt::print(stderr, "\033[1;33mWARNING: {}\033[0m\n",
                fmt::format(fmt::runtime(fmt), std::forward<Args>(args)...));
 }
 
+// std::format function arguments
+// Print to stdout an info msg with header 'INFO:' in cyan
 template <typename... Args>
 void info(const std::string_view fmt, Args&&... args) noexcept
 {
-    fmt::print("\033[1;36mINFO: {}\033[0m\n",
+    fmt::print(stdout, "\033[1;36mINFO: {}\033[0m\n",
                fmt::format(fmt::runtime(fmt), std::forward<Args>(args)...));
 }

include/libcufetch/cufetch.hh

@@ -4,7 +4,8 @@
 #include <string>
 #include <vector>
 
-#include "libcufetch/parse.hh"
+#include "libcufetch/common.hh"
+struct parse_args_t;
 
 /* A linked list including module arguments. An argument may be specified for any part of the module path (e.g.
  * `disk(/).used(GiB)`, `test.hi(a)`) */

include/libcufetch/parse.hh

@@ -6,6 +6,7 @@
 
 #include "libcufetch/common.hh"
 #include "libcufetch/config.hh"
+#include "libcufetch/cufetch.hh"
 
 // C ABI is needed to prevent symbol mangling, but we don't actually need C compatibility,
 // so we ignore this warning about return types that are potentially incompatible with C.
@@ -14,8 +15,6 @@
 #pragma clang diagnostic ignored "-Wreturn-type-c-linkage"
 #endif
 
-struct module_t;
-
 // Map from a modules name to its pointer.
 using moduleMap_t = std::unordered_map<std::string, const module_t&>;