Show
Ignore:
Timestamp:
11/13/09 15:37:02 (14 years ago)
Author:
bhilburn
Message:

Added Doxygen documentation to headers in the include/vtcross directory.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • vtcross/trunk/src/include/vtcross/cbr.h

    r509 r518  
    1515*/ 
    1616 
    17 /* This file contains the full implementation of the CBR class - the default 
    18  * VTCROSS case-based reasoner. 
     17/*! This header contains the declaration and a full implementation of  
     18 * the CBR class - the default CROSS case-based reasoner, which can be used as a 
     19 * backend for cognitive engines. 
    1920 */ 
    2021 
    … …  
    3940 
    4041 
    41 #define DATABASENAME "vtcross_cbr" 
     42#define DATABASENAME "cross_cbr" 
    4243 
    4344 
    4445/* This is an internal debugging function used by some sqlite3 function calls. 
    45  * It is not used otherwise in the VTCROSS codebase. */ 
    46 int32_t  
    47 callback(void *notUsed, int argc, char **argv, char **azColName) 
     46 *  It is not used otherwise in the CROSS codebase. */ 
     47int32_t  
     48callback(void *notUsed, int32_t argc, char **argv, char **azColName) 
    4849{ 
    4950    for(size_t i = 0; i < argc; i++) { 
    … …  
    5657 
    5758 
    58 /* The CBR class is designed to used as either as-is, or as a parent class.  All 
     59/*! \brief Case-Based Reasoner class declaration. 
     60 * 
     61 * The CBR class is designed to used as either as-is, or as a parent class.  All 
    5962 * functions are declared virtual, and internal members are 'protected' rather 
    6063 * than private. If you require functionality in a CBR not specifically provided 
    … …  
    6669{ 
    6770    public: 
    68         /* Constructors for the CBR class. Note that the default constructor 
     71        /*! \brief Constructors for the CBR class.  
     72         * 
     73         * Note that the default constructor 
    6974         * must be defined inline here so that super-calls from child classes 
    7075         * don't fail (i.e. we cannot rely on the compiler-provided constructor. */ 
    … …  
    7479                string _primcols[], uint32_t _len, uint32_t _primlen); 
    7580 
    76         /* Destructor for the CBR class. Note that this destructor will be 
     81        /*! \brief Destructors for the CBR class. 
     82         * 
     83         * Destructor for the CBR class. Note that this destructor will be 
    7784         * called automatically by any derived classes, and so child classes 
    7885         * should not repeat the freeing actions performed in this function. */ 
    7986        virtual ~CBR(); 
    8087 
    81         /* This function opens the VTCROSS database, or if it has not been 
     88        /*! \brief Open/Create a sqlite database for the CBR. 
     89         * 
     90         * This function opens the CROSS database, or if it has not been 
    8291         * created yet, creates it. */ 
    8392        virtual int32_t OpenDatabase(); 
    8493 
    85         /* Execute a sqlite3 command and return the sqlite3 return code. */ 
     94        /*! \brief  Execute a sqlite command. 
     95         * 
     96         * Construct and execute a sqlite3 command and pass the return code back. */ 
    8697        virtual int32_t ExecuteCommand(); 
    8798 
    88         /* Execute a sqlite3 search command and store the results in the passed 
     99        /*! \brief Search the sqlite3 database.  
     100         * 
     101         * Execute a sqlite3 search command and store the results in the passed 
    89102         * retvals argument. */ 
    90103        virtual int32_t ExecuteSearchCommand(float *_retvals); 
    91104 
    92         /* Print the VTCROSS sqlite3 database. */ 
     105        /*! \brief Print the CROSS sqlite database. */ 
    93106        virtual void Print(); 
    94107 
    95         /* Search the VTCROSS database for specific fields and store the results 
     108        /*! \brief Search the CBR database.  
     109         * 
     110         * Search the CROSS database for specific fields and store the results 
    96111         * in the passed retvals argument. */ 
    97112        virtual int32_t Search(string _names[], int32_t *_ops, float *_vals, \ 
    … …  
    101116            float *_retvals); 
    102117 
    103         /* Update a row in the VTCROSS sqlite3 database. */ 
     118        /*! \brief Update an entry in the CBR database. */ 
    104119        virtual int32_t Update(string _where[], string _set[], float *_wherevals, \ 
    105120                float *_setvals, uint32_t _wherelen, uint32_t _setlen); 
    106121 
    107         /* Add a row to the VTCROSS sqlite3 database. */ 
     122        /*! \brief Add a row to the CROSS sqlite3 database. */ 
    108123        virtual int32_t AddRow(string _cols[], float *_vals, uint32_t _len); 
    109124 
    … …  
    129144 
    130145    /* Generate the command that will create the initial table within the 
    131      * VTCROSS database. */ 
     146     * CROSS database. */ 
    132147    command = "CREATE TABLE " + tablename + "("; 
    133148    for(size_t i = 0; i < numColumns; i++) { 
    … …  
    159174 
    160175    /* Generate the command that will create the initial table within the 
    161      * VTCROSS database with primary keys. */ 
     176     * CROSS database with primary keys. */ 
    162177    command = "CREATE TABLE " + tablename + "("; 
    163178    for(size_t i = 0; i < numColumns; i++) {