add comment

usdot-fhwa-OPS · Aug 12, 2024 · c0a8838 · c0a8838
1 parent 3914330
commit c0a8838
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/tmx/TmxApi/tmx/messages/message.hpp b/src/tmx/TmxApi/tmx/messages/message.hpp
@@ -429,7 +429,11 @@ class tmx_message {
 		erase_object(objectName);
 		this->as_tree().get().add_child(objectName, Element::to_tree(obj));
 	}
-
+	/**
+	 * @brief Erase a certain object from the tree given the object name.
+	 * @param Name of the object 
+	 * @param Object An object to be erased from the tree
+	 */
 	void erase_object(const std::string& objName)
 	{
 		this->as_tree().get().erase(objName);