Changeset 45031 in vbox for trunk/include/VBox/vmm

Timestamp:

Mar 13, 2013 9:21:34 PM (12 years ago)

Author:

vboxsync

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

84277

Message:

pdmcardreaderinfs.h: Todo about repeating the interface name in each method name.

File:

• trunk/include/VBox/vmm/pdmcardreaderinfs.h (modified) (6 diffs)

trunk/include/VBox/vmm/pdmcardreaderinfs.h

@@ -1 +1 @@
 /* $Id$ */
-
 /** @file
  * cardreaderinfs - interface between Usb Card Reader device and its driver.
@@ -27 +26 @@
 
 #ifndef ___VBox_vmm_pdmcardreaderinfs_h
-# define ___VBox_vmm_pdmcardreaderinfs_h
+#define ___VBox_vmm_pdmcardreaderinfs_h
 
 #include <VBox/types.h>
 
-#define PDMICARDREADERDOWN_IID  "78d65378-889c-4418-8bc2-7a89a5af2817"
 
 typedef struct PDMICARDREADER_IO_REQUEST
@@ -50 +48 @@
 
 
+#define PDMICARDREADERDOWN_IID  "78d65378-889c-4418-8bc2-7a89a5af2817"
 typedef struct PDMICARDREADERDOWN PDMICARDREADERDOWN;
 typedef PDMICARDREADERDOWN *PPDMICARDREADERDOWN;
 struct PDMICARDREADERDOWN
 {
+    /** @todo r=bird: Why on earth is CardReaderDown part of the names here??
+     *  Please do s/pfnCardReaderDown/pfn/g. */
     DECLR3CALLBACKMEMBER(int, pfnCardReaderDownEstablishContext,(PPDMICARDREADERDOWN pInterface));
     DECLR3CALLBACKMEMBER(int, pfnCardReaderDownConnect,(PPDMICARDREADERDOWN pInterface, void *pvUser, const char *pszCardReaderName,
@@ -72 +73 @@
     /**
      * Up level provides pvInBuffer of cbInBuffer bytes to call SCardControl, also it specify bytes it expects to receive
-     * @note: device/driver implementation should copy buffers before execution in async mode, and both layers shouldn't
-     * expect permanent storage for the buffer.
+     * @note    Device/driver implementation should copy buffers before execution in
+     *          async mode, and both layers shouldn't expect permanent storage for the
+     *          buffer.
      */
     DECLR3CALLBACKMEMBER(int, pfnCardReaderDownControl,(PPDMICARDREADERDOWN pInterface, void *pvUser,
@@ -92 +94 @@
 struct PDMICARDREADERUP
 {
+    /** @todo r=bird: Why on earth is CardReaderUp part of the names here??
+     *        Please do s/pfnCardReaderUp/pfn/g. */
     DECLR3CALLBACKMEMBER(int, pfnCardReaderUpEstablishContext,(PPDMICARDREADERUP pInterface, int32_t lSCardRc));
     DECLR3CALLBACKMEMBER(int, pfnCardReaderUpStatus,(PPDMICARDREADERUP pInterface, void *pvUser, int32_t lSCardRc,
@@ -115 +119 @@
 
 #endif
+