Changeset 304


Ignore:
Timestamp:
May 2, 2005, 4:10:50 PM (16 years ago)
Author:
Peter
Message:

moved namespace dox to separate file

Location:
trunk
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • trunk/TODO

    r303 r304  
    11documentation: fix first page in doxygen (synch it with svn)
    2 Namespace documtation: separate file for doxygen
    32add brief descriptions to classes
    43

  • trunk/doc/doxygen.config

    r303 r304  
    5050# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    5151
    52 EXTRACT_ALL            = YES
     52EXTRACT_ALL            = NO
    5353
    5454# If the EXTRACT_PRIVATE tag is set to YES all private members of a class

  • trunk/doc/namespaces.doxygen

    r303 r304  
    11// $Id$
    22
    3 /**
    4  \namespace theplu
    5  All our C++ projects should ideally be defined within theplu namespace.
    6 */
     3///
     4/// @namespace theplu
     5/// All our C++ projects should ideally be defined within theplu namespace.
     6///
     7/// @brief
     8
     9///
     10/// @namespace theplu::gslapi
     11/// All GSL wrapper functionality is to be defined within gslapi
     12/// namespace.
     13///
     14/// There are a number of support operators and functions for the
     15/// wrapper classes that do not belong to the classes themselves, but
     16/// still are defined in this namespace.
     17///
     18/// @brief GSL wrapper
     19
     20///
     21/// @namespace theplu::utility
     22///
     23/// @brief Miscellaneous
     24///
     25
     26///
     27/// @namespace theplu::utility::alignment
     28/// All alignment algorithm should go into the aligment namespace
     29///
     30/// @brief Container for alignment algorithms
     31///
     32
     33///
     34/// @namespace theplu::svm
     35/// All classes associated to the usage of the
     36/// SVM class should be defined within this namespace
     37///
     38/// @brief SVM related classes
     39///
     40
     41///
     42/// @namespace theplu::statistics All classes and functions related to
     43/// statistical methods or functions should be defined within this
     44/// namespace.
     45///
     46/// @brief Statistical methods and functions
    747
    848

  • trunk/lib/gslapi/matrix.h

    r295 r304  
    156156
    157157    ///
    158     /// Jari, To be implemented. Should return a reference to a vector
     158    /// @todo to be properly implemented. Should return a reference to a vector
    159159    /// object. Underlying GSL supports only GSL_vector views, thus
    160160    /// some redesign of the vector class is needed.
    … …  
    166166
    167167    ///
    168     /// Jari, to be properly implemented. Should return a reference to
     168    /// @todo to be properly implemented. Should return a reference to
    169169    /// a vector object (matrix row). Underlying GSL supports only GSL_vector
    170170    /// views, thus some redesign of the vector class is needed.

  • trunk/lib/gslapi/utility.h

    r295 r304  
    1010
    1111namespace theplu {
    12 // Jari, this should probably go somewhere else for doxygen to process.
    13 ///
    14 /// All GSL wrapper functionality is to be defined within gslapi
    15 /// namespace.
    16 ///
    17 /// There are a number of support operators and functions for the
    18 /// wrapper classes that do not belong to the classes themselves, but
    19 /// still are defined in this namespace.
    20 ///
    2112namespace gslapi {
    2213

  • trunk/lib/gslapi/vector.h

    r303 r304  
    1111
    1212namespace theplu {
    13 // Jari, this should probably go somewhere else for doxygen to process.
    14 ///
    15 /// All GSL wrapper functionality is to be defined within gslapi
    16 /// namespace.
    17 ///
    18 /// There are a number of support operators and functions for the
    19 /// wrapper classes that do not belong to the classes themselves, but
    20 /// still are defined in this namespace.
    21 ///
    2213namespace gslapi {
    2314  ///
    … …  
    10394    /// @return GSL_SUCCESS on normal exit.
    10495    ///
    105     // Jari, doxygen group as Vector operators
     96    // Jari, group as vector_operators
    10697    inline int add(const vector& other) { return gsl_vector_add(v_,other.v_); }
    10798
    … …  
    112103    /// @return GSL_SUCCESS on normal exit.
    113104    ///
    114     // Jari, doxygen group as Vector operators
     105    // Jari, group as vector_operators
    115106    inline int
    116107    add_constant(double term) { return gsl_vector_add_constant(v_,term); }

  • trunk/lib/statistics/Averager.h

    r303 r304  
    1515
    1616  ///
    17   /// \defgroup Averagers
    1817  /// Class to calulate simple (first and second moments) averages.
    1918  ///

  • trunk/lib/utility/Alignment.h

    r303 r304  
    1414
    1515namespace utility {
    16 // Jari, this should probably go somewhere else for doxygen to process.
    17 ///
    18 /// All alignment algorithm should go into the aligment namespace
    19 ///
    20 /// \brief Container for alignment algorithms
    21 ///
    2216namespace alignment {
    2317
Note: See TracChangeset for help on using the changeset viewer.