Diff: TextDisplay.h

Revision:

76:c981284eb513

Parent:

61:8f3153bf0baa

Child:

103:7e0464ca6c5c

diff -r ca78388cfd77 -r c981284eb513 TextDisplay.h
--- a/TextDisplay.h	Fri Nov 28 22:37:53 2014 +0000
+++ b/TextDisplay.h	Fri Nov 28 22:53:35 2014 +0000
@@ -39,9 +39,9 @@
     ///
     /// @note this method may be overridden in a derived class.
     ///
-    /// @param x position in pixels
-    /// @param y position in pixels
-    /// @param c the character to be written to the TextDisplay
+    /// @param[in] x position in pixels
+    /// @param[in] y position in pixels
+    /// @param[in] c the character to be written to the TextDisplay
     /// @returns number of pixels to advance the cursor which could be the cell width
     ///     for non-proportional characters, or the actual character width for
     ///     proportional characters.
@@ -72,7 +72,7 @@
     ///
     /// @note this method may be overridden in a derived class.
     ///
-    /// @param stream that shall be redirected to the TextDisplay
+    /// @param[in] stream that shall be redirected to the TextDisplay
     /// @returns true if the claim succeeded.
     ///
     virtual bool claim (FILE *stream);
@@ -80,7 +80,8 @@
     /// clear screen
     ///
     /// @note this method may be overridden in a derived class.
-    /// @param layers is ignored, but supports maintaining the same 
+    ///
+    /// @param[in] layers is ignored, but supports maintaining the same 
     ///     API for the graphics layer.
     /// @returns error code.
     ///
@@ -92,8 +93,8 @@
     ///
     /// @note this method may be overridden in a derived class.
     ///
-    /// @param column is the horizontal offset from the left side.
-    /// @param row is the vertical offset from the top.
+    /// @param[in] column is the horizontal offset from the left side.
+    /// @param[in] row is the vertical offset from the top.
     /// @returns error code.
     ///
     virtual RetCode_t locate(textloc_t column, textloc_t row) = 0;
@@ -102,7 +103,7 @@
     ///
     /// @note this method may be overridden in a derived class.
     ///
-    /// @param color is color to use for foreground drawing.
+    /// @param[in] color is color to use for foreground drawing.
     /// @returns error code.
     ///
     virtual RetCode_t foreground(color_t color) = 0;
@@ -111,7 +112,7 @@
     ///
     /// @note this method may be overridden in a derived class.
     ///
-    /// @param color is color to use for background drawing.
+    /// @param[in] color is color to use for background drawing.
     /// @returns error code.
     ///
     virtual RetCode_t background(color_t color) = 0;