Changeset 6066 in vbox

Timestamp:

Dec 14, 2007 4:05:49 PM (17 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

26752

Message:

Hungarian is mandatory in this file. Also, a couple of todos.

File:

• trunk/include/VBox/pdmifs.h (modified) (3 diffs)

trunk/include/VBox/pdmifs.h ¶

@@ -1090 +1090 @@
 } PDMIISCSITRANSPORT;
 
-/** Status line type. */
+/** Status line type.
+ * @todo r=bird: These are just flags, so just use a uint8_t (or better an uint32_t / unsigned). no need for a type here. */
 typedef uint8_t PDMICHARSTATUSLINES;
 /** pointer to a PDMICHARSTATUSLINES type. */
 typedef PDMICHARSTATUSLINES *PPDMICHARSTATUSLINES;
- 
-/** Bit mask definitions for status line type*/
-#define PDM_ICHAR_STATUS_LINES_DCD RT_BIT(0)
-#define PDM_ICHAR_STATUS_LINES_RI  RT_BIT(1)
-#define PDM_ICHAR_STATUS_LINES_DSR RT_BIT(2)
-#define PDM_ICHAR_STATUS_LINES_CTS RT_BIT(3)
+
+/** @name Bit mask definitions for status line type
+ * @{ */
+#define PDM_ICHAR_STATUS_LINES_DCD  RT_BIT(0)
+#define PDM_ICHAR_STATUS_LINES_RI   RT_BIT(1)
+#define PDM_ICHAR_STATUS_LINES_DSR  RT_BIT(2)
+#define PDM_ICHAR_STATUS_LINES_CTS  RT_BIT(3)
+/** @} */
+
 
 /** Pointer to a char port interface. */
@@ -1125 +1129 @@
      * @returns VBox status code.
      * @param   pInterface      Pointer to the interface structure containing the called function pointer.
-     * @param   newStatusLine   New state of the status line pins.
-     * @thread  Any thread.
-     */
-    DECLR3CALLBACKMEMBER(int, pfnNotifyStatusLinesChanged,(PPDMICHARPORT pInterface, PDMICHARSTATUSLINES newStatusLines));
+     * @param   fNewStatusLine   New state of the status line pins.
+     * @thread  Any thread.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnNotifyStatusLinesChanged,(PPDMICHARPORT pInterface, PDMICHARSTATUSLINES fNewStatusLines));
 } PDMICHARPORT;
 
@@ -1167 +1171 @@
      *
      * @returns VBox status code.
-     * @param   pInterface        Pointer to the interface structure containing the called function pointer.
-     * @param   RequestToSend     Set to 1 to make the Request to Send line active otherwise to 0.
-     * @param   DataTerminalReady Set to 1 to make the Data Terminal Ready line active otherwise 0.
-     * @thread  Any thread.
-     */
-    DECLR3CALLBACKMEMBER(int, pfnSetModemLines,(PPDMICHAR pInterface, unsigned RequestToSend, unsigned DataTerminalReady));
+     * @param   pInterface          Pointer to the interface structure containing the called function pointer.
+     * @param   fRequestToSend      Set to 1 to make the Request to Send line active otherwise to 0.
+     * @param   fDataTerminalReady  Set to 1 to make the Data Terminal Ready line active otherwise 0.
+     * @thread  Any thread.
+     * @todo r=bird: Use booleans for 0/1 kind of values + make the code follow the descriptions (foo & const -> const/0), or fix the description.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnSetModemLines,(PPDMICHAR pInterface, unsigned fRequestToSend, unsigned fDataTerminalReady));
 
 } PDMICHAR;