Diff: NWSWeather.h

Revision:

9:fcd83b2bd0cd

Parent:

6:cf96f2787a4e

Child:

17:99f09cc697fb

diff -r 8a3371926b32 -r fcd83b2bd0cd NWSWeather.h
--- a/NWSWeather.h	Fri Jul 04 13:19:28 2014 +0000
+++ b/NWSWeather.h	Sat Oct 11 17:27:07 2014 +0000
@@ -124,7 +124,7 @@
     /// wx.PrintAllWeatherRecords();
     /// @endcode
     /// 
-    /// @param baseurl is an optional parameter to set the base url. If this
+    /// @param[in] baseurl is an optional parameter to set the base url. If this
     ///     is not set "http://www.weather.gov/data/current_obs/" is used.
     ///     If it is set, that alternate base url is used.
     ///
@@ -139,8 +139,8 @@
     
     /// set an alternate base url after construction of the NWSWeather object.
     ///
-    /// @param alternateurl is the new url to replace the baseurl.
-    /// @param returns success/failure code. @see NWSReturnCode_T.
+    /// @param[in] alternateurl is the new url to replace the baseurl.
+    /// @returns success/failure code. @see NWSReturnCode_T.
     ///
     NWSReturnCode_T setAlternateURL(const char * alternateurl);
     
@@ -150,11 +150,11 @@
     /// using the baseurl established when the NWSWeather object was constructed,
     /// or when it was modified with the setAlternateURL API.
     ///
-    /// @param site is the site/location code of the site of interest.
-    /// @param responseSize is optional but important. It defaults to 2500
+    /// @param[in] site is the site/location code of the site of interest.
+    /// @param[in] responseSize is optional but important. It defaults to 2500
     ///         and is intended to tell this method the size of a buffer it
     ///         should temporarily allocate to receive and process the data.
-    /// @param returns success/failure code. @see NWSReturnCode_T.
+    /// @returns success/failure code. @see NWSReturnCode_T.
     ///
     NWSReturnCode_T get(const char * site, int responseSize = 2500);
     
@@ -167,7 +167,7 @@
     /// determines if a specific parameter was updated from the last
     /// acquisition.
     ///
-    /// @param i is the item of interest.
+    /// @param[in] i is the item of interest.
     /// @returns noerror if the parameter is up to date. @see NWSReturnCode_T.
     ///
     NWSReturnCode_T isUpdated(uint16_t i);
@@ -175,7 +175,7 @@
     /// determines if a specific parameter was updated from the last
     /// acquisition.
     ///
-    /// @param name is the item of interest.
+    /// @param[in] name is the item of interest.
     /// @returns noerror if the parameter is up to date. @see NWSReturnCode_T.
     ///
     NWSReturnCode_T isUpdated(const char * name);
@@ -205,11 +205,11 @@
     /// }
     /// @endcode
     ///
-    /// @param i is index of the parameter of interest.
-    /// @param name is a pointer that is set to point to the name of parameter i.
-    /// @param value is an optional pointer that is then set to point to the value of parameter i.
-    /// @param typeis is an optional pointer that is set to indicate the type of the value.
-    /// @param returns success/failure code. @see NWSReturnCode_T.
+    /// @param[in] i is index of the parameter of interest.
+    /// @param[in] name is a pointer that is set to point to the name of parameter i.
+    /// @param[out] value is an optional pointer that is then set to point to the value of parameter i.
+    /// @param[out] typeis is an optional pointer that is set to indicate the type of the value.
+    /// @returns success/failure code. @see NWSReturnCode_T.
     ///
     NWSReturnCode_T getParam(uint16_t i, char *name, Value_T *value = NULL, TypeOf_T *typeis = NULL);
     
@@ -226,10 +226,10 @@
     /// }
     /// @endcode
     ///
-    /// @param name is a const pointer to a string naming the parameter of interest.
-    /// @param value is a pointer that is set to point to the value of parameter i.
-    /// @param typeis is a pointer that is set to indicate the type of the value.
-    /// @param returns success/failure code. @see NWSReturnCode_T.
+    /// @param[in] name is a const pointer to a string naming the parameter of interest.
+    /// @param[out] value is a pointer that is set to point to the value of parameter i.
+    /// @param[out] typeis is a pointer that is set to indicate the type of the value.
+    /// @returns success/failure code. @see NWSReturnCode_T.
     ///
     NWSReturnCode_T getParam(const char *name, Value_T *value, TypeOf_T *typeis = NULL);
     
@@ -238,11 +238,11 @@
     /// Prints the specified record as a "Parmeter = value\r\n" string, formatted
     /// so that subsequent prints line up at the '=' sign.
     ///
-    /// @param i specifies the record.
+    /// @param[in] i specifies the record.
     ///
     void PrintWeatherRecord(uint16_t i);
 
-    /// Printa all the records to stdout.
+    /// Print all the records to stdout.
     ///
     /// calls PrintWeatherRecord for each available parameter.
     ///