Changeset 1125 for trunk/yat/classifier


Ignore:
Timestamp:
Feb 22, 2008, 10:31:22 PM (13 years ago)
Author:
Peter
Message:

fixing Doxygen parsing

Location:
trunk/yat/classifier
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/classifier/DataLookup2D.h

    r1088 r1125  
    129129    /// @return sub-Lookup of the DataLookup2D
    130130    ///
    131     /// @Note Returns a dynamically allocated DataLookup2D, which has
     131    /// @note Returns a dynamically allocated DataLookup2D, which has
    132132    /// to be deleted by the caller to avoid memory leaks.
    133133    ///
     
    138138    /// @return sub-Lookup of the DataLookup2D
    139139    ///
    140     /// @Note Returns a dynamically allocated DataLookup2D, which has
     140    /// @note Returns a dynamically allocated DataLookup2D, which has
    141141    /// to be deleted by the caller to avoid memory leaks.
    142142    ///
  • trunk/yat/classifier/EnsembleBuilder.h

    r1121 r1125  
    4545  class EnsembleBuilder
    4646  {
    47  
    4847  public:
     48    /**
     49       \brief Type of classifier that ensemble is built on.
     50     */
    4951    typedef Classifier classifier_type;
     52
     53    /**
     54       Type of container used for storing data e.g. MatrixLookup or KernelLookup
     55     */
    5056    typedef Data data_type;
    5157
     
    7278
    7379    ///
    74     /// @Return classifier
     80    /// @return classifier
    7581    ///
    7682    const Classifier& classifier(size_t i) const;
    7783     
    7884    ///
    79     /// @Return Number of classifiers in ensemble
     85    /// @return Number of classifiers in ensemble
    8086    ///
    8187    u_long size(void) const;
  • trunk/yat/classifier/Kernel.h

    r1000 r1125  
    132132    /// instatiate (see 'Prototype' in Design Patterns).
    133133    ///
    134     /// @Note Returns a dynamically allocated Kernel, which has
     134    /// @note Returns a dynamically allocated Kernel, which has
    135135    /// to be deleted by the caller to avoid memory leaks.
    136136    ///
     
    143143    /// instatiate (see 'Prototype' in Design Patterns).
    144144    ///
    145     /// @Note Returns a dynamically allocated Kernel, which has
     145    /// @note Returns a dynamically allocated Kernel, which has
    146146    /// to be deleted by the caller to avoid memory leaks.
    147147    ///
  • trunk/yat/classifier/KernelLookup.h

    r1110 r1125  
    7676    const_iterator;
    7777
     78    /**
     79       'Read only' iterator intended to iterate over a column
     80     */
    7881    typedef const_iterator const_column_iterator;
     82
     83    /**
     84       'Read only' iterator intended to iterate over a row
     85     */
    7986    typedef const_iterator const_row_iterator;
    8087
     
    198205    /// \return data that KernelLookup is built upon.
    199206    ///
    200     /// @Note Returns a dynamically allocated MatrixLookup, which has
     207    /// @note Returns a dynamically allocated MatrixLookup, which has
    201208    /// to be deleted by the caller to avoid memory leaks.
    202209    ///
     
    243250       KernelLookup.
    244251
    245        \Note Returns a dynamically allocated KernelLookup, which has
     252       \note Returns a dynamically allocated KernelLookup, which has
    246253       to be deleted by the caller to avoid memory leaks.
    247254    */
     
    258265       this was built from.
    259266   
    260        @Note Returns a dynamically allocated DataLookup2D, which has
     267       @note Returns a dynamically allocated DataLookup2D, which has
    261268       to be deleted by the caller to avoid memory leaks.
    262269    */
     
    273280       this was built from.
    274281   
    275        @Note Returns a dynamically allocated DataLookup2D, which has
     282       @note Returns a dynamically allocated DataLookup2D, which has
    276283       to be deleted by the caller to avoid memory leaks.
    277284    */
     
    285292       KernelLookup
    286293   
    287        \Note Returns a dynamically allocated DataLookup2D, which has
     294       \note Returns a dynamically allocated DataLookup2D, which has
    288295       to be deleted by the caller to avoid memory leaks.
    289296    */
     
    298305       \return sub-Lookup of the DataLookup2D
    299306   
    300        \Note Returns a dynamically allocated DataLookup2D, which has
     307       \note Returns a dynamically allocated DataLookup2D, which has
    301308       to be deleted by the caller to avoid memory leaks.
    302309    */
  • trunk/yat/classifier/Kernel_MEV.h

    r1000 r1125  
    8989    /// instatiate (see 'Prototype' in Design Patterns).
    9090    ///
    91     /// @Note Returns a dynamically allocated Kernel, which has
     91    /// @note Returns a dynamically allocated Kernel, which has
    9292    /// to be deleted by the caller to avoid memory leaks.
    9393    ///
     
    101101    /// instatiate (see 'Prototype' in Design Patterns).
    102102    ///
    103     /// @Note Returns a dynamically allocated Kernel, which has
     103    /// @note Returns a dynamically allocated Kernel, which has
    104104    /// to be deleted by the caller to avoid memory leaks.
    105105    ///
  • trunk/yat/classifier/Kernel_SEV.h

    r1121 r1125  
    7878    /// instatiate (see 'Prototype' in Design Patterns).
    7979    ///
    80     /// @Note Returns a dynamically allocated Kernel, which has
     80    /// @note Returns a dynamically allocated Kernel, which has
    8181    /// to be deleted by the caller to avoid memory leaks.
    8282    ///
     
    9090    /// instatiate (see 'Prototype' in Design Patterns).
    9191    ///
    92     /// @Note Returns a dynamically allocated Kernel, which has
     92    /// @note Returns a dynamically allocated Kernel, which has
    9393    /// to be deleted by the caller to avoid memory leaks.
    9494    ///
  • trunk/yat/classifier/MatrixLookup.h

    r1121 r1125  
    7979    const_iterator;
    8080
     81    /**
     82       'Read only' iterator used to iterate over a column
     83     */
    8184    typedef const_iterator const_column_iterator;
     85
     86    /**
     87       'Read only' iterator used to iterate over a row
     88     */
    8289    typedef const_iterator const_row_iterator;
    8390
     
    286293    /// undefined.
    287294    ///
    288     /// @Note Returns a dynamically allocated DataLookup2D, which has
     295    /// @note Returns a dynamically allocated DataLookup2D, which has
    289296    /// to be deleted by the caller to avoid memory leaks.
    290297    ///
  • trunk/yat/classifier/MatrixLookupWeighted.h

    r1121 r1125  
    8080    const_iterator;
    8181
     82    /**
     83       'Read only' iterator used to iterate over a column
     84     */
    8285    typedef const_iterator const_column_iterator;
     86
     87    /**
     88       'Read only' iterator used to iterate over a row
     89     */
    8390    typedef const_iterator const_row_iterator;
    8491
  • trunk/yat/classifier/SVM.h

    r1124 r1125  
    7878
    7979    ///
    80     ///
     80    /// Same as copy constructor.
    8181    ///
    8282    SVM* make_classifier(void) const;
  • trunk/yat/classifier/SubsetGenerator.h

    r1086 r1125  
    5252  {
    5353  public:
     54    /**
     55       type of data that is stored in SubsetGenerator
     56     */
    5457    typedef T value_type;
    5558
  • trunk/yat/classifier/SupervisedClassifier.h

    r1121 r1125  
    7171    /// instatiate (see 'Prototype' in Design Patterns).
    7272    ///
    73     /// @Note Returns a dynamically allocated SupervisedClassifier, which has
     73    /// @note Returns a dynamically allocated SupervisedClassifier, which has
    7474    /// to be deleted by the caller to avoid memory leaks.
    7575    ///
Note: See TracChangeset for help on using the changeset viewer.