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/client/c/hu/varadiistvan/xplra/MultiBuffer.h

    r57 r66  
    329329     * Set the value of the float array dataref with the given ID.
    330330     *
     331     * @param id the ID of the float array dataref
     332     * @param value the source buffer
    331333     * @param length the amount of data, i.e. you can set only a part
    332334     * of the data in the buffer. If 0, it is assumed to be the length
    … …  
    344346     * Get the value of the float array dataref with the given ID
    345347     *
     348     * @param id the ID of the float array dataref
     349     * @param value the destination buffer
    346350     * @param length the size of the buffer. If 0, it is assumed to be
    347351     * the length of the data in the buffer minus the offset (see
    … …  
    360364     * buffer.
    361365     *
     366     * @param id the ID of the float array dataref
    362367     * @param offset the offset within the buffer. If it is not less
    363368     * than the length of the buffer, 0 is returned.
    … …  
    369374     * Set the value of the integer array dataref with the given ID.
    370375     *
     376     * @param id the ID of the integer array dataref
     377     * @param value the source buffer
    371378     * @param length the amount of data, i.e. you can set only a part
    372379     * of the data in the buffer. If 0, it is assumed to be the length
    … …  
    384391     * Get the value of the integer array dataref with the given ID
    385392     *
     393     * @param id the ID of the integer array dataref
     394     * @param value the destination buffer
    386395     * @param length the size of the buffer. If 0, it is assumed to be
    387396     * the length of the data in the buffer minus the offset (see
    … …  
    399408     * Get the array of integer values as a directly readable buffer.
    400409     *
     410     * @param id the ID of the float array dataref
    401411     * @param offset the offset within the buffer. If it is not less
    402412     * than the length of the buffer, 0 is returned.
    … …  
    409419     * Set the value of the byte array dataref with the given ID.
    410420     *
     421     * @param id the ID of the byte array dataref
     422     * @param value the source buffer
    411423     * @param length the amount of data, i.e. you can set only a part
    412424     * of the data in the buffer. If 0, it is assumed to be the length
    … …  
    424436     * Get the value of the byte array dataref with the given ID
    425437     *
     438     * @param id the ID of the byte array dataref
     439     * @param value the destination buffer
    426440     * @param length the size of the buffer. If 0, it is assumed to be
    427441     * the length of the data in the buffer minus the offset (see
    … …  
    433447     */
    434448    size_t getByteArray(size_t id, uint8_t* value,
    435                        size_t length = 0, size_t offset = 0) const
     449                        size_t length = 0, size_t offset = 0) const
    436450        throw(InvalidIDException, TypeMismatchException);
    437451
    … …  
    439453     * Get the array of byte values as a directly readable buffer.
    440454     *
     455     * @param id the ID of the byte array dataref
    441456     * @param offset the offset within the buffer. If it is not less
    442457     * than the length of the buffer, 0 is returned.
Note: See TracChangeset for help on using the changeset viewer.