Doc comment for unit_type::advancement_tree

wesnoth · Jun 9, 2017 · e9d4d89 · e9d4d89
1 parent e549d17
commit e9d4d89
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/units/types.hpp b/src/units/types.hpp
@@ -105,7 +105,9 @@ class unit_type
 	void add_advancement(const unit_type &advance_to,int experience);
 
 	/** Get the advancement tree
-	 *  Build a set of unit type's id of this unit type's advancement tree */
+	 *  @return a set of ids of all unit_type objects that this unit_type can
+	 *  advance to
+	 */
 	std::set<std::string> advancement_tree() const;
 
 	const std::vector<std::string>& advances_to() const { return advances_to_; }