From 6d9ce217bd1ac70fa87b0083308a745099cc1459 Mon Sep 17 00:00:00 2001
From: Ichthyostega <prg@ichthyostega.de>
Date: Fri, 24 Aug 2007 02:58:13 +0200
Subject: [PATCH] played a bit with doxygen and tried some small tweeks...

---
 doc/devel/Doxyfile                                  | 11 ++++++-----
 src/common/appconfig.hpp                            |  2 +-
 src/common/test/testoption.cpp                      |  4 ++--
 tests/components/common/factorytest.cpp             |  4 ++++
 tests/components/common/test/cmdlinewrappertest.cpp |  1 +
 tests/components/common/test/testoptiontest.cpp     |  5 +++++
 tests/components/helloworldtest.cpp                 |  2 +-
 7 files changed, 20 insertions(+), 9 deletions(-)

diff --git a/doc/devel/Doxyfile b/doc/devel/Doxyfile
index ebc2bbc4a..7b74108b9 100644
--- a/doc/devel/Doxyfile
+++ b/doc/devel/Doxyfile
@@ -28,12 +28,12 @@ FULL_PATH_NAMES        = YES
 STRIP_FROM_PATH        = ../../src/
 STRIP_FROM_INC_PATH    = 
 SHORT_NAMES            = NO
-JAVADOC_AUTOBRIEF      = NO
+JAVADOC_AUTOBRIEF      = YES
 MULTILINE_CPP_IS_BRIEF = NO
 DETAILS_AT_TOP         = NO
 INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
-TAB_SIZE               = 8
+TAB_SIZE               = 4
 ALIASES                = 
 OPTIMIZE_OUTPUT_FOR_C  = NO
 OPTIMIZE_OUTPUT_JAVA   = NO
@@ -52,7 +52,7 @@ HIDE_UNDOC_MEMBERS     = NO
 HIDE_UNDOC_CLASSES     = NO
 HIDE_FRIEND_COMPOUNDS  = NO
 HIDE_IN_BODY_DOCS      = NO
-INTERNAL_DOCS          = NO
+INTERNAL_DOCS          = YES
 CASE_SENSE_NAMES       = YES
 HIDE_SCOPE_NAMES       = NO
 SHOW_INCLUDE_FILES     = YES
@@ -74,7 +74,7 @@ FILE_VERSION_FILTER    =
 #---------------------------------------------------------------------------
 QUIET                  = NO
 WARNINGS               = YES
-WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_UNDOCUMENTED   = NO
 WARN_IF_DOC_ERROR      = YES
 WARN_NO_PARAMDOC       = NO
 WARN_FORMAT            = "$file:$line: $text"
@@ -82,7 +82,8 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = ../../src/
+INPUT                  = ../../src/ \
+                         ../../tests/
 FILE_PATTERNS          = *.c \
                          *.cc \
                          *.cxx \
diff --git a/src/common/appconfig.hpp b/src/common/appconfig.hpp
index 488ac2ba8..d457bc6fe 100644
--- a/src/common/appconfig.hpp
+++ b/src/common/appconfig.hpp
@@ -93,7 +93,7 @@ namespace cinelerra
       typedef std::map<string,string> Configmap; 
       typedef std::auto_ptr<Configmap> PConfig;
       
-      /** @TODO <b>the following is just placeholder code!</b>
+      /** @todo <b>the following is just placeholder code!</b>
        *  Appconfig <i>could</i> do such things if necessary,
        *  or provide similar "allways available" services.
        */
diff --git a/src/common/test/testoption.cpp b/src/common/test/testoption.cpp
index 4e78dee19..ee169a14c 100644
--- a/src/common/test/testoption.cpp
+++ b/src/common/test/testoption.cpp
@@ -115,8 +115,8 @@ namespace test
   
   
 
-  /** forward the accummulated help messages from all
-   *  contained option defintions to the outputstream 
+  /** @intern forward the accummulated help messages from 
+   *  all contained option defintions to the outputstream 
    */
   ostream& 
   operator<< (ostream& os, const TestOption& to)
diff --git a/tests/components/common/factorytest.cpp b/tests/components/common/factorytest.cpp
index 80574ef75..c4868cc0d 100644
--- a/tests/components/common/factorytest.cpp
+++ b/tests/components/common/factorytest.cpp
@@ -37,6 +37,10 @@ namespace cinelerra
       public:
       };
       
+    ///// @test the various object creation factories
+    ///// @see  cinelerra::Factory
+    ///// @todo still to be written...
+    /////
     class Factory_test : public Test
       {
         virtual void run(Arg arg) 
diff --git a/tests/components/common/test/cmdlinewrappertest.cpp b/tests/components/common/test/cmdlinewrappertest.cpp
index 3a20ef9ca..e3082a561 100644
--- a/tests/components/common/test/cmdlinewrappertest.cpp
+++ b/tests/components/common/test/cmdlinewrappertest.cpp
@@ -43,6 +43,7 @@ namespace util
     {
     
   
+    ///// @test for util::Cmndline, wrapping various example cmdlines
     class CmdlineWrapper_test : public Test
       {
         virtual void run (Arg arg)
diff --git a/tests/components/common/test/testoptiontest.cpp b/tests/components/common/test/testoptiontest.cpp
index 0738e91e0..d3907a120 100644
--- a/tests/components/common/test/testoptiontest.cpp
+++ b/tests/components/common/test/testoptiontest.cpp
@@ -33,6 +33,11 @@ using std::endl;
 namespace test
   {
   
+  ///// @test for test::TestOption, parsing of commandline options
+  /////       for running collections of Tests
+  ///// @see test::Suite
+  ///// @see util::Cmdline
+  /////
   class TestOption_test : public Test
     {
       virtual void run(Arg arg)
diff --git a/tests/components/helloworldtest.cpp b/tests/components/helloworldtest.cpp
index 09c049f55..dccc74940 100644
--- a/tests/components/helloworldtest.cpp
+++ b/tests/components/helloworldtest.cpp
@@ -30,7 +30,7 @@ namespace cinelerra
   namespace test
     {
 
-    
+    ///// @test demo of using the test framework
     class HelloWorld_test : public Test
       {
         virtual void run(Arg arg)