Changeset 303


Ignore:
Timestamp:
Apr 30, 2005, 6:17:35 PM (16 years ago)
Author:
Peter
Message:

docs

Location:
trunk
Files:
2 added
21 edited
1 moved

Legend:

Unmodified
Added
Removed
  • trunk/TODO

    r301 r303  
     1documentation: fix first page in doxygen (synch it with svn)
     2Namespace documtation: separate file for doxygen
     3add brief descriptions to classes
     4
     5see also todo.html
  • trunk/doc/doxygen.config

    r296 r303  
    5050# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    5151
    52 EXTRACT_ALL            = NO
     52EXTRACT_ALL            = YES
    5353
    5454# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
     
    304304# with spaces.
    305305
    306 INPUT                  = first_page.doxygen ../src
     306INPUT                  = first_page.doxygen namespaces.doxygen ../lib
    307307
    308308# If the value of the INPUT tag contains directories, you can use the
  • trunk/lib/gslapi/vector.h

    r295 r303  
    1010#include <gsl/gsl_vector.h>
    1111
    12 // Jari, this should probably go somewhere else for doxygen to process.
    13 ///
    14 /// All our C++ projects should ideally be defined within theplu
    15 /// namespace.
    16 ///
    1712namespace theplu {
    1813// Jari, this should probably go somewhere else for doxygen to process.
  • trunk/lib/statistics/Averager.h

    r295 r303  
    1515
    1616  ///
     17  /// \defgroup Averagers
    1718  /// Class to calulate simple (first and second moments) averages.
    1819  ///
  • trunk/lib/statistics/ROC.cc

    r301 r303  
    185185
    186186
    187 }} // of namespace cpptools and namespace theplu
     187}} // of namespace statistics and namespace theplu
  • trunk/lib/statistics/RegressionLocal.cc

    r295 r303  
    9494
    9595
    96 }} // of namespace cpptools and namespace theplu
     96}} // of namespace statistics and namespace theplu
  • trunk/lib/statistics/RegressionNaive.cc

    r295 r303  
    6767  }
    6868 
    69 }} // of namespace cpptools and namespace theplu
     69}} // of namespace statistics and namespace theplu
  • trunk/lib/statistics/Score.cc

    r295 r303  
    1111  }
    1212
    13 }} // of namespace cpptools and namespace theplu
     13}} // of namespace statistics and namespace theplu
  • trunk/lib/statistics/tScore.cc

    r295 r303  
    1111
    1212namespace theplu {
    13 namespace cpptools { 
     13namespace statistics { 
    1414
    1515  tScore::tScore(bool b)
     
    8989
    9090
    91 }} // of namespace cpptools and namespace theplu
     91}} // of namespace statistics and namespace theplu
  • trunk/lib/statistics/utility.h

    r295 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_statistics_
    4 #define _theplu_cpptools_statistics_
     3#ifndef _theplu_statistics_utility_
     4#define _theplu_statistics_utility_
    55
    6 // C++ tools include
    7 /////////////////////
    8 
    9 // Standard C++ includes
    10 ////////////////////////
    116#include <vector>
    127
    138namespace theplu {
    14 // Jari, this should probably go somewhere else for doxygen to process.
    15 ///
    16 /// Statistics functions should go into the statistics namespace
    17 ///
    18 /// \brief Container for statistics functions
    19 ///
    209namespace statistics { 
    2110
  • trunk/lib/svm/Kernel.h

    r295 r303  
    2121   
    2222  public:
    23     ///
     23   
     24    ///
    2425    ///   Constructor taking the data matrix and KernelFunction as
    25     ///   input. Note: can not handle NaNs. When dealing with missing values,
     26    ///   input. @note Can not handle NaNs. When dealing with missing values,
    2627    ///   use constructor taking a weight matrix.
    2728    Kernel(const gslapi::matrix&, const KernelFunction&);
  • trunk/lib/utility/Alignment.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_alignment_
    4 #define _theplu_cpptools_alignment_
     3#ifndef _theplu_utility_alignment_
     4#define _theplu_utility_alignment_
    55
    66#include <utility>
  • trunk/lib/utility/FileIO.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_fileio_
    4 #define _theplu_cpptools_fileio_
     3#ifndef _theplu_utility_fileio_
     4#define _theplu_utility_fileio_
    55
    66#include <string>
  • trunk/lib/utility/Merge.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_merge_ 
    4 #define _theplu_cpptools_merge_
     3#ifndef _theplu_utility_merge_ 
     4#define _theplu_utility_merge_
    55
    66#include <c++_tools/gslapi/matrix.h>
  • trunk/lib/utility/NNI.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_nni_
    4 #define _theplu_cpptools_nni_
     3#ifndef _theplu_utility_nni_
     4#define _theplu_utility_nni_
    55
    66#include <iostream>
  • trunk/lib/utility/PCA.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_pca_
    4 #define _theplu_cpptools_pca_
     3#ifndef _theplu_utility_pca_
     4#define _theplu_utility_pca_
    55
    66#include <c++_tools/gslapi/matrix.h>
  • trunk/lib/utility/SVD.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_svd_
    4 #define _theplu_cpptools_svd_
     3#ifndef _theplu_utility_svd_
     4#define _theplu_utility_svd_
    55
    66#include <c++_tools/gslapi/matrix.h>
     
    1010
    1111namespace theplu {
    12 // Jari, this should probably go somewhere else for doxygen to process.
    13 ///
    14 /// All C++ tools functionality is to be defined within cpptools
    15 /// namespace.
    16 ///
    1712namespace utility {
    1813
  • trunk/lib/utility/WeNNI.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_wenni_
    4 #define _theplu_cpptools_wenni_
     3#ifndef _theplu_utility_wenni_
     4#define _theplu_utility_wenni_
    55
    66#include <c++_tools/utility/NNI.h>
  • trunk/lib/utility/kNNI.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_knni_
    4 #define _theplu_cpptools_knni_
     3#ifndef _theplu_utility_knni_
     4#define _theplu_utility_knni_
    55
    66#include <c++_tools/utility/NNI.h>
  • trunk/lib/utility/random_singleton.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_random_singleton_
    4 #define _theplu_cpptools_random_singleton_
     3#ifndef _theplu_utility_random_singleton_
     4#define _theplu_utility_random_singleton_
    55
    66
  • trunk/lib/utility/stl_utility.h

    r301 r303  
    11// $Id$
    22
    3 #ifndef _theplu_cpptools_stl_utility_
    4 #define _theplu_cpptools_stl_utility_
     3#ifndef _theplu_utility_stl_utility_
     4#define _theplu_utility_stl_utility_
    55
    66///
  • trunk/test/crossvalidation_test.cc

    r301 r303  
    1717    target(i)=-1;
    1818
    19   svm::CrossValidation cv(target,3);
     19  svm::CrossValidation cv(target,3t
     20);
    2021
    2122
Note: See TracChangeset for help on using the changeset viewer.