Changeset 304 for trunk/doc

Timestamp:

May 2, 2005, 4:10:50 PM (18 years ago)

Author:

Peter

Message:

moved namespace dox to separate file

Location:

trunk/doc

Files:

• doxygen.config (modified) (1 diff)
• namespaces.doxygen (modified) (1 diff)

trunk/doc/doxygen.config

@@ -50 +50 @@
 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 

trunk/doc/namespaces.doxygen

@@ -1 +1 @@
 // $Id$
 
-/**
- \namespace theplu
- All our C++ projects should ideally be defined within theplu namespace.
-*/
+/// 
+/// @namespace theplu
+/// All our C++ projects should ideally be defined within theplu namespace.
+///
+/// @brief 
+
+///
+/// @namespace theplu::gslapi
+/// All GSL wrapper functionality is to be defined within gslapi
+/// namespace.
+///
+/// There are a number of support operators and functions for the
+/// wrapper classes that do not belong to the classes themselves, but
+/// still are defined in this namespace.
+///
+/// @brief GSL wrapper
+
+///
+/// @namespace theplu::utility
+///
+/// @brief Miscellaneous
+///
+
+///
+/// @namespace theplu::utility::alignment
+/// All alignment algorithm should go into the aligment namespace
+///
+/// @brief Container for alignment algorithms
+///
+
+/// 
+/// @namespace theplu::svm 
+/// All classes associated to the usage of the
+/// SVM class should be defined within this namespace 
+/// 
+/// @brief SVM related classes
+///
+
+///
+/// @namespace theplu::statistics All classes and functions related to
+/// statistical methods or functions should be defined within this
+/// namespace.
+///
+/// @brief Statistical methods and functions