summaryrefslogtreecommitdiff
path: root/addon/doxyapp/README
diff options
context:
space:
mode:
Diffstat (limited to 'addon/doxyapp/README')
-rw-r--r--addon/doxyapp/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/addon/doxyapp/README b/addon/doxyapp/README
new file mode 100644
index 0000000..f92e106
--- /dev/null
+++ b/addon/doxyapp/README
@@ -0,0 +1,8 @@
+This directory contains an example of how to use doxygen as
+an "source parsing engine" in an application. It shows how to configure doxygen
+from the application and shows how to run doxygen without generating output,
+and then uses the information about the symbols found in the source code.
+
+Note that if you use this approach your application should be licensed under the GPL.
+
+