Changeset 304
- Timestamp:
- May 2, 2005, 4:10:50 PM (18 years ago)
- Location:
- trunk
- Files:
-
- 8 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/TODO
r303 r304 1 1 documentation: fix first page in doxygen (synch it with svn) 2 Namespace documtation: separate file for doxygen3 2 add brief descriptions to classes 4 3 -
trunk/doc/doxygen.config
r303 r304 50 50 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 51 51 52 EXTRACT_ALL = YES52 EXTRACT_ALL = NO 53 53 54 54 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class -
trunk/doc/namespaces.doxygen
r303 r304 1 1 // $Id$ 2 2 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 7 47 8 48 -
trunk/lib/gslapi/matrix.h
r295 r304 156 156 157 157 /// 158 /// Jari, To beimplemented. Should return a reference to a vector158 /// @todo to be properly implemented. Should return a reference to a vector 159 159 /// object. Underlying GSL supports only GSL_vector views, thus 160 160 /// some redesign of the vector class is needed. … … 166 166 167 167 /// 168 /// Jari,to be properly implemented. Should return a reference to168 /// @todo to be properly implemented. Should return a reference to 169 169 /// a vector object (matrix row). Underlying GSL supports only GSL_vector 170 170 /// views, thus some redesign of the vector class is needed. -
trunk/lib/gslapi/utility.h
r295 r304 10 10 11 11 namespace theplu { 12 // Jari, this should probably go somewhere else for doxygen to process.13 ///14 /// All GSL wrapper functionality is to be defined within gslapi15 /// namespace.16 ///17 /// There are a number of support operators and functions for the18 /// wrapper classes that do not belong to the classes themselves, but19 /// still are defined in this namespace.20 ///21 12 namespace gslapi { 22 13 -
trunk/lib/gslapi/vector.h
r303 r304 11 11 12 12 namespace theplu { 13 // Jari, this should probably go somewhere else for doxygen to process.14 ///15 /// All GSL wrapper functionality is to be defined within gslapi16 /// namespace.17 ///18 /// There are a number of support operators and functions for the19 /// wrapper classes that do not belong to the classes themselves, but20 /// still are defined in this namespace.21 ///22 13 namespace gslapi { 23 14 /// … … 103 94 /// @return GSL_SUCCESS on normal exit. 104 95 /// 105 // Jari, doxygen group as Vectoroperators96 // Jari, group as vector_operators 106 97 inline int add(const vector& other) { return gsl_vector_add(v_,other.v_); } 107 98 … … 112 103 /// @return GSL_SUCCESS on normal exit. 113 104 /// 114 // Jari, doxygen group as Vectoroperators105 // Jari, group as vector_operators 115 106 inline int 116 107 add_constant(double term) { return gsl_vector_add_constant(v_,term); } -
trunk/lib/statistics/Averager.h
r303 r304 15 15 16 16 /// 17 /// \defgroup Averagers18 17 /// Class to calulate simple (first and second moments) averages. 19 18 /// -
trunk/lib/utility/Alignment.h
r303 r304 14 14 15 15 namespace utility { 16 // Jari, this should probably go somewhere else for doxygen to process.17 ///18 /// All alignment algorithm should go into the aligment namespace19 ///20 /// \brief Container for alignment algorithms21 ///22 16 namespace alignment { 23 17
Note: See TracChangeset
for help on using the changeset viewer.