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

Timestamp:

May 11, 2023 1:01:08 AM (22 months ago)

Author:

vboxsync

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

157315

Message:

*: doxygen corrections (mostly about removing @returns from functions returning void).

Location:

trunk/src/VBox/Debugger

Files:

• DBGCCmdWorkers.cpp (modified) (1 diff)
• DBGCEmulateCodeView.cpp (modified) (7 diffs)
• DBGCGdbRemoteStub.cpp (modified) (4 diffs)
• DBGCIo.cpp (modified) (1 diff)
• DBGCIoProvInternal.h (modified) (1 diff)
• DBGCRemoteKd.cpp (modified) (8 diffs)
• DBGCScreenAscii.cpp (modified) (2 diffs)
• DBGPlugInLinux.cpp (modified) (1 diff)
• DBGPlugInWinNt.cpp (modified) (2 diffs)
• VBoxDbgConsole.cpp (modified) (1 diff)
• VBoxDbgStatsQt.cpp (modified) (1 diff)

trunk/src/VBox/Debugger/DBGCCmdWorkers.cpp

@@ -274 +274 @@
  * Inserts the given trace flow module into the list.
  *
- * @returns nothing.
  * @param   pDbgc         The DBGC instance.
  * @param   pTraceFlow    The trace flow module.

trunk/src/VBox/Debugger/DBGCEmulateCodeView.cpp

@@ -1566 +1566 @@
  * border and spacing on the edges.
  *
- * @returns nothing.
  * @param   hFlowBb              The basic block handle.
  * @param   pDumpBb             The dumper state to fill in for the basic block.
@@ -1610 +1609 @@
  * Dumps a top or bottom boundary line.
  *
- * @returns nothing.
  * @param   hScreen             The screen to draw to.
  * @param   uStartX             Where to start drawing the boundary.
@@ -1630 +1628 @@
  * Dumps a spacing line between the top or bottom boundary and the actual disassembly.
  *
- * @returns nothing.
  * @param   hScreen             The screen to draw to.
  * @param   uStartX             Where to start drawing the spacing.
@@ -1650 +1647 @@
  * Writes a given text to the screen.
  *
- * @returns nothing.
  * @param   hScreen             The screen to draw to.
  * @param   uStartX             Where to start drawing the line.
@@ -1673 +1669 @@
  * Dumps one basic block using the dumper callback.
  *
- * @returns nothing.
  * @param   pDumpBb             The basic block dump state to dump.
  * @param   hScreen             The screen to draw to.
@@ -1720 +1715 @@
  * Dumps one branch table using the dumper callback.
  *
- * @returns nothing.
  * @param   pDumpBranchTbl      The basic block dump state to dump.
  * @param   hScreen             The screen to draw to.
@@ -5809 +5803 @@
  * Used during DBGC initialization to configure events with defaults.
  *
- * @returns VBox status code.
  * @param   pDbgc       The DBGC instance.
  */

trunk/src/VBox/Debugger/DBGCGdbRemoteStub.cpp

@@ -355 +355 @@
  * Deregisters the given trace point (needs to be unregistered from DBGF by the caller before).
  *
- * @returns nothing.
  * @param   pTp                 The trace point to deregister.
  */
@@ -2134 +2133 @@
  * Resets the packet buffer.
  *
- * @returns nothing.
  * @param   pThis               The GDB stub context.
  */
@@ -2148 +2146 @@
  * Resets the given GDB stub context to the initial state.
  *
- * @returns nothing.
  * @param   pThis               The GDB stub context.
  */
@@ -2777 +2774 @@
  * Destroys the given GDB stub context.
  *
- * @returns nothing.
  * @param   pThis                   The GDB stub context to destroy.
  */

trunk/src/VBox/Debugger/DBGCIo.cpp

@@ -160 +160 @@
  * Destroys all allocated data for the given dbeugger console I/O instance.
  *
- * @returns nothing.
  * @param   pDbgcIo             Pointer to the dbeugger console I/O instance data.
  */

trunk/src/VBox/Debugger/DBGCIoProvInternal.h

@@ -73 +73 @@
      * Destroys the given I/O provider instance.
      *
-     * @returns nothing.
      * @param   hDbgcIoProv     The I/O provider instance handle to destroy.
      */

trunk/src/VBox/Debugger/DBGCRemoteKd.cpp

@@ -1461 +1461 @@
  * Returns a human readable string of the given manipulate request ID.
  *
- * @returns nothing.
+ * @returns Human readable string (read only).
  * @param   idReq               Request ID (API number in KD speak).
  */
@@ -1507 +1507 @@
  * Dumps the content of a manipulate packet.
  *
- * @returns nothing.
  * @param   pSgBuf              S/G buffer containing the manipulate packet payload.
  */
@@ -1689 +1688 @@
  * Resets the emulated hardware breakpoint state to a state similar after a reboot.
  *
- * @returns nothing.
  * @param   pThis               The KD context.
  */
@@ -1868 +1866 @@
  * Updates emulated hardware breakpoints based on the written DR6 value.
  *
- * @returns nothing.
  * @param   pThis               The KD context.
  * @param   uDr6                The DR7 value which is written.
@@ -2660 +2657 @@
  * Resets the packet receive state machine.
  *
- * @returns nothing.
  * @param   pThis               The KD context.
  */
@@ -2715 +2711 @@
  * Sends a message to the remotes end.
  *
- * @returns nothing.
  * @param   pThis               The KD context data.
  * @param   fWarning            Flag whether this is a warning or an informational message.
@@ -3723 +3718 @@
  * Tries to detect the guest OS running in the VM looking specifically for the Windows NT kind.
  *
- * @returns Nothing.
  * @param   pThis               The KD context.
  */
@@ -4469 +4463 @@
  * Destroys the given KD context.
  *
- * @returns nothing.
  * @param   pThis                   The KD context to destroy.
  */

trunk/src/VBox/Debugger/DBGCScreenAscii.cpp

@@ -229 +229 @@
  * Destroys a given ASCII screen.
  *
- * @returns nothing.
  * @param   hScreen             The screen handle.
  */
@@ -355 +354 @@
  * Draws a vertical line at the given coordinates.
  *
- * @returns nothing.
+ * @returns VBox status code.
  * @param   hScreen             The screen handle.
  * @param   uX                  X position to draw.

trunk/src/VBox/Debugger/DBGPlugInLinux.cpp

@@ -1258 +1258 @@
  * Destroy the config database.
  *
- * @returns nothing.
  * @param   pThis               The Linux digger data.
  */

trunk/src/VBox/Debugger/DBGPlugInWinNt.cpp

@@ -579 +579 @@
  * to gather debug information from the system.
  *
- * @returns nothing.
  * @param   pThis           The instance data.
  * @param   pUVM            The user mode VM handle.
@@ -660 +659 @@
  * Tries to resolve the KPCR and KPCRB addresses for each vCPU.
  *
- * @returns nothing.
  * @param   pThis           The instance data.
  * @param   pUVM            The user mode VM handle.

trunk/src/VBox/Debugger/VBoxDbgConsole.cpp

@@ -882 +882 @@
 
 
-/**
- * The Debugger Console Thread
- *
- * @returns VBox status code (ignored).
- * @param   Thread      The thread handle.
- * @param   pvUser      Pointer to the VBoxDbgConsole object.s
- */
 /*static*/ DECLCALLBACK(int)
 VBoxDbgConsole::backThread(RTTHREAD Thread, void *pvUser)

trunk/src/VBox/Debugger/VBoxDbgStatsQt.cpp

@@ -365 +365 @@
      * in anticipation of the next updateCallback call.
      *
-     * @returns The current node.
      * @param   pNode       The current node.
      */