Changeset 66:f7c8521991df in xplra for src/client/c/hu/varadiistvan/xplra/XPlane.h

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:

• src/client/c/hu/varadiistvan/xplra/XPlane.h (modified) (6 diffs)

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

@@ -173 +173 @@
      * Get a possibly partial array of floats.
      *
+     * @param name the name of the dataref
+     * @param dest the destination buffer
      * @param length the length of the destination buffer
      * @param offset the offset from which to get the array
@@ -185 +187 @@
      * be created with a length needed to hold the returned value.
      *
+     * @param name the name of the dataref
+     * @param length will contain the number of floats read
      * @param offset the offset from which to get the array
      */
@@ -193 +197 @@
      * Get a possibly partial array of integers.
      *
+     * @param name the name of the dataref
+     * @param dest the destination buffer
      * @param length the length of the destination buffer
      * @param offset the offset from which to get the array
@@ -205 +211 @@
      * be created with a length needed to hold the returned value.
      *
+     * @param name the name of the dataref
+     * @param length will contain the number of integers read
      * @param offset the offset from which to get the array
      */
@@ -213 +221 @@
      * Get a possibly partial array of bytes.
      *
+     * @param name the name of the dataref
+     * @param dest the destination buffer
      * @param length the length of the destination buffer
      * @param offset the offset from which to get the array
@@ -225 +235 @@
      * be created with a length needed to hold the returned value.
      *
-     * @param offset the offset from which to get the array
-     */
-    uint8_t* getByteArray(const char* name, size_t& lengyh,
+     * @param name the name of the dataref
+     * @param length will contain the number of bytes read on return
+     * @param offset the offset from which to get the array
+     */
+    uint8_t* getByteArray(const char* name, size_t& length,
                           size_t offset = 0) throw(Exception);