added comment to exportGraphviz function

1 files changed, 10 insertions, 0 deletions

diff --git a/src/core/managed/Manager.hpp b/src/core/managed/Manager.hpp
index 14536bb..8ee11c4 100644
--- a/src/core/managed/Manager.hpp
+++ b/src/core/managed/Manager.hpp
@@ -376,6 +376,16 @@ public:
 	bool triggerEvent(Managed *ref, Event &ev);
 
 #ifdef MANAGER_GRAPHVIZ_EXPORT
+	/**
+	 * Exports the current object graph managed by this manager instance to the
+	 * given file. The file is in the Graphviz format (http://graphviz.org/) and
+	 * can be visualized using the "dot" tool. The exported graph is purely for
+	 * debugging and visualization purposes. This function is not compiled in
+	 * for release versions of Ousía.
+	 *
+	 * @param filename is the file to which the Graphviz description should be
+	 * written. The given file is overwritten if it already exists.
+	 */
 	void exportGraphviz(const char* filename);
 #endif
 };