Changeset 66:f7c8521991df in xplra for src/client/c/hu


Ignore:
Timestamp:
04/09/13 15:41:24 (12 years ago)
Author:
István Váradi <ivaradi@…>
Branch:
default
Phase:
public
Message:

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

Location:
src/client/c/hu/varadiistvan/xplra
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • src/client/c/hu/varadiistvan/xplra/MultiBuffer.cc

    r57 r66  
    259259//------------------------------------------------------------------------------
    260260
    261 size_t MultiBuffer::addInt(const string& name) throw()
     261size_t MultiBuffer::addInt(const std::string& name) throw()
    262262{
    263263    unfinalize();
    … …  
    268268//------------------------------------------------------------------------------
    269269
    270 size_t MultiBuffer::addFloat(const string& name) throw()
     270size_t MultiBuffer::addFloat(const std::string& name) throw()
    271271{
    272272    unfinalize();
    … …  
    277277//------------------------------------------------------------------------------
    278278
    279 size_t MultiBuffer::addDouble(const string& name) throw()
     279size_t MultiBuffer::addDouble(const std::string& name) throw()
    280280{
    281281    unfinalize();
    … …  
    286286//------------------------------------------------------------------------------
    287287
    288 size_t MultiBuffer::addFloatArray(const string& name, size_t length,
     288size_t MultiBuffer::addFloatArray(const std::string& name, size_t length,
    289289                                  size_t offset) throw()
    290290{
    … …  
    297297//------------------------------------------------------------------------------
    298298
    299 size_t MultiBuffer::addIntArray(const string& name, size_t length,
     299size_t MultiBuffer::addIntArray(const std::string& name, size_t length,
    300300                                size_t offset) throw()
    301301{
    … …  
    308308//------------------------------------------------------------------------------
    309309
    310 size_t MultiBuffer::addByteArray(const string& name, size_t length,
     310size_t MultiBuffer::addByteArray(const std::string& name, size_t length,
    311311                                 size_t offset) throw()
    312312{

  • 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.

  • src/client/c/hu/varadiistvan/xplra/XPlane.h

    r54 r66  
    173173     * Get a possibly partial array of floats.
    174174     *
     175     * @param name the name of the dataref
     176     * @param dest the destination buffer
    175177     * @param length the length of the destination buffer
    176178     * @param offset the offset from which to get the array
    … …  
    185187     * be created with a length needed to hold the returned value.
    186188     *
     189     * @param name the name of the dataref
     190     * @param length will contain the number of floats read
    187191     * @param offset the offset from which to get the array
    188192     */
    … …  
    193197     * Get a possibly partial array of integers.
    194198     *
     199     * @param name the name of the dataref
     200     * @param dest the destination buffer
    195201     * @param length the length of the destination buffer
    196202     * @param offset the offset from which to get the array
    … …  
    205211     * be created with a length needed to hold the returned value.
    206212     *
     213     * @param name the name of the dataref
     214     * @param length will contain the number of integers read
    207215     * @param offset the offset from which to get the array
    208216     */
    … …  
    213221     * Get a possibly partial array of bytes.
    214222     *
     223     * @param name the name of the dataref
     224     * @param dest the destination buffer
    215225     * @param length the length of the destination buffer
    216226     * @param offset the offset from which to get the array
    … …  
    225235     * be created with a length needed to hold the returned value.
    226236     *
    227      * @param offset the offset from which to get the array
    228      */
    229     uint8_t* getByteArray(const char* name, size_t& lengyh,
     237     * @param name the name of the dataref
     238     * @param length will contain the number of bytes read on return
     239     * @param offset the offset from which to get the array
     240     */
     241    uint8_t* getByteArray(const char* name, size_t& length,
    230242                          size_t offset = 0) throw(Exception);
    231243
Note: See TracChangeset for help on using the changeset viewer.