[elvystrac] r1885 - doxygen documentation for elvys-client

  • From: elvys@xxxxxxxxxxxxxxxxxxxxxx
  • To: elvystrac@xxxxxxxxxxxxx
  • Date: Thu, 25 Feb 2010 20:30:36 +0100

Author: JirkaH
Date: 2010-02-25 20:30:36 +0100 (Thu, 25 Feb 2010)
New Revision: 1885

Added:
   trunk/client/elvys-client/doc/
   trunk/client/elvys-client/doc/Doxyfile
   trunk/client/elvys-client/doc/mainpage.dox
Log:
doxygen documentation for elvys-client


Added: trunk/client/elvys-client/doc/Doxyfile
===================================================================
--- trunk/client/elvys-client/doc/Doxyfile                              (rev 0)
+++ trunk/client/elvys-client/doc/Doxyfile      2010-02-25 19:30:36 UTC (rev 
1885)
@@ -0,0 +1,73 @@
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = Elvys - Client
+
+FULL_PATH_NAMES        = YES
+STRIP_FROM_PATH                  = 
"/home/keruom/elvys/trunk/client/elvys-client"
+JAVADOC_AUTOBRIEF      = YES
+OPTIMIZE_OUTPUT_JAVA   = NO
+OPTIMIZE_OUTPUT_FOR_C  = YES
+HIDE_SCOPE_NAMES       = YES
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+EXTRACT_ALL            = YES
+EXTRACT_STATIC         = YES
+EXTRACT_PRIVATE        = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+INPUT                  = ../src
+EXCLUDE                = ../src/release ../src/debug ../src/.tmp 
../src/moc_*.cpp
+IMAGE_PATH                               = ../doc/images
+FILE_PATTERNS                    = *.cpp *.h *.dox
+RECURSIVE              = YES
+INPUT_ENCODING         = UTF-8
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+SOURCE_BROWSER         = YES
+INLINE_SOURCES         = NO
+
+REFERENCES_RELATION    = YES
+REFERENCED_BY_RELATION = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+GENERATE_TREEVIEW      = YES
+HTML_DYNAMIC_SECTIONS  = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+GENERATE_LATEX         = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+ENABLE_PREPROCESSING   = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+HAVE_DOT               = YES
+UML_LOOK               = YES
+CALL_GRAPH             = YES
+CALLER_GRAPH           = YES
+CLASS_DIAGRAMS         = YES
+INCLUDE_GRAPH                    = YES
+HIDE_UNDOC_RELATIONS   = NO

Added: trunk/client/elvys-client/doc/mainpage.dox
===================================================================
--- trunk/client/elvys-client/doc/mainpage.dox                          (rev 0)
+++ trunk/client/elvys-client/doc/mainpage.dox  2010-02-25 19:30:36 UTC (rev 
1885)
@@ -0,0 +1,8 @@
+/** @mainpage Elvys Client
+*
+* @authors Jiri Horky
+*
+* @section intro Introduction
+* @par 
+* This program is ....
+*/


Other related posts:

  • » [elvystrac] r1885 - doxygen documentation for elvys-client - elvys