Merge pull request #216 from Commandserver/examples

little docs changes
brainboxdotcc · Jan 9, 2022 · 443d0a1 · 443d0a1
2 parents 5c0813d + 0db8e00
commit 443d0a1
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/include/dpp/appcommand.h b/include/dpp/appcommand.h
@@ -412,7 +412,7 @@ struct DPP_EXPORT command_resolved {
 	 */
 	std::map<dpp::snowflake, dpp::guild_member> members;
 	/**
-	 * @brief Resolved guild member permissions
+	 * @brief Resolved total guild member permissions in the channel, including overwrites
 	 */
 	std::map<dpp::snowflake, uint64_t> member_permissions;
 	/**

diff --git a/include/dpp/cache.h b/include/dpp/cache.h
@@ -189,8 +189,8 @@ template<class T> class cache {
 	 * std::unordered_map<snowflake, guild*>& gc = c->get_container();
 	 * std::shared_lock l(c->get_mutex()); // MUST LOCK HERE
 	 * for (auto g = gc.begin(); g != gc.end(); ++g) {
-	 *	dpp::guild* gp = (dpp::guild*)g->second;
-	 *      // Do something here with the guild* in 'gp'
+	 *     dpp::guild* gp = (dpp::guild*)g->second;
+	 *     // Do something here with the guild* in 'gp'
 	 * }
 	 * ``` 
 	 * 

diff --git a/include/dpp/guild.h b/include/dpp/guild.h
@@ -220,7 +220,9 @@ class DPP_EXPORT guild_member {
 	bool has_animated_guild_avatar() const;
 
 	/**
-	 * @brief Returns the members's per guild avatar if they have one, otherwise returns an empty string
+	 * @brief Returns the members per guild avatar if they have one, otherwise returns an empty string
+	 *
+	 * @note per-server avatar is a nitro only feature so it might be not set. If you need the real user avatar, use user::get_avatar_url.
 	 * 
 	 * @param size The size of the avatar in pixels. It can be any power of two between 16 and 4096. If not specified, the default sized avatar is returned.
 	 * @return std::string avatar url or empty string