Revision 49:38ecfbff5391, committed 2015-05-22

Comitter:

Alex Young

Date:

Fri May 22 15:32:19 2015 +0200

Parent:

48:69d35430fe8b

Child:

50:f581d5428ea6

Commit message:

Fix typos in documentation comments.

Also be consistent with using 'an X...'.

Changed in this revision

--- a/main.cpp	Thu May 21 16:45:07 2015 +0200
+++ b/main.cpp	Fri May 22 15:32:19 2015 +0200
@@ -38,7 +38,7 @@
  */
 #define DATA_QUEUE_SIZE (2)
 /*!
- * \brief The maximum size of a xbus message supported by the application.
+ * \brief The maximum size of an xbus message supported by the application.
  * This is the size of the message buffers in the message data memory pool.
  */
 #define MAX_XBUS_DATA_SIZE (128)
@@ -139,7 +139,7 @@
 /*!
  * \brief RAII object to manage message memory deallocation.
  *
- * Will automatically free the memory used by a XbusMessage when going out
+ * Will automatically free the memory used by an XbusMessage when going out
  * of scope.
  */
 class XbusMessageMemoryManager
@@ -233,7 +233,7 @@
  *
  * In this example received messages are copied into one of two message
  * queues for later handling by the main thread. Data messages are put
- * in one queue, while all other responses are place in the second queue.
+ * in one queue, while all other responses are placed in the second queue.
  * This is done so that data and other messages can be handled separately
  * by the application code.
  */
@@ -336,7 +336,7 @@
  * of the attached device.
  *
  * The output configuration depends on the type of MTi-1 device connected.
- * A MTI-1 (IMU) device does not have an onboard orientation filter so
+ * An MTI-1 (IMU) device does not have an onboard orientation filter so
  * cannot output quaternion data, only inertial and magnetic measurement
  * data.
  * MTi-2 and MTi-3 devices have an onboard filter so can send quaternions.
@@ -390,8 +390,8 @@
  * \param timeout Time to wait to receive the wakeup message.
  * \return true if wakeup received within timeout, else false.
  *
- * The MTi sends a XMID_Wakeup message once it has completed its bootup
- * procedure. If this is acknowledged by a XMID_WakeupAck message then the MTi
+ * The MTi sends an XMID_Wakeup message once it has completed its bootup
+ * procedure. If this is acknowledged by an XMID_WakeupAck message then the MTi
  * will stay in configuration mode. Otherwise it will automatically enter
  * measurement mode with the stored output configuration.
  */

--- a/xbus/xbusmessage.c	Thu May 21 16:45:07 2015 +0200
+++ b/xbus/xbusmessage.c	Fri May 22 15:32:19 2015 +0200
@@ -111,7 +111,7 @@
 }
 
 /*!
- * \brief Get a pointer to the data correspondind to \a id.
+ * \brief Get a pointer to the data corresponding to \a id.
  * \param id The data identifier to find in the message.
  * \param data Pointer to the raw message payload.
  * \param dataLength The length of the payload in bytes.
@@ -151,7 +151,7 @@
 }
 
 /*!
- * \brief Get a data item from a XMID_MtData2 Xbus message.
+ * \brief Get a data item from an XMID_MtData2 Xbus message.
  * \param item Pointer to where to store the data.
  * \param id The data identifier to get.
  * \param message The message to read the data item from.
@@ -197,7 +197,7 @@
 }
 
 /*!
- * \brief Get a string descriptions for the passed data identifier.
+ * \brief Get a string description for the passed data identifier.
  */
 char const* XbusMessage_dataDescription(enum XsDataIdentifier id)
 {

--- a/xbus/xbusparser.c	Thu May 21 16:45:07 2015 +0200
+++ b/xbus/xbusparser.c	Fri May 22 15:32:19 2015 +0200
@@ -102,7 +102,7 @@
 }
 
 /*!
- * \brief Parse a XMID_DeviceId message to extract the device ID value.
+ * \brief Parse an XMID_DeviceId message to extract the device ID value.
 
  * Replaces the raw Xbus message data with the device ID.
  */
@@ -122,7 +122,7 @@
 }
 
 /*!
- * \brief Parse a XMID_OutputConfig message.
+ * \brief Parse an XMID_OutputConfig message.
  *
  * Replaces the raw Xbus message data with an array of OutputConfiguration
  * structures.