From 704313333f1253067a8913ce963014bdfde1e852 Mon Sep 17 00:00:00 2001 From: Andreas Stöckel Date: Sun, 4 Jan 2015 11:21:48 +0100 Subject: added comment to exportGraphviz function --- src/core/managed/Manager.hpp | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'src/core/managed/Manager.hpp') 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 }; -- cgit v1.2.3