Changeset 65118 in vbox for trunk/src/VBox/Debugger

Timestamp:

Jan 4, 2017 5:09:04 PM (8 years ago)

Author:

vboxsync

Message:

Debugger: doxygen fixes

Location:

trunk/src/VBox/Debugger

Files:

• DBGCCmdHlp.cpp (modified) (3 diffs)
• DBGCEmulateCodeView.cpp (modified) (3 diffs)
• DBGCEval.cpp (modified) (2 diffs)
• DBGCScreenAscii.cpp (modified) (1 diff)
• DBGCTcp.cpp (modified) (1 diff)
• DBGPlugInLinux.cpp (modified) (2 diffs)
• VBoxDbgBase.h (modified) (2 diffs)

trunk/src/VBox/Debugger/DBGCCmdHlp.cpp

@@ -255 +255 @@
 
 /**
- * @interface_method_impl{DBGCCMDHLP,pfnStrPrintf}
+ * @interface_method_impl{DBGCCMDHLP,pfnStrPrintfV}
  */
 static DECLCALLBACK(size_t) dbgcHlpStrPrintfV(PDBGCCMDHLP pCmdHlp, char *pszBuf, size_t cbBuf,
@@ -699 +699 @@
 
 /**
- * @interface_method_impl{DBGCCMDHLP,pfnFailV}
+ * @interface_method_impl{DBGCCMDHLP,pfnFailRcV}
  */
 static DECLCALLBACK(int) dbgcHlpFailRcV(PDBGCCMDHLP pCmdHlp, PCDBGCCMD pCmd, int rc, const char *pszFormat, va_list va)
@@ -936 +936 @@
  * @interface_method_impl{DBGCCMDHLP,pfnVarConvert}
  */
-static DECLCALLBACK(int) dbgcHlpVarConvert(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pInVar, DBGCVARTYPE enmToType, bool fConvSyms,
+static DECLCALLBACK(int) dbgcHlpVarConvert(PDBGCCMDHLP pCmdHlp, PCDBGCVAR pVar, DBGCVARTYPE enmToType, bool fConvSyms,
                                            PDBGCVAR pResult)
 {
     PDBGC           pDbgc = DBGC_CMDHLP2DBGC(pCmdHlp);
-    DBGCVAR const   InVar = *pInVar;    /* if pInVar == pResult  */
+    DBGCVAR const   InVar = *pVar;      /* if pVar == pResult  */
     PCDBGCVAR       pArg = &InVar;      /* lazy bird, clean up later */
     DBGFADDRESS     Address;

trunk/src/VBox/Debugger/DBGCEmulateCodeView.cpp

@@ -1626 +1626 @@
  *
  * @returns nothing.
- * @param   pDumpBb             The basic block dump state to dump.
+ * @param   pDumpBranchTbl      The basic block dump state to dump.
  * @param   hScreen             The screen to draw to.
  */
@@ -2621 +2621 @@
 
 /**
- * @callback_method_impl{FNDBGCCMD,
- *      The 'p', 'pc', 'pt', 't', 'tc', and 'tt' commands.}
+ * @callback_method_impl{FNDBGCCMD, The 'p'\, 'pc'\, 'pt'\, 't'\, 'tc'\, and 'tt' commands.}
  */
 static DECLCALLBACK(int) dbgcCmdStepTrace(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PUVM pUVM, PCDBGCVAR paArgs, unsigned cArgs)
@@ -4717 +4716 @@
  * @retval  VINF_SUCCESS on success.
  *
+ * @param   pCmdHlp The command helper callback table.
  * @param   pvBuf   The buffer to convert into.
  * @param   pcbBuf  The buffer size on input. The size of the result on output.

trunk/src/VBox/Debugger/DBGCEval.cpp

@@ -573 +573 @@
  * @param   pDbgc       Debugger console instance data.
  * @param   pszExpr     The expression string.
+ * @param   cchExpr     The size of the expression string.
  * @param   enmCategory The target category for the result.
  * @param   pResult     Where to store the result of the expression evaluation.
@@ -1043 +1044 @@
  * @param   paVarDescs      See DBGCCMD::paVarDescs and DBGCFUNC::paVarDescs.
  * @param   cVarDescs       See DBGCCMD::cVarDescs and DBGCFUNC::cVarDescs.
- * @param   pszArg          Pointer to the arguments to parse.
+ * @param   pszArgs         Pointer to the arguments to parse.
  * @param   piArg           Where to return the index of the first argument in
  *                          DBGC::aArgs. Always set. Caller must restore DBGC::iArg

trunk/src/VBox/Debugger/DBGCScreenAscii.cpp

@@ -236 +236 @@
  *
  * @returns VBox status code.
- * @param   pScreen             The screen to blit.
+ * @param   hScreen             The screen to blit.
  * @param   pfnBlit             Blitting callback.
  * @param   pvUser              Opaque user data to pass to the dumper callback.

trunk/src/VBox/Debugger/DBGCTcp.cpp

@@ -169 +169 @@
 
 /** @copydoc FNDBGCBACKSETREADY */
-static DECLCALLBACK(void) dbgcTcpBackSetReady(PDBGCBACK pBack, bool fBusy)
+static DECLCALLBACK(void) dbgcTcpBackSetReady(PDBGCBACK pBack, bool fReady)
 {
     /* stub */
     NOREF(pBack);
-    NOREF(fBusy);
+    NOREF(fReady);
 }
 

trunk/src/VBox/Debugger/DBGPlugInLinux.cpp

@@ -2092 +2092 @@
  * @param   pszCfg              The config data.
  * @param   ppszCfgNext         Where to store the pointer to the data following the identifier.
- * @param   pcbCfg              Where the initial size of the string is stored.
- *                              Contains the remaining string length on return.
  * @param   ppCfgItem           Where to store the created config item on success.
  */
@@ -2175 +2173 @@
  * @returns VBox status code
  * @param   pThis               The Linux digger data.
- * @param   pbCfg               The config string.
+ * @param   pszCfg              The config string.
  */
 static int dbgDiggerLinuxCfgParse(PDBGDIGGERLINUX pThis, const char *pszCfg)

trunk/src/VBox/Debugger/VBoxDbgBase.h

@@ -44 +44 @@
      * Construct the object.
      *
-     * @param   pDbgGui     Pointer to the debugger gui object.
+     * @param   a_pDbgGui   Pointer to the debugger gui object.
      */
     VBoxDbgBase(VBoxDbgGui *a_pDbgGui);
@@ -130 +130 @@
      * Construct the object.
      *
-     * @param   pDbgGui     Pointer to the debugger gui object.
+     * @param   a_pDbgGui   Pointer to the debugger gui object.
+     * @param   a_pParent   Pointer to the parent object.
      */
     VBoxDbgBaseWindow(VBoxDbgGui *a_pDbgGui, QWidget *a_pParent);