doxygen.rst
changeset 625 85cabce94fda
child 626 ad96e87bf403
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doxygen.rst	Tue Oct 26 11:45:51 2010 +0300
@@ -0,0 +1,18 @@
+-*- mode: outline; coding: utf-8 -*-
+
+* Doxygen simple workflow.
+
+  $ cd $proj
+  $ doxygen -g $proj.cfg  # generate basic config file
+
+Edit $proj.cfg. Some essential settings:
+
+  PROJECT_NAME     = my-proj
+  OUTPUT_DIRECTORY = my
+  OUTPUT_LANGUAGE  = English
+  INPUT            = my.h my.hpp dir/
+  INPUT_ENCODING   = UTF-8
+  FILE_PATTERNS    =
+  RECURSIVE        = NO
+  GENERATE_HTML    = YES
+