style: added comments to voiceregion and changed emojis.php

buildtools/emojis.php

@@ -12,9 +12,11 @@
 namespace dpp {
 
 /**
- * The unicode emojis in this namespace are auto-generated from {$url}
+ * @brief Emoji unicodes.
  *
- * If you want to use this, you have to pull the header in separately. e.g.
+ * @note The unicode emojis in this namespace are auto-generated from https://raw.githubusercontent.com/ArkinSolomon/discord-emoji-converter/master/emojis.json
+ *
+ * @warning If you want to use this, you have to pull the header in separately. For example:
  * ```cpp
  * #include <dpp/dpp.h>
  * #include <dpp/unicode_emoji.h>

include/dpp/unicode_emoji.h

@@ -7,7 +7,7 @@ namespace dpp {
  *
  * @note The unicode emojis in this namespace are auto-generated from https://raw.githubusercontent.com/ArkinSolomon/discord-emoji-converter/master/emojis.json
  *
- * @warning If you want to use this, you have to pull the header in separately. e.g.
+ * @warning If you want to use this, you have to pull the header in separately. For example:
  * ```cpp
  * #include <dpp/dpp.h>
  * #include <dpp/unicode_emoji.h>

include/dpp/voiceregion.h

@@ -31,9 +31,26 @@ namespace dpp {
  * @brief Flags related to a voice region
  */
 enum voiceregion_flags {
+    	/**
+	 * @brief The closest (optimal) voice region.
+	 */
 	v_optimal = 0x00000001,
+
+	/**
+	 * @brief A Deprecated voice region (avoid switching to these).
+	 */
 	v_deprecated = 0x00000010,
+
+	/**
+	 * @brief A custom voice region (used for events/etc).
+	 */
 	v_custom = 0x00000100,
+
+	/**
+	 * @brief A VIP voice server.
+	 *
+	 * @warning This is undocumented by Discord and may not even exist anymore.
+	 */
 	v_vip = 0x00001000
 };