Ignore:
Timestamp:
Oct 11, 2006, 7:49:03 PM (15 years ago)
Author:
Jari Häkkinen
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/namespaces.doxygen

    r675 r680  
    2424///
    2525/// @namespace theplu
    26 /// All our C++ projects should ideally be defined within theplu namespace.
    2726///
    28 /// @brief
     27/// All C++ projects at the Department of Theoretical Physics should
     28/// ideally be defined within a common namespace. We use theplu for
     29/// this common namespace.
     30///
     31/// @brief The Department of Theoretical Physics namespace as we
     32/// define it.
     33///
    2934
     35///
     36/// @namespace theplu::yat
    3037///
    31 /// @namespace theplu::random
     38/// All classes and functions are for the yat project is placed in sub
     39/// namespaces of the yat namespace.
    3240///
    33 /// @brief Random number distributions
     41/// @brief yat project namespace.
    3442///
    3543
    3644///
    37 /// @namespace theplu::utility
     45/// @namespace theplu::yat::random
    3846///
    39 /// @brief Miscellaneous
     47/// The yat random number related functionality is placed with the
     48/// random namespace.
     49///
     50/// @brief Random number distributions.
    4051///
    4152
    4253///
    43 /// @namespace theplu::utility::alignment
    44 /// All alignment algorithm should go into the aligment namespace
     54/// @namespace theplu::yat::utility
    4555///
    46 /// @brief Container for alignment algorithms
     56/// Needed yat functionality that we don't know where to put usually
     57/// ends up in the utility namespace until we figure out their proper
     58/// namespace location.
     59///
     60/// @brief Miscellaneous functionality.
    4761///
    4862
    4963///
    50 /// @namespace theplu::classifier
    51 /// All classes associated with usage of
    52 /// classifiers should be defined within this namespace
     64/// @namespace theplu::yat::classifier
     65///
     66/// All classes associated with usage of classifiers are defined
     67/// within this namespace.
    5368///
    54 /// @brief Classifier related classes
     69/// @brief Classifier related classes.
    5570///
    5671
    5772///
    58 /// @namespace theplu::statistics All classes and functions related to
    59 /// statistical methods or functions should be defined within this
    60 /// namespace.
    61 /// See <a href="Statistics/index.html">Weighted Statistics document</a><br>
     73/// @namespace theplu::yat::statistics
    6274///
    63 /// @brief Statistical methods and functions
     75/// All classes and functions related to statistical methods or
     76/// functions are defined within this namespace. See <a
     77/// href="Statistics/index.html">Weighted Statistics document</a><br>.
     78///
     79/// @brief Statistical methods, classes, and functions.
     80///
    6481
    6582///
    66 /// @namespace theplu::statistics::regression
     83/// @namespace theplu::yat::regression
    6784///
    68 /// @brief Statistical modeling of data
     85/// @brief Statistical modeling of data.
     86///
    6987
    70 
Note: See TracChangeset for help on using the changeset viewer.