Ignore:
Timestamp:
04/09/13 15:41:24 (11 years ago)
Author:
István Váradi <ivaradi@…>
Branch:
default
hg-Phase:
(<MercurialRepository 3 'hg:/home/ivaradi/xplane/hg/xplra' '/'>, 'public')
Message:

Added the Doxygen configuration file and updated the documentation to eliminate the warnings

File:
1 edited

Legend:

Unmodified
Added
Removed

  • src/plugin/src/xplra/GetDataRefTask.h

    r13 r66  
    246246     * Construct the task for the dataref with the given name.
    247247     *
     248     * @param name the name of the dataref
    248249     * @param maxCount the maximal number of items to retrieve. If <0,
    249250     * the function will perform an extra query to retrieve the size of
    250251     * of the dataref's data, which it will store in the task, so
    251252     * later on it can be reused.
     253     * @param offset the offset from which to query the array
    252254     */
    253255    GetArrayDataRefTask(const std::string& name,
    … …  
    257259     * Construct the task for the given dataref
    258260     *
     261     * @param dataRef the dataref
    259262     * @param maxCount the maximal number of items to retrieve. If <0,
    260263     * the function will perform an extra query to retrieve the size
    261264     * of the dataref's data, which it will store in the task, so
    262265     * later on it can be reused.
     266     * @param offset the offset from which to query the array
    263267     */
    264268    GetArrayDataRefTask(XPLMDataRef dataRef,
    … …  
    313317     * Construct the task for the dataref with the given name.
    314318     *
     319     * @param name the name of the dataref
    315320     * @param maxCount the maximal number of data items to
    316321     * retrieve. If <0, the function will perform an extra query to
    317322     * retrieve the size of the dataref's data, which it will store in
    318323     * the task, so later on it can be reused.
     324     * @param offset the offset from which to query the array
    319325     */
    320326    GetFloatArrayDataRefTask(const std::string& name,
    … …  
    324330     * Construct the task for the given dataref
    325331     *
    326      * @param maxBytes the maximal number of data items to
    327      * retrieve. If <0, the function will perform an extra query to
    328      * retrieve the size of the dataref's data, which it will store in
    329      * the task, so later on it can be reused.
    330      */
    331     GetFloatArrayDataRefTask(XPLMDataRef dataRef,
    332                              int maxCount = -1, int offset = 0);
    333 };
    334 
    335 //------------------------------------------------------------------------------
    336 //------------------------------------------------------------------------------
    337 
    338 /**
    339  * A dataref task which retrieves the value of an integer array.
    340  */
    341 class GetIntArrayDataRefTask :
    342         public GetArrayDataRefTask<int, GetIntArrayDataRefTask>
    343 {
    344 public:
    345     /**
    346      * Get the data via XPLM
    347      */
    348     static int queryData(XPLMDataRef dataRef, int* dest,
    349                          int offset, int count);
    350 
    351 public:
    352     /**
    353      * Construct the task for the dataref with the given name.
    354      *
     332     * @param dataRef the dataref
    355333     * @param maxCount the maximal number of data items to
    356334     * retrieve. If <0, the function will perform an extra query to
    357335     * retrieve the size of the dataref's data, which it will store in
    358336     * the task, so later on it can be reused.
    359      */
    360     GetIntArrayDataRefTask(const std::string& name,
    361                            int maxCount = -1, int offset = 0);
    362 
    363     /**
    364      * Construct the task for the given dataref
    365      *
    366      * @param maxBytes the maximal number of data items to
     337     * @param offset the offset from which to query the array
     338     */
     339    GetFloatArrayDataRefTask(XPLMDataRef dataRef,
     340                             int maxCount = -1, int offset = 0);
     341};
     342
     343//------------------------------------------------------------------------------
     344//------------------------------------------------------------------------------
     345
     346/**
     347 * A dataref task which retrieves the value of an integer array.
     348 */
     349class GetIntArrayDataRefTask :
     350        public GetArrayDataRefTask<int, GetIntArrayDataRefTask>
     351{
     352public:
     353    /**
     354     * Get the data via XPLM
     355     */
     356    static int queryData(XPLMDataRef dataRef, int* dest,
     357                         int offset, int count);
     358
     359public:
     360    /**
     361     * Construct the task for the dataref with the given name.
     362     *
     363     * @param name the name of the dataref
     364     * @param maxCount the maximal number of data items to
    367365     * retrieve. If <0, the function will perform an extra query to
    368366     * retrieve the size of the dataref's data, which it will store in
    369367     * the task, so later on it can be reused.
     368     * @param offset the offset from which to query the array
     369     */
     370    GetIntArrayDataRefTask(const std::string& name,
     371                           int maxCount = -1, int offset = 0);
     372
     373    /**
     374     * Construct the task for the given dataref
     375     *
     376     * @param dataRef the dataref
     377     * @param maxCount the maximal number of data items to
     378     * retrieve. If <0, the function will perform an extra query to
     379     * retrieve the size of the dataref's data, which it will store in
     380     * the task, so later on it can be reused.
     381     * @param offset the offset from which to query the array
    370382     */
    371383    GetIntArrayDataRefTask(XPLMDataRef dataRef,
    … …  
    393405     * Construct the task for the dataref with the given name.
    394406     *
     407     * @param name the name of the dataref
    395408     * @param maxBytes the maximal number of bytes to retrieve. If <0,
    396409     * the function will perform an extra query to retrieve the size
    397410     * of the dataref's data, which it will store in the task, so
    398411     * later on it can be reused.
     412     * @param offset the offset from which to query the array
    399413     */
    400414    GetByteArrayDataRefTask(const std::string& name,
    … …  
    404418     * Construct the task for the given dataref
    405419     *
     420     * @param dataRef the dataref
    406421     * @param maxBytes the maximal number of bytes to retrieve. If <0,
    407422     * the function will perform an extra query to retrieve the size
    408423     * of the dataref's data, which it will store in the task, so
    409424     * later on it can be reused.
     425     * @param offset the offset from which to query the array
    410426     */
    411427    GetByteArrayDataRefTask(XPLMDataRef dataRef,
Note: See TracChangeset for help on using the changeset viewer.