Changeset 66:f7c8521991df in xplra for src/plugin

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/plugin/src/xplra

Files:

• GetDataRefTask.h (modified) (6 diffs)
• SetDataRefTask.h (modified) (1 diff)

src/plugin/src/xplra/GetDataRefTask.h

@@ -246 +246 @@
      * Construct the task for the dataref with the given name.
      *
+     * @param name the name of the dataref
      * @param maxCount the maximal number of items to retrieve. If <0,
      * the function will perform an extra query to retrieve the size of
      * of the dataref's data, which it will store in the task, so
      * later on it can be reused.
+     * @param offset the offset from which to query the array
      */
     GetArrayDataRefTask(const std::string& name,
@@ -257 +259 @@
      * Construct the task for the given dataref
      *
+     * @param dataRef the dataref
      * @param maxCount the maximal number of items to retrieve. If <0,
      * the function will perform an extra query to retrieve the size
      * of the dataref's data, which it will store in the task, so
      * later on it can be reused.
+     * @param offset the offset from which to query the array
      */
     GetArrayDataRefTask(XPLMDataRef dataRef,
@@ -313 +317 @@
      * Construct the task for the dataref with the given name.
      *
+     * @param name the name of the dataref
      * @param maxCount the maximal number of data items to
      * retrieve. If <0, the function will perform an extra query to
      * retrieve the size of the dataref's data, which it will store in
      * the task, so later on it can be reused.
+     * @param offset the offset from which to query the array
      */
     GetFloatArrayDataRefTask(const std::string& name,
@@ -324 +330 @@
      * Construct the task for the given dataref
      *
-     * @param maxBytes the maximal number of data items to
-     * retrieve. If <0, the function will perform an extra query to
-     * retrieve the size of the dataref's data, which it will store in
-     * the task, so later on it can be reused.
-     */
-    GetFloatArrayDataRefTask(XPLMDataRef dataRef,
-                             int maxCount = -1, int offset = 0);
-};
-
-//------------------------------------------------------------------------------
-//------------------------------------------------------------------------------
-
-/**
- * A dataref task which retrieves the value of an integer array.
- */
-class GetIntArrayDataRefTask :
-        public GetArrayDataRefTask<int, GetIntArrayDataRefTask>
-{
-public:
-    /**
-     * Get the data via XPLM
-     */
-    static int queryData(XPLMDataRef dataRef, int* dest,
-                         int offset, int count);
-
-public:
-    /**
-     * Construct the task for the dataref with the given name.
-     *
+     * @param dataRef the dataref
      * @param maxCount the maximal number of data items to
      * retrieve. If <0, the function will perform an extra query to
      * retrieve the size of the dataref's data, which it will store in
      * the task, so later on it can be reused.
-     */
-    GetIntArrayDataRefTask(const std::string& name,
-                           int maxCount = -1, int offset = 0);
-
-    /**
-     * Construct the task for the given dataref
-     *
-     * @param maxBytes the maximal number of data items to
+     * @param offset the offset from which to query the array
+     */
+    GetFloatArrayDataRefTask(XPLMDataRef dataRef,
+                             int maxCount = -1, int offset = 0);
+};
+
+//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
+
+/**
+ * A dataref task which retrieves the value of an integer array.
+ */
+class GetIntArrayDataRefTask :
+        public GetArrayDataRefTask<int, GetIntArrayDataRefTask>
+{
+public:
+    /**
+     * Get the data via XPLM
+     */
+    static int queryData(XPLMDataRef dataRef, int* dest,
+                         int offset, int count);
+
+public:
+    /**
+     * Construct the task for the dataref with the given name.
+     *
+     * @param name the name of the dataref
+     * @param maxCount the maximal number of data items to
      * retrieve. If <0, the function will perform an extra query to
      * retrieve the size of the dataref's data, which it will store in
      * the task, so later on it can be reused.
+     * @param offset the offset from which to query the array
+     */
+    GetIntArrayDataRefTask(const std::string& name,
+                           int maxCount = -1, int offset = 0);
+
+    /**
+     * Construct the task for the given dataref
+     *
+     * @param dataRef the dataref
+     * @param maxCount the maximal number of data items to
+     * retrieve. If <0, the function will perform an extra query to
+     * retrieve the size of the dataref's data, which it will store in
+     * the task, so later on it can be reused.
+     * @param offset the offset from which to query the array
      */
     GetIntArrayDataRefTask(XPLMDataRef dataRef,
@@ -393 +405 @@
      * Construct the task for the dataref with the given name.
      *
+     * @param name the name of the dataref
      * @param maxBytes the maximal number of bytes to retrieve. If <0,
      * the function will perform an extra query to retrieve the size
      * of the dataref's data, which it will store in the task, so
      * later on it can be reused.
+     * @param offset the offset from which to query the array
      */
     GetByteArrayDataRefTask(const std::string& name,
@@ -404 +418 @@
      * Construct the task for the given dataref
      *
+     * @param dataRef the dataref
      * @param maxBytes the maximal number of bytes to retrieve. If <0,
      * the function will perform an extra query to retrieve the size
      * of the dataref's data, which it will store in the task, so
      * later on it can be reused.
+     * @param offset the offset from which to query the array
      */
     GetByteArrayDataRefTask(XPLMDataRef dataRef,

src/plugin/src/xplra/SetDataRefTask.h

@@ -62 +62 @@
      * signifies an error only, if some wrong data is read. If the
      * stream fails, it will indicate RESULT_OK.
+     * @param stream the stream to read from
      *
      * @return the new instance or 0 on error.