style: second chunk of part 3 refactor

brainboxdotcc · Oct 31, 2023 · 2a3ec75 · 2a3ec75
1 parent 6210601
commit 2a3ec75
Show file tree

Hide file tree

Showing 7 changed files with 845 additions and 269 deletions.
diff --git a/include/dpp/misc-enum.h b/include/dpp/misc-enum.h
@@ -25,32 +25,65 @@
 
 namespace dpp {
 
-	/** @brief Supported image types for profile pictures and CDN endpoints */
-	enum image_type {
-		/// image/png
-		i_png,
-		/// image/jpeg
-		i_jpg,
-		/// image/gif
-		i_gif,
-		/// WebP
-		i_webp,
-	};
-
-	/** @brief Log levels */
-	enum loglevel {
-		/// Trace
-		ll_trace = 0,
-		/// Debug
-		ll_debug,
-		/// Information
-		ll_info,
-		/// Warning
-		ll_warning,
-		/// Error
-		ll_error,
-		/// Critical
-		ll_critical
-	};
+/**
+ * @brief Supported image types for profile pictures and CDN endpoints
+ */
+enum image_type {
+	/**
+	 * @brief image/png
+	 */
+	i_png,
+
+	/**
+	 * @brief image/jpeg.
+	 */
+	i_jpg,
+
+	/**
+	 * @brief image/gif.
+	 */
+	i_gif,
+
+	/**
+	 * @brief Webp.
+	 */
+	/// WebP
+	i_webp,
+};
+
+/**
+ * @brief Log levels
+ */
+enum loglevel {
+	/**
+	 * @brief Trace
+	 */
+	ll_trace = 0,
+
+	/**
+	 * @brief Debug
+	 */
+	ll_debug,
+
+	/**
+	 * @brief Information
+	 */
+	ll_info,
+
+	/**
+	 * @brief Warning
+	 */
+	ll_warning,
+
+	/**
+	 * @brief Error
+	 */
+	ll_error,
+
+	/**
+	 * @brief Critical
+	 */
+	ll_critical
+};
 
 } // namespace dpp
diff --git a/include/dpp/once.h b/include/dpp/once.h
@@ -24,23 +24,23 @@
 
 namespace dpp {
 
-	/**
-	 * @brief Run some code within an if() statement only once.
-	 * 
-	 * Use this template like this:
-	 * 
-	 * ```
-	 * if (dpp::run_once<struct any_unique_name_you_like_here>()) {
-	 *     // Your code here
-	 * }
-	 * ```
-	 * 
-	 * @tparam T any unique 'tag' identifier name
-	 * @return auto a true/false return to say if we should execute or not
-	 */
-	template <typename T> auto run_once() {
-		static auto called = false;
-		return !std::exchange(called, true);
-	};
+/**
+ * @brief Run some code within an if() statement only once.
+ *
+ * Use this template like this:
+ *
+ * ```
+ * if (dpp::run_once<struct any_unique_name_you_like_here>()) {
+ *     // Your code here
+ * }
+ * ```
+ *
+ * @tparam T any unique 'tag' identifier name
+ * @return auto a true/false return to say if we should execute or not
+ */
+template <typename T> auto run_once() {
+	static auto called = false;
+	return !std::exchange(called, true);
+};
 
 } // namespace dpp