Changeset 680 for trunk/doc

Timestamp:

Oct 11, 2006, 7:49:03 PM (17 years ago)

Author:

Jari Häkkinen

Message:

Addresses #153. Introduced yat namespace. Removed alignment namespace. Clean up of code.

File:

• trunk/doc/namespaces.doxygen (modified) (1 diff)

trunk/doc/namespaces.doxygen

@@ -24 +24 @@
 /// 
 /// @namespace theplu
-/// All our C++ projects should ideally be defined within theplu namespace.
 ///
-/// @brief 
+/// All C++ projects at the Department of Theoretical Physics should
+/// ideally be defined within a common namespace. We use theplu for
+/// this common namespace.
+///
+/// @brief The Department of Theoretical Physics namespace as we
+/// define it.
+///
 
+/// 
+/// @namespace theplu::yat
 ///
-/// @namespace theplu::random
+/// All classes and functions are for the yat project is placed in sub
+/// namespaces of the yat namespace.
 ///
-/// @brief Random number distributions
+/// @brief yat project namespace.
 ///
 
 ///
-/// @namespace theplu::utility
+/// @namespace theplu::yat::random
 ///
-/// @brief Miscellaneous
+/// The yat random number related functionality is placed with the
+/// random namespace.
+///
+/// @brief Random number distributions.
 ///
 
 ///
-/// @namespace theplu::utility::alignment
-/// All alignment algorithm should go into the aligment namespace
+/// @namespace theplu::yat::utility
 ///
-/// @brief Container for alignment algorithms
+/// Needed yat functionality that we don't know where to put usually
+/// ends up in the utility namespace until we figure out their proper
+/// namespace location.
+///
+/// @brief Miscellaneous functionality.
 ///
 
 /// 
-/// @namespace theplu::classifier
-/// All classes associated with usage of 
-/// classifiers should be defined within this namespace 
+/// @namespace theplu::yat::classifier
+///
+/// All classes associated with usage of classifiers are defined
+/// within this namespace.
 /// 
-/// @brief Classifier related classes
+/// @brief Classifier related classes.
 ///
 
 ///
-/// @namespace theplu::statistics All classes and functions related to
-/// statistical methods or functions should be defined within this
-/// namespace. 
-/// See <a href="Statistics/index.html">Weighted Statistics document</a><br>
+/// @namespace theplu::yat::statistics
 ///
-/// @brief Statistical methods and functions
+/// All classes and functions related to statistical methods or
+/// functions are defined within this namespace. See <a
+/// href="Statistics/index.html">Weighted Statistics document</a><br>.
+///
+/// @brief Statistical methods, classes, and functions.
+///
 
 ///
-/// @namespace theplu::statistics::regression 
+/// @namespace theplu::yat::regression 
 ///
-/// @brief Statistical modeling of data
+/// @brief Statistical modeling of data.
+///
 
-