From e70d817fc58fe57d35cc482f775d14867d9a3829 Mon Sep 17 00:00:00 2001 From: vboxsync Date: Thu, 11 May 2023 01:01:08 +0000 Subject: *: doxygen corrections (mostly about removing @returns from functions returning void). git-svn-id: https://www.virtualbox.org/svn/vbox/trunk@99739 cfe28804-0f27-0410-a406-dd0f0b0b656f --- Doxyfile.Core | 59 +++++++++++++++------- Makefile.kmk | 15 +++++- include/VBox/VBoxGuestLib.h | 2 - include/VBox/com/defs.h | 10 ++-- include/VBox/dbg.h | 2 - include/VBox/intnetinline.h | 6 --- include/VBox/rawpci.h | 2 - include/VBox/scsiinline.h | 7 --- include/VBox/vd-ifs-internal.h | 2 - include/VBox/vd-image-backend.h | 1 - include/VBox/vd.h | 3 -- include/VBox/vmm/pdmblkcache.h | 5 -- include/VBox/vmm/pdmdev.h | 7 --- include/VBox/vmm/pdmdrv.h | 3 -- include/VBox/vmm/pdmifs.h | 1 - include/VBox/vmm/pdmsrv.h | 3 -- include/VBox/vmm/pdmstorageifs.h | 3 -- include/VBox/vmm/pdmusb.h | 11 +--- include/VBox/vusb.h | 5 -- include/iprt/armv8.h | 1 + include/iprt/asm-amd64-x86.h | 2 - include/iprt/asm.h | 2 - include/iprt/cpp/restclient.h | 2 - include/iprt/dvm.h | 1 - include/iprt/ioqueue.h | 1 - include/iprt/ldr.h | 1 - include/iprt/list-off32.h | 1 - include/iprt/list.h | 1 - include/iprt/memsafer.h | 1 - include/iprt/sg.h | 3 -- include/iprt/string.h | 1 - include/iprt/thread.h | 1 - include/iprt/time.h | 1 - include/iprt/tracelog.h | 2 - include/iprt/utf16.h | 1 - .../Additions/WINNT/Mouse/NT5/VBoxMFInternal.cpp | 2 - src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp | 3 +- .../common/VBoxService/VBoxServiceTimeSync.cpp | 2 - .../common/VBoxService/VBoxServiceToolBox.cpp | 2 - src/VBox/Additions/common/pam/pam_vbox.cpp | 1 - src/VBox/Additions/linux/sharedfolders/dirops.c | 12 ++--- src/VBox/Additions/x11/VBoxClient/seamless-x11.cpp | 8 +-- src/VBox/Additions/x11/vboxvideo/vbva.c | 1 - src/VBox/Debugger/DBGCCmdWorkers.cpp | 1 - src/VBox/Debugger/DBGCEmulateCodeView.cpp | 7 --- src/VBox/Debugger/DBGCGdbRemoteStub.cpp | 4 -- src/VBox/Debugger/DBGCIo.cpp | 1 - src/VBox/Debugger/DBGCIoProvInternal.h | 1 - src/VBox/Debugger/DBGCRemoteKd.cpp | 9 +--- src/VBox/Debugger/DBGCScreenAscii.cpp | 3 +- src/VBox/Debugger/DBGPlugInLinux.cpp | 1 - src/VBox/Debugger/DBGPlugInWinNt.cpp | 2 - src/VBox/Debugger/VBoxDbgConsole.cpp | 7 --- src/VBox/Debugger/VBoxDbgStatsQt.cpp | 1 - src/VBox/Devices/Audio/AudioTest.cpp | 1 - src/VBox/Devices/Audio/AudioTestService.cpp | 1 - src/VBox/Devices/Audio/AudioTestServiceClient.cpp | 4 +- src/VBox/Devices/Audio/DevIchAc97.cpp | 4 -- src/VBox/Devices/EFI/FlashCore.cpp | 2 - src/VBox/Devices/Graphics/DevVGA-SVGA.cpp | 3 +- src/VBox/Devices/Graphics/DevVGA.cpp | 2 - src/VBox/Devices/Input/DevPS2.cpp | 1 - src/VBox/Devices/Input/DrvKeyboardQueue.cpp | 4 -- src/VBox/Devices/Input/DrvMouseQueue.cpp | 4 -- src/VBox/Devices/Misc/DevPL031.cpp | 1 - src/VBox/Devices/Network/DevPCNet.cpp | 2 - src/VBox/Devices/Network/DrvNAT.cpp | 1 - src/VBox/Devices/PC/BIOS/scsi.c | 1 - src/VBox/Devices/PC/DevQemuFwCfg.cpp | 3 -- src/VBox/Devices/Security/DevTpm.cpp | 5 -- src/VBox/Devices/Serial/DevOxPcie958.cpp | 2 - src/VBox/Devices/Serial/DevPL011.cpp | 4 -- src/VBox/Devices/Serial/DrvHostSerial.cpp | 3 -- src/VBox/Devices/Serial/DrvTCP.cpp | 1 - src/VBox/Devices/Serial/UartCore.cpp | 13 ----- src/VBox/Devices/Serial/UartCore.h | 1 - src/VBox/Devices/Storage/ATAPIPassthrough.cpp | 4 -- src/VBox/Devices/Storage/DevAHCI.cpp | 12 ----- src/VBox/Devices/Storage/DevATA.cpp | 5 -- src/VBox/Devices/Storage/DevBusLogic.cpp | 20 +------- src/VBox/Devices/Storage/DevLsiLogicSCSI.cpp | 23 +-------- src/VBox/Devices/Storage/DevVirtioSCSI.cpp | 3 -- src/VBox/Devices/Storage/DrvDiskIntegrity.cpp | 6 --- src/VBox/Devices/Storage/DrvHostBase.cpp | 1 - src/VBox/Devices/Storage/DrvRamDisk.cpp | 1 - src/VBox/Devices/Storage/DrvVD.cpp | 6 --- src/VBox/Devices/Storage/HBDMgmt-darwin.cpp | 2 - src/VBox/Devices/Storage/HBDMgmt-win.cpp | 1 - src/VBox/Devices/Storage/HBDMgmt.h | 1 - src/VBox/Devices/Storage/IOBufMgmt.cpp | 1 - src/VBox/Devices/Storage/IOBufMgmt.h | 1 - src/VBox/Devices/Storage/UsbMsd.cpp | 1 - src/VBox/Devices/Storage/VSCSI/VSCSIInternal.h | 5 -- src/VBox/Devices/Trace/DrvIfsTrace-serial.cpp | 1 - src/VBox/Devices/USB/DevEHCI.cpp | 2 - src/VBox/Devices/USB/DevOHCI.cpp | 8 --- src/VBox/Devices/USB/DevXHCI.cpp | 1 - src/VBox/Devices/USB/DrvVUSBRootHub.cpp | 1 - src/VBox/Devices/USB/VUSBDevice.cpp | 1 - src/VBox/Devices/USB/VUSBInternal.h | 7 ++- src/VBox/Devices/USB/VUSBSniffer.cpp | 1 - src/VBox/Devices/USB/VUSBSniffer.h | 1 - src/VBox/Devices/USB/VUSBSnifferInternal.h | 1 - src/VBox/Devices/USB/VUSBUrb.cpp | 2 - .../Devices/USB/darwin/USBProxyDevice-darwin.cpp | 1 - .../Devices/USB/linux/USBProxyDevice-linux.cpp | 2 - .../Devices/USB/usbip/USBProxyDevice-usbip.cpp | 13 ----- src/VBox/Devices/VMMDev/VMMDevTesting.cpp | 1 - src/VBox/Devices/VirtIO/VirtioCore.h | 1 - src/VBox/Devices/testcase/tstDeviceCfg.cpp | 1 - src/VBox/Devices/testcase/tstDeviceCfg.h | 1 - src/VBox/Frontends/VBoxAutostart/VBoxAutostart.h | 2 - .../Frontends/VBoxAutostart/VBoxAutostartCfg.cpp | 2 - .../Frontends/VBoxManage/VBoxInternalManage.cpp | 1 - src/VBox/HostDrivers/Support/SUPDrvInternal.h | 1 - src/VBox/HostDrivers/Support/SUPDrvTracer.cpp | 1 - src/VBox/HostDrivers/Support/SUPR0IdcClientStubs.c | 4 -- src/VBox/HostDrivers/Support/SUPR3HardenedMain.cpp | 18 ------- src/VBox/HostDrivers/Support/SUPSvc.cpp | 1 - .../Support/darwin/SUPR3HardenedMain-darwin.cpp | 3 -- .../HostDrivers/Support/freebsd/SUPDrv-freebsd.c | 1 - .../Support/posix/SUPR3HardenedMain-posix.cpp | 2 - .../HostDrivers/VBoxNetAdp/VBoxNetAdpInternal.h | 1 - .../HostDrivers/VBoxNetFlt/VBoxNetFltInternal.h | 1 - .../VBoxNetFlt/darwin/VBoxNetFlt-darwin.cpp | 1 - .../VBoxNetFlt/linux/VBoxNetFlt-linux.c | 1 - .../HostDrivers/VBoxUSB/solaris/VBoxUSB-solaris.c | 2 - .../VBoxSharedClipboardSvc-internal.h | 1 - src/VBox/HostServices/auth/winlogon/winlogon.cpp | 24 ++++----- .../ImageMounter/vboximg-mount/vboximg-mount.cpp | 2 - src/VBox/Main/include/GuestCtrlImplPrivate.h | 15 +++--- src/VBox/Main/include/GuestSessionImpl.h | 3 +- src/VBox/Main/src-all/NvramStoreImpl.cpp | 5 +- src/VBox/Main/src-all/win/VBoxProxyStub.c | 1 - src/VBox/Main/src-client/ConsoleImpl.cpp | 1 - src/VBox/Main/src-client/DisplayImpl.cpp | 1 - src/VBox/Main/src-client/DrvAudioRec.cpp | 1 - src/VBox/Main/src-client/GuestImpl.cpp | 1 - src/VBox/Main/src-client/HGCM.cpp | 6 +-- src/VBox/Main/src-client/KeyboardImpl.cpp | 1 - src/VBox/Main/src-client/MouseImpl.cpp | 1 - src/VBox/Main/src-client/RecordingInternals.cpp | 6 +-- src/VBox/Main/src-server/MachineImpl.cpp | 2 - src/VBox/Main/src-server/MediumImpl.cpp | 1 - src/VBox/Main/src-server/SnapshotImpl.cpp | 1 - src/VBox/Main/src-server/USBProxyBackend.cpp | 2 - src/VBox/Main/src-server/USBProxyService.cpp | 1 - src/VBox/Main/src-server/UefiVariableStoreImpl.cpp | 1 - src/VBox/Main/src-server/VFSExplorerImpl.cpp | 3 +- src/VBox/Main/src-server/VirtualBoxImpl.cpp | 4 -- src/VBox/Main/src-server/darwin/iokit.cpp | 1 - .../src-server/generic/USBProxyBackendUsbIp.cpp | 7 --- .../Main/src-server/linux/HostHardwareLinux.cpp | 1 - src/VBox/Main/testcase/tstVBoxCrypto.cpp | 2 - src/VBox/Main/webservice/vboxweb.cpp | 1 - src/VBox/Main/xml/ovfreader.cpp | 4 -- src/VBox/Runtime/Doxyfile | 2 + src/VBox/Runtime/common/dvm/dvmbsdlabel.cpp | 1 - src/VBox/Runtime/common/efi/efivarstorevfs.cpp | 6 +-- src/VBox/Runtime/common/fs/extvfs.cpp | 16 +----- src/VBox/Runtime/common/fs/xfsvfs.cpp | 12 ----- src/VBox/Runtime/common/fuzz/fuzz-config.cpp | 1 - src/VBox/Runtime/common/fuzz/fuzz-observer.cpp | 1 - .../Runtime/common/fuzz/fuzz-target-recorder.cpp | 4 -- src/VBox/Runtime/common/fuzz/fuzz.cpp | 6 --- src/VBox/Runtime/common/fuzz/fuzzmastercmd.cpp | 3 -- .../common/ioqueue/ioqueue-stdfile-provider.cpp | 1 - src/VBox/Runtime/common/log/tracelogreader.cpp | 5 -- src/VBox/Runtime/common/misc/json.cpp | 7 --- src/VBox/Runtime/common/zip/tarvfswriter.cpp | 1 - src/VBox/Runtime/include/internal/dvm.h | 2 - src/VBox/Runtime/r3/darwin/krnlmod-darwin.cpp | 1 - .../r3/linux/ioqueue-iouringfile-provider.cpp | 1 - src/VBox/Runtime/r3/linux/krnlmod-linux.cpp | 1 - src/VBox/Runtime/r3/posix/serialport-posix.cpp | 1 - src/VBox/Runtime/r3/solaris/krnlmod-solaris.cpp | 1 - src/VBox/Runtime/r3/win/krnlmod-win.cpp | 1 - src/VBox/Storage/CUE.cpp | 10 ---- src/VBox/Storage/ISCSI.cpp | 1 - src/VBox/Storage/QCOW.cpp | 15 ++---- src/VBox/Storage/QED.cpp | 31 ++++-------- src/VBox/Storage/VCICache.cpp | 2 - src/VBox/Storage/VD.cpp | 6 --- src/VBox/Storage/VDI.cpp | 1 - src/VBox/Storage/VHDX.cpp | 19 ------- src/VBox/Storage/VMDK.cpp | 2 - src/VBox/Storage/testcase/VDIoBackend.h | 4 +- src/VBox/Storage/testcase/VDIoBackendMem.h | 4 +- src/VBox/Storage/testcase/VDMemDisk.h | 2 - src/VBox/Storage/testcase/VDScript.cpp | 16 +----- src/VBox/Storage/testcase/VDScript.h | 1 - src/VBox/Storage/testcase/VDScriptAst.cpp | 2 - src/VBox/Storage/testcase/VDScriptAst.h | 1 - src/VBox/Storage/testcase/VDScriptInterp.cpp | 2 - src/VBox/Storage/testcase/VDScriptStack.h | 4 -- src/VBox/Storage/testcase/tstVDIo.cpp | 5 -- src/VBox/VMM/VMMAll/APICAll.cpp | 1 - src/VBox/VMM/VMMAll/CPUMAllRegs.cpp | 1 - src/VBox/VMM/VMMAll/DBGFAllTracer.cpp | 2 - src/VBox/VMM/VMMAll/HMAll.cpp | 1 - src/VBox/VMM/VMMAll/IEMAll.cpp | 2 - src/VBox/VMM/VMMAll/PGMAll.cpp | 1 - src/VBox/VMM/VMMAll/PGMAllHandler.cpp | 2 - src/VBox/VMM/VMMAll/PGMAllPhys.cpp | 2 - src/VBox/VMM/VMMR0/CPUMR0.cpp | 1 - src/VBox/VMM/VMMR0/DBGFR0Bp.cpp | 1 - src/VBox/VMM/VMMR0/HMSVMR0.cpp | 2 - src/VBox/VMM/VMMR0/HMVMXR0.cpp | 4 -- src/VBox/VMM/VMMR0/PGMR0.cpp | 1 - src/VBox/VMM/VMMR3/CFGM.cpp | 2 - src/VBox/VMM/VMMR3/CPUM-armv8.cpp | 3 -- src/VBox/VMM/VMMR3/CPUM.cpp | 3 -- src/VBox/VMM/VMMR3/DBGF.cpp | 1 - src/VBox/VMM/VMMR3/DBGFR3Bp.cpp | 3 -- src/VBox/VMM/VMMR3/DBGFR3Flow.cpp | 8 --- src/VBox/VMM/VMMR3/DBGFR3FlowTrace.cpp | 6 --- src/VBox/VMM/VMMR3/DBGFR3SampleReport.cpp | 4 -- src/VBox/VMM/VMMR3/DBGFR3Tracer.cpp | 1 - src/VBox/VMM/VMMR3/DBGFR3Type.cpp | 1 - src/VBox/VMM/VMMR3/GCM.cpp | 1 - src/VBox/VMM/VMMR3/GIM.cpp | 1 - src/VBox/VMM/VMMR3/GMM.cpp | 1 - src/VBox/VMM/VMMR3/MM.cpp | 1 - src/VBox/VMM/VMMR3/NEMR3Native-darwin-armv8.cpp | 1 - src/VBox/VMM/VMMR3/NEMR3Native-darwin.cpp | 1 - src/VBox/VMM/VMMR3/PDMAsyncCompletion.cpp | 8 --- src/VBox/VMM/VMMR3/PDMAsyncCompletionFile.cpp | 2 - .../VMM/VMMR3/PDMAsyncCompletionFileNormal.cpp | 2 - src/VBox/VMM/VMMR3/PDMBlkCache.cpp | 19 ++----- src/VBox/VMM/VMMR3/PDMNetShaper.cpp | 1 - src/VBox/VMM/VMMR3/PDMQueue.cpp | 1 - src/VBox/VMM/VMMR3/PGMPhys.cpp | 2 - src/VBox/VMM/VMMR3/TM.cpp | 4 +- src/VBox/VMM/include/DBGFInline.h | 4 -- src/VBox/VMM/include/IEMInternal-armv8.h | 1 - .../VMM/testcase/tstPDMAsyncCompletionStress.cpp | 1 - src/VBox/ValidationKit/utils/serial/SerialTest.cpp | 3 -- src/VBox/ValidationKit/utils/storage/IoPerf.cpp | 3 -- src/VBox/ValidationKit/utils/usb/UsbTest.cpp | 1 - .../ValidationKit/utils/usb/UsbTestService.cpp | 1 - .../utils/usb/UsbTestServiceGadget.cpp | 1 - .../utils/usb/UsbTestServiceGadgetClassTest.cpp | 1 - .../utils/usb/UsbTestServiceGadgetHost.cpp | 1 - .../utils/usb/UsbTestServiceGadgetHostInternal.h | 1 - .../utils/usb/UsbTestServiceGadgetInternal.h | 1 - .../utils/usb/UsbTestServiceProtocol.cpp | 4 -- .../utils/usb/UsbTestServiceProtocol.h | 4 -- 247 files changed, 139 insertions(+), 769 deletions(-) diff --git a/Doxyfile.Core b/Doxyfile.Core index 177c9fba7cc..ef5ef92507b 100644 --- a/Doxyfile.Core +++ b/Doxyfile.Core @@ -1,4 +1,4 @@ -# Doxyfile 1.8.9 +# Doxyfile 1.9.6 #--------------------------------------------------------------------------- # Project related configuration options @@ -10,6 +10,7 @@ PROJECT_BRIEF = PROJECT_LOGO = # OUTPUT_DIRECTORY = later CREATE_SUBDIRS = NO +CREATE_SUBDIRS_LEVEL = 8 ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES @@ -22,8 +23,10 @@ STRIP_FROM_PATH = STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES +JAVADOC_BANNER = NO QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO +PYTHON_DOCSTRING = YES INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 4 @@ -324,8 +327,10 @@ OPTIMIZE_OUTPUT_FOR_C = YES OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO +OPTIMIZE_OUTPUT_SLICE = NO EXTENSION_MAPPING = -MARKDOWN_SUPPORT = YES +MARKDOWN_SUPPORT = NO +TOC_INCLUDE_HEADINGS = 5 AUTOLINK_SUPPORT = YES BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO @@ -337,16 +342,19 @@ INLINE_GROUPED_CLASSES = NO INLINE_SIMPLE_STRUCTS = NO TYPEDEF_HIDES_STRUCT = NO LOOKUP_CACHE_SIZE = 0 +NUM_PROC_THREADS = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL = YES EXTRACT_PRIVATE = YES +EXTRACT_PRIV_VIRTUAL = NO EXTRACT_PACKAGE = NO EXTRACT_STATIC = YES EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO +RESOLVE_UNNAMED_PARAMS = YES HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO @@ -355,6 +363,7 @@ INTERNAL_DOCS = YES CASE_SENSE_NAMES = NO HIDE_SCOPE_NAMES = NO HIDE_COMPOUND_REFERENCE= NO +SHOW_HEADERFILE = YES SHOW_INCLUDE_FILES = YES SHOW_GROUPED_MEMB_INC = NO FORCE_LOCAL_INCLUDES = NO @@ -385,14 +394,19 @@ WARNINGS = YES ##Later: WARN_IF_UNDOCUMENTED = YES WARN_IF_UNDOCUMENTED = NO WARN_IF_DOC_ERROR = YES +WARN_IF_INCOMPLETE_DOC = YES WARN_NO_PARAMDOC = NO +WARN_IF_UNDOC_ENUM_VAL = NO +WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" +WARN_LINE_FORMAT = "at line $line of file $file" #WARN_LOGFILE = later #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # INPUT = later INPUT_ENCODING = UTF-8 +INPUT_FILE_ENCODING = FILE_PATTERNS = RECURSIVE = NO EXCLUDE = @@ -413,6 +427,7 @@ FILTER_PATTERNS = FILTER_SOURCE_FILES = NO FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = +FORTRAN_COMMENT_AFTER = 72 #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- @@ -425,13 +440,10 @@ REFERENCES_LINK_SOURCE = YES SOURCE_TOOLTIPS = YES USE_HTAGS = NO VERBATIM_HEADERS = YES -CLANG_ASSISTED_PARSING = NO -CLANG_OPTIONS = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = NO -COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output @@ -444,17 +456,20 @@ HTML_FOOTER = HTML_STYLESHEET = HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = +HTML_COLORSTYLE = AUTO_LIGHT HTML_COLORSTYLE_HUE = 220 HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 HTML_TIMESTAMP = YES +HTML_DYNAMIC_MENUS = YES HTML_DYNAMIC_SECTIONS = NO HTML_INDEX_NUM_ENTRIES = 100 GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" -DOCSET_BUNDLE_ID = org.doxygen.Project -DOCSET_PUBLISHER_ID = org.doxygen.Publisher -DOCSET_PUBLISHER_NAME = Publisher +DOCSET_FEEDURL = +DOCSET_BUNDLE_ID = org.virtualbox.core +DOCSET_PUBLISHER_ID = org.virtualbox +DOCSET_PUBLISHER_NAME = virtualbox GENERATE_HTMLHELP = NO CHM_FILE = HHC_LOCATION = @@ -464,7 +479,7 @@ BINARY_TOC = NO TOC_EXPAND = NO GENERATE_QHP = NO QCH_FILE = -QHP_NAMESPACE = org.doxygen.Project +QHP_NAMESPACE = org.virtualbox.core QHP_VIRTUAL_FOLDER = doc QHP_CUST_FILTER_NAME = QHP_CUST_FILTER_ATTRS = @@ -474,12 +489,16 @@ GENERATE_ECLIPSEHELP = NO ECLIPSE_DOC_ID = org.doxygen.Project DISABLE_INDEX = NO GENERATE_TREEVIEW = NO +FULL_SIDEBAR = NO ENUM_VALUES_PER_LINE = 4 TREEVIEW_WIDTH = 250 EXT_LINKS_IN_WINDOW = NO +OBFUSCATE_EMAILS = YES +HTML_FORMULA_FORMAT = png FORMULA_FONTSIZE = 10 -FORMULA_TRANSPARENT = YES +FORMULA_MACROFILE = USE_MATHJAX = NO +MATHJAX_VERSION = MathJax_2 MATHJAX_FORMAT = HTML-CSS MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest MATHJAX_EXTENSIONS = @@ -498,6 +517,7 @@ GENERATE_LATEX = NO LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex +LATEX_MAKEINDEX_CMD = makeindex COMPACT_LATEX = NO PAPER_TYPE = a4 EXTRA_PACKAGES = @@ -509,8 +529,9 @@ PDF_HYPERLINKS = NO USE_PDFLATEX = NO LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO -LATEX_SOURCE_CODE = NO LATEX_BIB_STYLE = plain +LATEX_TIMESTAMP = NO +LATEX_EMOJI_DIRECTORY = #--------------------------------------------------------------------------- # Configuration options related to the RTF output #--------------------------------------------------------------------------- @@ -520,7 +541,6 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = -RTF_SOURCE_CODE = NO #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- @@ -535,12 +555,12 @@ MAN_LINKS = NO GENERATE_XML = NO XML_OUTPUT = xml XML_PROGRAMLISTING = YES +XML_NS_MEMB_FILE_SCOPE = NO #--------------------------------------------------------------------------- # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook -DOCBOOK_PROGRAMLISTING = NO #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- @@ -631,6 +651,8 @@ PREDEFINED += \ RT_ASM_DECL_PRAGMA_WATCOM(type)=type \ RT_ASM_DECL_PRAGMA_WATCOM_386(type)=type \ DECLNORETURN(type)=type \ + DECL_CHECK_RETURN(type)=type \ + DECL_CHECK_RETURN_NOT_R3(type)=type \ RTCALL= \ \ VBOXCALL= \ @@ -903,19 +925,21 @@ EXTERNAL_PAGES = YES #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES DIA_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = NO DOT_NUM_THREADS = 0 -DOT_FONTNAME = Helvetica -DOT_FONTSIZE = 10 +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" DOT_FONTPATH = CLASS_GRAPH = YES COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES UML_LOOK = YES UML_LIMIT_NUM_FIELDS = 10 +DOT_UML_DETAILS = YES +DOT_WRAP_THRESHOLD = 17 TEMPLATE_RELATIONS = YES INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES @@ -923,6 +947,7 @@ CALL_GRAPH = YES CALLER_GRAPH = YES GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES +DIR_GRAPH_MAX_DEPTH = 1 DOT_IMAGE_FORMAT = png INTERACTIVE_SVG = NO DOT_PATH = @@ -933,8 +958,6 @@ PLANTUML_JAR_PATH = PLANTUML_INCLUDE_PATH = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -DOT_TRANSPARENT = YES DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES DOT_CLEANUP = YES -MARKDOWN_SUPPORT = NO diff --git a/Makefile.kmk b/Makefile.kmk index 7b545ab2c4a..790eb2194b4 100644 --- a/Makefile.kmk +++ b/Makefile.kmk @@ -947,7 +947,7 @@ VBOX_CORE_DOXYFILE_INPUT := \ , $(wildcard $(dir)/*.cpp $(dir)/*.c $(dir)/*.m $(dir)/*.mm $(dir)/*.py $(dir)/.asm)) VBOX_CORE_DOXYFILE_INPUT := \ $(VBOX_CORE_DOXYFILE_INPUT_FIRST) \ - $(sort $(filter-out $(VBOX_CORE_DOXYFILE_INPUT_FIRST), $(VBOX_CORE_DOXYFILE_INPUT))) + $(sort $(filter-out $(VBOX_CORE_DOXYFILE_INPUT_FIRST) %/CPUM-armv8.cpp, $(VBOX_CORE_DOXYFILE_INPUT))) VBOX_CORE_DOXYFILE_INPUT += \ $(wildcard $(PATH_ROOT)/src/VBox/VMM/VMMAll/*.h $(PATH_ROOT)/src/VBox/VMM/VMMR3/*.h $(PATH_ROOT)/src/VBox/VMM/VMMR0/*.h ) @@ -972,7 +972,17 @@ $(VBOX_CORE_DOXYFILE_OUTPUT)/Doxyfile.Core: Doxyfile.Core \ "$(PATH_ROOT)/src/VBox/HostServices/SharedOpenGL/crserver/main.c" \ "$(PATH_ROOT)/src/VBox/HostServices/SharedOpenGL/crserverlib/server_main.c" \ "$(PATH_ROOT)/src/VBox/HostServices/SharedOpenGL/unpacker/unpack_arrays.c" \ - "$(PATH_ROOT)/src/VBox/Additions/common/crOpenGL/context.c" + "$(PATH_ROOT)/src/VBox/Additions/common/crOpenGL/context.c" \ + \ + "$(PATH_ROOT)/src/VBox/VMM/include/IEMInternal-armv8.h" \ + "src/VBox/VMM/include/IEMInternal-armv8.h" \ + "$(PATH_ROOT)/src/VBox/VMM/VMMAll/CPUMAllRegs-armv8.cpp" \ + "src/VBox/VMM/VMMAll/CPUMAllRegs-armv8.cpp" \ + "$(PATH_ROOT)/src/VBox/VMM/VMMR3/CPUM-armv8.cpp" \ + "src/VBox/VMM/VMMR3/CPUM-armv8.cpp" \ + "$(PATH_ROOT)/src/VBox/VMM/VMMR3/HM-armv8.cpp" \ + "src/VBox/VMM/VMMR3/HM-armv8.cpp" +## @todo ARMv8: crap is duplicated multiple times or in different sections. Clean up the above *armv8* mess. $(QUIET)$(APPEND) $@.tmp $(QUIET)$(APPEND) $@.tmp 'INPUT = $(foreach x,$(VBOX_CORE_DOXYFILE_INPUT),\$(NLTAB)$(x))' $(QUIET)$(APPEND) $@.tmp @@ -1002,6 +1012,7 @@ $(VBOX_CORE_DOXYFILE_OUTPUT)/docs.Core: $(VBOX_CORE_DOXYFILE_OUTPUT)/Doxyfile.Co -e '/\/src\/VBox\/Additions\/x11\/VBoxClient\/seamless-x11\.h.* warning/b ignore' \ -e '/\/src\/VBox\/HostDrivers\/Support\/win\/SUPR3HardenedMain-win\.cpp.* warning/b ignore' \ -e '/\/src\/VBox\/ValidationKit\/.* warning/b ignore' \ + -e '/WRAPPED_MODULE_SYMBOL_INCLUDE/b ignore' \ \ -e '/unable to resolve link to .dtrace_pops_t./b ignore' \ \ diff --git a/include/VBox/VBoxGuestLib.h b/include/VBox/VBoxGuestLib.h index 865de742e73..92e9c569877 100644 --- a/include/VBox/VBoxGuestLib.h +++ b/include/VBox/VBoxGuestLib.h @@ -214,8 +214,6 @@ DECLR0VBGL(int) VbglR0GRPerform(struct VMMDevRequestHeader *pReq); * Free the generic request memory. * * @param pReq pointer the request structure. - * - * @return VBox status code. */ DECLR0VBGL(void) VbglR0GRFree(struct VMMDevRequestHeader *pReq); diff --git a/include/VBox/com/defs.h b/include/VBox/com/defs.h index 450d1059c61..7db5fcf5d7a 100644 --- a/include/VBox/com/defs.h +++ b/include/VBox/com/defs.h @@ -149,9 +149,9 @@ typedef const OLECHAR *CBSTR; * used to declare the COM attribute setter parameter. Corresponds to either of * the following XIDL definitions: * 
- *  
+ *  <param name="arg" ... dir="in" safearray="yes"/>
  *  ...
- *  
+ *  <attribute name="arg" ... safearray="yes"/>
  *
* * The method implementation should use the com::SafeArray helper class to work @@ -183,10 +183,10 @@ typedef const OLECHAR *CBSTR; * used to declare the COM attribute getter parameter. Corresponds to either of * the following XIDL definitions: * 
- *  
- *  
+ *  <param name="arg" ... dir="out" safearray="yes"/>
+ *  <param name="arg" ... dir="return" safearray="yes"/>
  *  ...
- *  
+ *  <attribute name="arg" ... safearray="yes"/>
  *
* * The method implementation should use the com::SafeArray helper class to work diff --git a/include/VBox/dbg.h b/include/VBox/dbg.h index 04d28774309..cd51ad95e8f 100644 --- a/include/VBox/dbg.h +++ b/include/VBox/dbg.h @@ -1123,7 +1123,6 @@ typedef struct DBGCIO /** * Destroys the given I/O instance. * - * @returns nothing. * @param pIo Pointer to the I/O structure supplied by the I/O provider. */ DECLCALLBACKMEMBER(void, pfnDestroy, (PCDBGCIO pIo)); @@ -1193,7 +1192,6 @@ typedef struct DBGCIO /** * Ready / busy notification. * - * @returns nothing. * @param pIo Pointer to the I/O structure supplied by * the I/O provider. The backend can use this to find it's instance data. * @param fReady Whether it's ready (true) or busy (false). diff --git a/include/VBox/intnetinline.h b/include/VBox/intnetinline.h index 6f2e3004c0b..01583edf316 100644 --- a/include/VBox/intnetinline.h +++ b/include/VBox/intnetinline.h @@ -72,7 +72,6 @@ DECLINLINE(bool) IntNetIsValidFrameType(uint8_t u8Type) * Partly initializes a scatter / gather buffer, leaving the segments to the * caller. * - * @returns Pointer to the start of the frame. * @param pSG Pointer to the scatter / gather structure. * @param cbTotal The total size. * @param cSegs The number of segments. @@ -108,7 +107,6 @@ DECLINLINE(void) IntNetSgInitTempSegs(PINTNETSG pSG, uint32_t cbTotal, unsigned * Partly initializes a scatter / gather buffer w/ GSO, leaving the segments to * the caller. * - * @returns Pointer to the start of the frame. * @param pSG Pointer to the scatter / gather structure. * @param cbTotal The total size. * @param cSegs The number of segments. @@ -146,7 +144,6 @@ DECLINLINE(void) IntNetSgInitTempSegsGso(PINTNETSG pSG, uint32_t cbTotal, unsign /** * Initializes a scatter / gather buffer describing a simple linear buffer. * - * @returns Pointer to the start of the frame. * @param pSG Pointer to the scatter / gather structure. * @param pvFrame Pointer to the frame * @param cbFrame The size of the frame. @@ -162,7 +159,6 @@ DECLINLINE(void) IntNetSgInitTemp(PINTNETSG pSG, void *pvFrame, uint32_t cbFrame /** * Initializes a scatter / gather buffer describing a simple linear buffer. * - * @returns Pointer to the start of the frame. * @param pSG Pointer to the scatter / gather structure. * @param pvFrame Pointer to the frame * @param cbFrame The size of the frame. @@ -547,7 +543,6 @@ DECLINLINE(int) IntNetRingAllocateGsoFrame(PINTNETRINGBUF pRingBuf, uint32_t cbF * * Make sure to commit the frames in the order they've been allocated! * - * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW. * @param pRingBuf The ring buffer. * @param pHdr The frame header returned by * IntNetRingAllocateFrame. @@ -586,7 +581,6 @@ DECLINLINE(void) IntNetRingCommitFrame(PINTNETRINGBUF pRingBuf, PINTNETHDR pHdr) * * Make sure to commit the frames in the order they've been allocated! * - * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW. * @param pRingBuf The ring buffer. * @param pHdr The frame header returned by * IntNetRingAllocateFrame. diff --git a/include/VBox/rawpci.h b/include/VBox/rawpci.h index 50a73ff0cdf..ceb669ee58f 100644 --- a/include/VBox/rawpci.h +++ b/include/VBox/rawpci.h @@ -566,8 +566,6 @@ typedef struct RAWPCIFACTORY /** * Deinitialize per-VM data related to PCI passthrough. * - * @returns VBox status code. - * * @param pFactory Pointer to this structure. * @param pVM The cross context VM structure. * @param pVmData Pointer to PCI data. diff --git a/include/VBox/scsiinline.h b/include/VBox/scsiinline.h index 986338d16b7..233e2e13f45 100644 --- a/include/VBox/scsiinline.h +++ b/include/VBox/scsiinline.h @@ -50,7 +50,6 @@ /** * Converts a given 16bit value to big endian and stores it in the given buffer. * - * @returns nothing. * @param pbBuf The buffer to store the value into. * @param u16Val The value to store. */ @@ -64,7 +63,6 @@ DECLINLINE(void) scsiH2BE_U16(uint8_t *pbBuf, uint16_t u16Val) /** * Converts a given 24bit value to big endian and stores it in the given buffer. * - * @returns nothing. * @param pbBuf The buffer to store the value into. * @param u32Val The value to store. */ @@ -79,7 +77,6 @@ DECLINLINE(void) scsiH2BE_U24(uint8_t *pbBuf, uint32_t u32Val) /** * Converts a given 32bit value to big endian and stores it in the given buffer. * - * @returns nothing. * @param pbBuf The buffer to store the value into. * @param u32Val The value to store. */ @@ -95,7 +92,6 @@ DECLINLINE(void) scsiH2BE_U32(uint8_t *pbBuf, uint32_t u32Val) /** * Converts a given 64bit value to big endian and stores it in the given buffer. * - * @returns nothing. * @param pbBuf The buffer to store the value into. * @param u64Val The value to store. */ @@ -170,7 +166,6 @@ DECLINLINE(uint64_t) scsiBE2H_U64(const uint8_t *pbBuf) * Converts the given LBA number to the MSF (Minutes:Seconds:Frames) format * and stores it in the given buffer. * - * @returns nothing. * @param pbBuf The buffer to store the value into. * @param iLBA The LBA to convert. */ @@ -201,7 +196,6 @@ DECLINLINE(uint32_t) scsiMSF2LBA(const uint8_t *pbBuf) * Copies a given string to the given destination padding all unused space * in the destination with spaces. * - * @returns nothing. * @param pbDst Where to store the string padded with spaces. * @param pbSrc The string to copy. * @param cbSize Size of the destination buffer. @@ -223,7 +217,6 @@ DECLINLINE(void) scsiPadStr(uint8_t *pbDst, const char *pbSrc, uint32_t cbSize) * Copies a given string to the given destination padding all unused space * in the destination with spaces. * - * @returns nothing. * @param pbDst Where to store the string padded with spaces. * @param pbSrc The string to copy. * @param cbSize Size of the destination buffer. diff --git a/include/VBox/vd-ifs-internal.h b/include/VBox/vd-ifs-internal.h index b96780488eb..d30029c851c 100644 --- a/include/VBox/vd-ifs-internal.h +++ b/include/VBox/vd-ifs-internal.h @@ -345,7 +345,6 @@ typedef struct VDINTERFACEIOINT * Releases a metadata transfer handle. * The free space can be used for another transfer. * - * @returns nothing. * @param pvUser The opaque user data passed on container creation. * @param pMetaXfer The metadata transfer handle to release. */ @@ -423,7 +422,6 @@ typedef struct VDINTERFACEIOINT /** * Marks the given number of bytes as completed and continues the I/O context. * - * @returns nothing. * @param pvUser The opaque user data passed on container creation. * @param pIoCtx The I/O context. * @param rcReq Status code the request completed with. diff --git a/include/VBox/vd-image-backend.h b/include/VBox/vd-image-backend.h index 0ab7456ff9f..6557b6cb948 100644 --- a/include/VBox/vd-image-backend.h +++ b/include/VBox/vd-image-backend.h @@ -333,7 +333,6 @@ typedef struct VDIMAGEBACKEND /** * Releases the region list acquired with VDIMAGEBACKEND::pfnQueryRegions() before. * - * @returns nothing. * @param pBackendData Opaque state data for this image. * @param pRegionList The region list to release. */ diff --git a/include/VBox/vd.h b/include/VBox/vd.h index d5b06909034..5e78ac1ffe9 100644 --- a/include/VBox/vd.h +++ b/include/VBox/vd.h @@ -1126,7 +1126,6 @@ VBOXDDU_DECL(int) VDQueryRegions(PVDISK pDisk, unsigned nImage, uint32_t fFlags, /** * Frees a region list previously queried with VDQueryRegions(). * - * @return nothing. * @param pRegionList The region list to free. */ VBOXDDU_DECL(void) VDRegionListFree(PVDREGIONLIST pRegionList); @@ -1428,7 +1427,6 @@ VBOXDDU_DECL(int) VDIfTcpNetInstDefaultCreate(PVDIFINST phTcpNetInst, PVDINTERFA /** * Destroys the given VD TCP/IP interface instance. * - * @returns nothing. * @param hTcpNetInst The TCP/IP interface instance handle. */ VBOXDDU_DECL(void) VDIfTcpNetInstDefaultDestroy(VDIFINST hTcpNetInst); @@ -1725,7 +1723,6 @@ typedef VDIOREQTYPE *PVDIOREQTYPE; /** * I/O queue request completion callback. * - * @returns nothing. * @param hVdIoQueue The VD I/O queue handle. * @param pDisk The disk the queue is attached to. * @param hVdIoReq The VD I/O request which completed. diff --git a/include/VBox/vmm/pdmblkcache.h b/include/VBox/vmm/pdmblkcache.h index d08ebbbbd54..72b9cfe9f49 100644 --- a/include/VBox/vmm/pdmblkcache.h +++ b/include/VBox/vmm/pdmblkcache.h @@ -304,7 +304,6 @@ VMMR3DECL(int) PDMR3BlkCacheRetainInt(PVM pVM, void *pvUser, PPPDMBLKCACHE ppBlk /** * Releases a block cache handle. * - * @returns nothing. * @param pBlkCache Block cache handle. */ VMMR3DECL(void) PDMR3BlkCacheRelease(PPDMBLKCACHE pBlkCache); @@ -312,7 +311,6 @@ VMMR3DECL(void) PDMR3BlkCacheRelease(PPDMBLKCACHE pBlkCache); /** * Releases all block cache handles for a device instance. * - * @returns nothing. * @param pVM The cross context VM structure. * @param pDevIns The device instance. */ @@ -321,7 +319,6 @@ VMMR3DECL(void) PDMR3BlkCacheReleaseDevice(PVM pVM, PPDMDEVINS pDevIns); /** * Releases all block cache handles for a driver instance. * - * @returns nothing. * @param pVM The cross context VM structure. * @param pDrvIns The driver instance. */ @@ -330,7 +327,6 @@ VMMR3DECL(void) PDMR3BlkCacheReleaseDriver(PVM pVM, PPDMDRVINS pDrvIns); /** * Releases all block cache handles for a USB device instance. * - * @returns nothing. * @param pVM The cross context VM structure. * @param pUsbIns The USB device instance. */ @@ -387,7 +383,6 @@ VMMR3DECL(int) PDMR3BlkCacheDiscard(PPDMBLKCACHE pBlkCache, PCRTRANGE paRanges, /** * Notify the cache of a complete I/O transfer. * - * @returns nothing. * @param pBlkCache The cache instance. * @param hIoXfer The I/O transfer handle which completed. * @param rcIoXfer The status code of the completed request. diff --git a/include/VBox/vmm/pdmdev.h b/include/VBox/vmm/pdmdev.h index 5cc98cade81..f895eb86f5c 100644 --- a/include/VBox/vmm/pdmdev.h +++ b/include/VBox/vmm/pdmdev.h @@ -133,7 +133,6 @@ typedef FNPDMDEVRELOCATE *PFNPDMDEVRELOCATE; /** * Power On notification. * - * @returns VBox status. * @param pDevIns The device instance data. * * @remarks Caller enters the device critical section. @@ -145,7 +144,6 @@ typedef FNPDMDEVPOWERON *PFNPDMDEVPOWERON; /** * Reset notification. * - * @returns VBox status. * @param pDevIns The device instance data. * * @remarks Caller enters the device critical section. @@ -160,7 +158,6 @@ typedef FNPDMDEVRESET *PFNPDMDEVRESET; * This is mainly for emulating the 286 style protected mode exits, in which * most devices should remain in their current state. * - * @returns VBox status. * @param pDevIns The device instance data. * @param fFlags PDMVMRESET_F_XXX (only bits relevant to soft resets). * @@ -195,7 +192,6 @@ typedef FNPDMDEVSOFTRESET *PFNPDMDEVSOFTRESET; /** * Suspend notification. * - * @returns VBox status. * @param pDevIns The device instance data. * @thread EMT(0) * @@ -208,7 +204,6 @@ typedef FNPDMDEVSUSPEND *PFNPDMDEVSUSPEND; /** * Resume notification. * - * @returns VBox status. * @param pDevIns The device instance data. * * @remarks Caller enters the device critical section. @@ -3612,7 +3607,6 @@ typedef struct PDMDEVHLPR3 * Same as pfnSTAMRegister except that the name is specified in a * RTStrPrintfV like fashion. * - * @returns VBox status. * @param pDevIns Device instance of the DMA. * @param pvSample Pointer to the sample. * @param enmType Sample type. This indicates what pvSample is @@ -7714,7 +7708,6 @@ DECLINLINE(void) PDMDevHlpSTAMRegister(PPDMDEVINS pDevIns, void *pvSample, STAMT * Same as pfnSTAMRegister except that the name is specified in a * RTStrPrintf like fashion. * - * @returns VBox status. * @param pDevIns Device instance of the DMA. * @param pvSample Pointer to the sample. * @param enmType Sample type. This indicates what pvSample is diff --git a/include/VBox/vmm/pdmdrv.h b/include/VBox/vmm/pdmdrv.h index fea9db4bcc4..ceafa87ac4a 100644 --- a/include/VBox/vmm/pdmdrv.h +++ b/include/VBox/vmm/pdmdrv.h @@ -154,7 +154,6 @@ typedef FNPDMDRVPOWERON *PFNPDMDRVPOWERON; /** * Reset notification. * - * @returns VBox status. * @param pDrvIns The driver instance data. */ typedef DECLCALLBACKTYPE(void, FNPDMDRVRESET,(PPDMDRVINS pDrvIns)); @@ -164,7 +163,6 @@ typedef FNPDMDRVRESET *PFNPDMDRVRESET; /** * Suspend notification. * - * @returns VBox status. * @param pDrvIns The driver instance data. */ typedef DECLCALLBACKTYPE(void, FNPDMDRVSUSPEND,(PPDMDRVINS pDrvIns)); @@ -174,7 +172,6 @@ typedef FNPDMDRVSUSPEND *PFNPDMDRVSUSPEND; /** * Resume notification. * - * @returns VBox status. * @param pDrvIns The driver instance data. */ typedef DECLCALLBACKTYPE(void, FNPDMDRVRESUME,(PPDMDRVINS pDrvIns)); diff --git a/include/VBox/vmm/pdmifs.h b/include/VBox/vmm/pdmifs.h index d55c0c8f790..c4eaeb1fcaa 100644 --- a/include/VBox/vmm/pdmifs.h +++ b/include/VBox/vmm/pdmifs.h @@ -1599,7 +1599,6 @@ typedef struct PDMIVMMDEVPORT /** * Notify the driver about a VBVA status change. * - * @returns Nothing. Because it is informational callback. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param fEnabled Current VBVA status. */ diff --git a/include/VBox/vmm/pdmsrv.h b/include/VBox/vmm/pdmsrv.h index b3db46ba305..2b693f2c8e9 100644 --- a/include/VBox/vmm/pdmsrv.h +++ b/include/VBox/vmm/pdmsrv.h @@ -90,7 +90,6 @@ typedef FNPDMSRVPOWERON *PFNPDMSRVPOWERON; /** * Reset notification. * - * @returns VBox status. * @param pSrvIns The service instance data. */ typedef DECLCALLBACKTYPE(void, FNPDMSRVRESET,(PPDMSRVINS pSrvIns)); @@ -100,7 +99,6 @@ typedef FNPDMSRVRESET *PFNPDMSRVRESET; /** * Suspend notification. * - * @returns VBox status. * @param pSrvIns The service instance data. */ typedef DECLCALLBACKTYPE(void, FNPDMSRVSUSPEND,(PPDMSRVINS pSrvIns)); @@ -110,7 +108,6 @@ typedef FNPDMSRVSUSPEND *PFNPDMSRVSUSPEND; /** * Resume notification. * - * @returns VBox status. * @param pSrvIns The service instance data. */ typedef DECLCALLBACKTYPE(void, FNPDMSRVRESUME,(PPDMSRVINS pSrvIns)); diff --git a/include/VBox/vmm/pdmstorageifs.h b/include/VBox/vmm/pdmstorageifs.h index 098641edd87..8fd23a9e06b 100644 --- a/include/VBox/vmm/pdmstorageifs.h +++ b/include/VBox/vmm/pdmstorageifs.h @@ -742,7 +742,6 @@ typedef struct PDMIMEDIAEXPORT /** * Notify the request owner about a state change for the request. * - * @returns nothing. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param hIoReq The I/O request handle. * @param pvIoReqAlloc The allocator specific memory for this request. @@ -754,7 +753,6 @@ typedef struct PDMIMEDIAEXPORT /** * Informs the device that the underlying medium was ejected. * - * @returns nothing. * @param pInterface Pointer to the interface structure containing the called function pointer. */ DECLR3CALLBACKMEMBER(void, pfnMediumEjected, (PPDMIMEDIAEXPORT pInterface)); @@ -786,7 +784,6 @@ typedef struct PDMIMEDIAEX /** * Notifies the driver below that the device received a suspend notification. * - * @returns nothing. * @param pInterface Pointer to the interface structure containing the called function pointer. * * @note this is required because the PDM drivers in the storage area usually get their suspend notification diff --git a/include/VBox/vmm/pdmusb.h b/include/VBox/vmm/pdmusb.h index 4343715fd66..0dd3a7f3cc6 100644 --- a/include/VBox/vmm/pdmusb.h +++ b/include/VBox/vmm/pdmusb.h @@ -202,7 +202,7 @@ typedef struct PDMUSBREG * This can be done to do communication with other devices and other * initialization which requires everything to be in place. * - * @returns VBOX status code. + * @returns VBox status code. * @param pUsbIns The USB device instance data. * @remarks Optional. * @remarks Not called when hotplugged. @@ -212,7 +212,6 @@ typedef struct PDMUSBREG /** * VM Power On notification. * - * @returns VBox status. * @param pUsbIns The USB device instance data. * @remarks Optional. */ @@ -221,7 +220,6 @@ typedef struct PDMUSBREG /** * VM Reset notification. * - * @returns VBox status. * @param pUsbIns The USB device instance data. * @remarks Optional. */ @@ -230,7 +228,6 @@ typedef struct PDMUSBREG /** * VM Suspend notification. * - * @returns VBox status. * @param pUsbIns The USB device instance data. * @remarks Optional. */ @@ -242,7 +239,6 @@ typedef struct PDMUSBREG * This is not called when the device is hotplugged device, instead * pfnHotPlugged will be called. * - * @returns VBox status. * @param pUsbIns The USB device instance data. * @remarks Optional. */ @@ -265,7 +261,6 @@ typedef struct PDMUSBREG * This can be used to do tasks normally assigned to pfnInitComplete and/or * pfnVMPowerOn. There will not be a call to pfnVMResume following this. * - * @returns VBox status. * @param pUsbIns The USB device instance data. * @remarks Optional. */ @@ -276,7 +271,6 @@ typedef struct PDMUSBREG * * This can be used to do tasks normally assigned to pfnVMSuspend and/or pfnVMPowerOff. * - * @returns VBox status. * @param pUsbIns The USB device instance data. * @remarks Optional. */ @@ -312,7 +306,7 @@ typedef struct PDMUSBREG /** * Query the base interface of a logical unit. * - * @returns VBOX status code. + * @returns VBox status code. * @param pUsbIns The USB device instance data. * @param iLUN The logicial unit to query. * @param ppBase Where to store the pointer to the base interface of the LUN. @@ -760,7 +754,6 @@ typedef struct PDMUSBHLP * * Use the PDMUsbHlpSTAMRegister wrapper. * - * @returns VBox status. * @param pUsbIns The USB device instance. * @param pvSample Pointer to the sample. * @param enmType Sample type. This indicates what pvSample is pointing at. diff --git a/include/VBox/vusb.h b/include/VBox/vusb.h index e0ea9b5202b..4a3f6d0950c 100644 --- a/include/VBox/vusb.h +++ b/include/VBox/vusb.h @@ -721,7 +721,6 @@ typedef struct VUSBIROOTHUBPORT * Informs the callee about a change in the frame rate due to too many idle cycles or * when seeing activity after some idle time. * - * @returns nothing. * @param pInterface Pointer to this structure. * @param u32FrameRate The new frame rate. */ @@ -836,10 +835,6 @@ typedef struct VUSBIROOTHUBCONNECTOR * thus there is no return code or input or anything from this function * except for potential state changes elsewhere. * - * @returns VINF_SUCCESS if no URBs are pending upon return. - * @returns VERR_TIMEOUT if one or more URBs are still in flight upon returning. - * @returns Other VBox status code. - * * @param pInterface Pointer to this struct. * @param uPort Port of the device to reap URBs on. * @param cMillies Number of milliseconds to poll for completion. diff --git a/include/iprt/armv8.h b/include/iprt/armv8.h index d2791eea831..7148b341b28 100644 --- a/include/iprt/armv8.h +++ b/include/iprt/armv8.h @@ -159,6 +159,7 @@ #define ARMV8_AARCH64_SYSREG_MASK ( ARMV8_AARCH64_SYSREG_OP0_MASK | ARMV8_AARCH64_SYSREG_OP1_MASK \ | ARMV8_AARCH64_SYSREG_CRN_MASK | ARMV8_AARCH64_SYSREG_CRN_MASK \ | ARMV8_AARCH64_SYSREG_OP2_MASK) +/** @} */ /** @name Mapping of op0:op1:CRn:CRm:op2 to a system register ID. This is * IPRT specific and not part of the ARMv8 specification. */ diff --git a/include/iprt/asm-amd64-x86.h b/include/iprt/asm-amd64-x86.h index 822011104f7..194234fd900 100644 --- a/include/iprt/asm-amd64-x86.h +++ b/include/iprt/asm-amd64-x86.h @@ -2189,7 +2189,6 @@ DECLINLINE(uint64_t) ASMRdMsr(uint32_t uRegister) /** * Writes a machine specific register. * - * @returns Register content. * @param uRegister Register to write to. * @param u64Val Value to write. */ @@ -2263,7 +2262,6 @@ DECLINLINE(uint64_t) ASMRdMsrEx(uint32_t uRegister, RTCCUINTXREG uXDI) /** * Writes a machine specific register, extended version (for AMD). * - * @returns Register content. * @param uRegister Register to write to. * @param uXDI RDI/EDI value. * @param u64Val Value to write. diff --git a/include/iprt/asm.h b/include/iprt/asm.h index 34d07685176..19cf2bcc173 100644 --- a/include/iprt/asm.h +++ b/include/iprt/asm.h @@ -3708,7 +3708,6 @@ DECLINLINE(void) ASMAtomicUoWriteS64(volatile int64_t RT_FAR *pi64, int64_t i64) /** * Atomically writes a size_t value, ordered. * - * @returns nothing. * @param pcb Pointer to the size_t variable to write. * @param cb The value to assign to *pcb. */ @@ -3730,7 +3729,6 @@ DECLINLINE(void) ASMAtomicWriteZ(volatile size_t RT_FAR *pcb, size_t cb) RT_NOTH /** * Atomically writes a size_t value, unordered. * - * @returns nothing. * @param pcb Pointer to the size_t variable to write. * @param cb The value to assign to *pcb. */ diff --git a/include/iprt/cpp/restclient.h b/include/iprt/cpp/restclient.h index 23c53855ac5..56a9a892665 100644 --- a/include/iprt/cpp/restclient.h +++ b/include/iprt/cpp/restclient.h @@ -531,8 +531,6 @@ public: /** * Called after status, headers and body all have been presented. - * - * @returns IPRT status code. */ virtual void receiveFinal() RT_NOEXCEPT; diff --git a/include/iprt/dvm.h b/include/iprt/dvm.h index 923511a66e6..7eed592a004 100644 --- a/include/iprt/dvm.h +++ b/include/iprt/dvm.h @@ -389,7 +389,6 @@ RTDECL(uint32_t) RTDvmVolumeRelease(RTDVMVOLUME hVol); * Sets the callback to query the block allocation status for a volume. * This overwrites any other callback set previously. * - * @returns nothing. * @param hVol The volume handle. * @param pfnQueryBlockStatus The callback to set. Can be NULL to disable * a previous callback. diff --git a/include/iprt/ioqueue.h b/include/iprt/ioqueue.h index 43b1c908d63..52aee063dfc 100644 --- a/include/iprt/ioqueue.h +++ b/include/iprt/ioqueue.h @@ -139,7 +139,6 @@ typedef struct RTIOQUEUEPROVVTABLE * Destroys the provider specific parts of the I/O queue and frees all * associated resources. * - * @returns nothing. * @param hIoQueueProv The I/O queue provider instance to destroy. */ DECLCALLBACKMEMBER(void, pfnQueueDestroy,(RTIOQUEUEPROV hIoQueueProv)); diff --git a/include/iprt/ldr.h b/include/iprt/ldr.h index 249e18b33bc..bcce248168b 100644 --- a/include/iprt/ldr.h +++ b/include/iprt/ldr.h @@ -528,7 +528,6 @@ typedef FNRTLDRRDRMEMREAD *PFNRTLDRRDRMEMREAD; * Called to when the module is unloaded (or done loading) to release resources * associated with it (@a pvUser). * - * @returns IPRT status code * @param pvUser The user parameter. * @param cbImage The image size. */ diff --git a/include/iprt/list-off32.h b/include/iprt/list-off32.h index 76fdfde9c97..9c2fabbbc6a 100644 --- a/include/iprt/list-off32.h +++ b/include/iprt/list-off32.h @@ -484,7 +484,6 @@ DECLINLINE(void) RTListOff32Move(PRTLISTOFF32NODE pListDst, PRTLISTOFF32NODE pLi /** * List concatenation. * - * @returns nothing. * @param pListDst The destination list. * @param pListSrc The source list to concatenate. */ diff --git a/include/iprt/list.h b/include/iprt/list.h index f5dba1a3d94..e515f5e8d9f 100644 --- a/include/iprt/list.h +++ b/include/iprt/list.h @@ -532,7 +532,6 @@ DECLINLINE(void) RTListMove(PRTLISTNODE pListDst, PRTLISTNODE pListSrc) /** * List concatenation. * - * @returns nothing. * @param pListDst The destination list. * @param pListSrc The source list to concatenate. */ diff --git a/include/iprt/memsafer.h b/include/iprt/memsafer.h index 2143513084e..10a649720fb 100644 --- a/include/iprt/memsafer.h +++ b/include/iprt/memsafer.h @@ -244,7 +244,6 @@ RTDECL(void *) RTMemSaferReallocZTag(size_t cbOld, void *pvOld, size_t cbNew, co * Before freeing the allocated memory, it will be wiped clean using * RTMemWipeThorougly. * - * @returns Pointer to the allocated memory. * @param pv The allocation. * @param cb The allocation size. */ diff --git a/include/iprt/sg.h b/include/iprt/sg.h index ce88e3585f1..31b27064ce5 100644 --- a/include/iprt/sg.h +++ b/include/iprt/sg.h @@ -195,7 +195,6 @@ DECLINLINE(bool) RTSgBufIsAtStartOfSegment(PCRTSGBUF pSgBuf) /** * Initialize a S/G buffer structure. * - * @returns nothing. * @param pSgBuf Pointer to the S/G buffer to initialize. * @param paSegs Pointer to the start of the segment array. * @param cSegs Number of segments in the array. @@ -209,7 +208,6 @@ RTDECL(void) RTSgBufInit(PRTSGBUF pSgBuf, PCRTSGSEG paSegs, size_t cSegs); /** * Resets the internal buffer position of the S/G buffer to the beginning. * - * @returns nothing. * @param pSgBuf The S/G buffer to reset. */ RTDECL(void) RTSgBufReset(PRTSGBUF pSgBuf); @@ -217,7 +215,6 @@ RTDECL(void) RTSgBufReset(PRTSGBUF pSgBuf); /** * Clones a given S/G buffer. * - * @returns nothing. * @param pSgBufNew The new S/G buffer to clone to. * @param pSgBufOld The source S/G buffer to clone from. * diff --git a/include/iprt/string.h b/include/iprt/string.h index 8ee955851cf..c7b6393471a 100644 --- a/include/iprt/string.h +++ b/include/iprt/string.h @@ -323,7 +323,6 @@ RTR3DECL(int) RTStrConsoleCPToUtf8Tag(char **ppszString, const char *pszString, /** * Free string allocated by any of the non-UCS-2 string functions. * - * @returns iprt status code. * @param pszString Pointer to buffer with string to free. * NULL is accepted. */ diff --git a/include/iprt/thread.h b/include/iprt/thread.h index 2b3296216c4..7d9257ec4cb 100644 --- a/include/iprt/thread.h +++ b/include/iprt/thread.h @@ -687,7 +687,6 @@ typedef enum RTTHREADCTXEVENT * Do NOT acquire locks, sleep or yield the thread for instance. IRQ safe * spinlocks are fine though. * - * @returns IPRT status code. * @param enmEvent The thread-context event. Please quitely ignore unknown * events, we may add more (thread exit, ++) later. * @param pvUser User argument. diff --git a/include/iprt/time.h b/include/iprt/time.h index a904b5fa448..3042b216ce3 100644 --- a/include/iprt/time.h +++ b/include/iprt/time.h @@ -346,7 +346,6 @@ DECLINLINE(PRTTIMESPEC) RTTimeSpecSubSeconds(PRTTIMESPEC pTime, int64_t i64Secon /** * Gives the time in seconds and nanoseconds. * - * @returns pTime. * @param pTime The time spec to interpret. * @param *pi32Seconds Where to store the time period in seconds. * @param *pi32Nano Where to store the time period in nanoseconds. diff --git a/include/iprt/tracelog.h b/include/iprt/tracelog.h index 77484ddf988..9c45ea7812e 100644 --- a/include/iprt/tracelog.h +++ b/include/iprt/tracelog.h @@ -601,7 +601,6 @@ RTDECL(int) RTTraceLogRdrEvtMapToStruct(RTTRACELOGRDR hTraceLogRdr, uint32_t fFl /** * Frees all resources of the given array of event headers as allocated by RTTraceLogRdrEvtMapToStruct(). * - * @returns nothing. * @param paEvtHdr Pointer to the array of events as returned by RTTraceLogRdrEvtMapToStruct(). * @param cEvts Number of events as returned by RTTraceLogRdrEvtMapToStruct(). */ @@ -611,7 +610,6 @@ RTDECL(void) RTTraceLogRdrEvtMapFree(PCRTTRACELOGRDREVTHDR paEvtHdr, uint32_t cE /** * Frees a previously created iterator. * - * @returns nothing. * @param hIt The iterator handle to free. */ RTDECL(void) RTTraceLogRdrIteratorFree(RTTRACELOGRDRIT hIt); diff --git a/include/iprt/utf16.h b/include/iprt/utf16.h index b333ac66c3b..e6d3ac60406 100644 --- a/include/iprt/utf16.h +++ b/include/iprt/utf16.h @@ -171,7 +171,6 @@ RTDECL(int) RTUtf16ReallocTag(PRTUTF16 *ppwsz, size_t cbNew, const char *pszTag) * Free a UTF-16 string allocated by RTStrToUtf16(), RTStrToUtf16Ex(), * RTLatin1ToUtf16(), RTLatin1ToUtf16Ex(), RTUtf16Dup() or RTUtf16DupEx(). * - * @returns iprt status code. * @param pwszString The UTF-16 string to free. NULL is accepted. */ RTDECL(void) RTUtf16Free(PRTUTF16 pwszString); diff --git a/src/VBox/Additions/WINNT/Mouse/NT5/VBoxMFInternal.cpp b/src/VBox/Additions/WINNT/Mouse/NT5/VBoxMFInternal.cpp index a156e2acf5b..61fd507c184 100644 --- a/src/VBox/Additions/WINNT/Mouse/NT5/VBoxMFInternal.cpp +++ b/src/VBox/Additions/WINNT/Mouse/NT5/VBoxMFInternal.cpp @@ -134,8 +134,6 @@ static bool vboxNewProtLazyRegister(void) /** * This is called when the last device instance is destroyed. - * - * @returns NT status. */ static void vboxNewProtTerm(void) { diff --git a/src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp b/src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp index 4cc021bb615..e2ce33837a1 100644 --- a/src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp +++ b/src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp @@ -433,9 +433,8 @@ static bool vboxTrayHandleGlobalMessages(PVBOXGLOBALMESSAGE pTable, UINT uMsg, } /** - * Release logger callback. + * Header/footer callback for the release logger. * - * @return IPRT status code. * @param pLoggerRelease * @param enmPhase * @param pfnLog diff --git a/src/VBox/Additions/common/VBoxService/VBoxServiceTimeSync.cpp b/src/VBox/Additions/common/VBoxService/VBoxServiceTimeSync.cpp index 4b45638e7cd..e3e4491e2ae 100644 --- a/src/VBox/Additions/common/VBoxService/VBoxServiceTimeSync.cpp +++ b/src/VBox/Additions/common/VBoxService/VBoxServiceTimeSync.cpp @@ -504,8 +504,6 @@ static void vgsvcTimeSyncCancelAdjust(void) /** * Set the wall clock to compensate for drift. * - * @returns true on success, false on failure. - * * @param pDrift The time adjustment. */ static void vgsvcTimeSyncSet(PCRTTIMESPEC pDrift) diff --git a/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp b/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp index 3fa8b190be5..6a8e371e556 100644 --- a/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp +++ b/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp @@ -243,7 +243,6 @@ static void vgsvcToolboxPrintStrmHeader(const char *pszToolName, uint32_t uVersi /** * Prints a standardized termination sequence indicating that the * parseable stream just ended. - * */ static void vgsvcToolboxPrintStrmTermination() { @@ -267,7 +266,6 @@ static int vgsvcToolboxParseMode(const char *pcszMode, RTFMODE *pfMode) /** * Destroys a path buffer list. * - * @return IPRT status code. * @param pList Pointer to list to destroy. */ static void vgsvcToolboxPathBufDestroy(PRTLISTNODE pList) diff --git a/src/VBox/Additions/common/pam/pam_vbox.cpp b/src/VBox/Additions/common/pam/pam_vbox.cpp index 786bafb3657..f300ace55ac 100644 --- a/src/VBox/Additions/common/pam/pam_vbox.cpp +++ b/src/VBox/Additions/common/pam/pam_vbox.cpp @@ -311,7 +311,6 @@ static int pam_vbox_init(pam_handle_t *hPAM) /** * Shuts down pam_vbox. * - * @return IPRT status code. * @param hPAM PAM handle. */ static void pam_vbox_shutdown(pam_handle_t *hPAM) diff --git a/src/VBox/Additions/linux/sharedfolders/dirops.c b/src/VBox/Additions/linux/sharedfolders/dirops.c index d4d777e1c4b..861e23f85f8 100644 --- a/src/VBox/Additions/linux/sharedfolders/dirops.c +++ b/src/VBox/Additions/linux/sharedfolders/dirops.c @@ -1045,9 +1045,9 @@ static int vbsf_inode_atomic_open(struct inode *pDirInode, struct dentry *dentry * @param excl Possible O_EXCL... * @returns 0 on success, Linux error code otherwise */ -#if RTLNX_VER_MIN(6,3,0) +#if RTLNX_VER_MIN(6,3,0) || defined(DOXYGEN_RUNNING) static int vbsf_inode_create(struct mnt_idmap *idmap, struct inode *parent, struct dentry *dentry, umode_t mode, bool excl) -#elif RTLNX_VER_MIN(5,12,0) || defined(DOXYGEN_RUNNING) +#elif RTLNX_VER_MIN(5,12,0) static int vbsf_inode_create(struct user_namespace *ns, struct inode *parent, struct dentry *dentry, umode_t mode, bool excl) #elif RTLNX_VER_MIN(3,6,0) static int vbsf_inode_create(struct inode *parent, struct dentry *dentry, umode_t mode, bool excl) @@ -1087,9 +1087,9 @@ static int vbsf_inode_create(struct inode *parent, struct dentry *dentry, int mo * @param mode file mode * @returns 0 on success, Linux error code otherwise */ -#if RTLNX_VER_MIN(6,3,0) +#if RTLNX_VER_MIN(6,3,0) || defined(DOXYGEN_RUNNING) static int vbsf_inode_mkdir(struct mnt_idmap *idmap, struct inode *parent, struct dentry *dentry, umode_t mode) -#elif RTLNX_VER_MIN(5,12,0) || defined(DOXYGEN_RUNNING) +#elif RTLNX_VER_MIN(5,12,0) static int vbsf_inode_mkdir(struct user_namespace *ns, struct inode *parent, struct dentry *dentry, umode_t mode) #elif RTLNX_VER_MIN(3,3,0) static int vbsf_inode_mkdir(struct inode *parent, struct dentry *dentry, umode_t mode) @@ -1204,11 +1204,11 @@ static int vbsf_inode_rmdir(struct inode *parent, struct dentry *dentry) * @param flags flags * @returns 0 on success, Linux error code otherwise */ -#if RTLNX_VER_MIN(6,3,0) +#if RTLNX_VER_MIN(6,3,0) || defined(DOXYGEN_RUNNING) static int vbsf_inode_rename(struct mnt_idmap *idmap, struct inode *old_parent, struct dentry *old_dentry, struct inode *new_parent, struct dentry *new_dentry, unsigned flags) -#elif RTLNX_VER_MIN(5,12,0) || defined(DOXYGEN_RUNNING) +#elif RTLNX_VER_MIN(5,12,0) static int vbsf_inode_rename(struct user_namespace *ns, struct inode *old_parent, struct dentry *old_dentry, struct inode *new_parent, struct dentry *new_dentry, unsigned flags) diff --git a/src/VBox/Additions/x11/VBoxClient/seamless-x11.cpp b/src/VBox/Additions/x11/VBoxClient/seamless-x11.cpp index afb09541329..e85cf3dc485 100644 --- a/src/VBox/Additions/x11/VBoxClient/seamless-x11.cpp +++ b/src/VBox/Additions/x11/VBoxClient/seamless-x11.cpp @@ -58,7 +58,7 @@ * Internal Functions * *********************************************************************************************************************************/ -static unsigned char *XXGetProperty (Display *aDpy, Window aWnd, Atom aPropType, +static unsigned char *XXGetProperty(Display *aDpy, Window aWnd, Atom aPropType, const char *aPropName, unsigned long *nItems) { LogRelFlowFuncEnter(); @@ -84,12 +84,6 @@ static unsigned char *XXGetProperty (Display *aDpy, Window aWnd, Atom aPropType, return propVal; } -/** - * Initialise the guest and ensure that it is capable of handling seamless mode - * - * @param pHostCallback host callback. - * @returns true if it can handle seamless, false otherwise - */ int VBClX11SeamlessMonitor::init(PFNSENDREGIONUPDATE pHostCallback) { int rc = VINF_SUCCESS; diff --git a/src/VBox/Additions/x11/vboxvideo/vbva.c b/src/VBox/Additions/x11/vboxvideo/vbva.c index 8ee05593a38..10395d64b6b 100644 --- a/src/VBox/Additions/x11/vboxvideo/vbva.c +++ b/src/VBox/Additions/x11/vboxvideo/vbva.c @@ -240,7 +240,6 @@ vboxEnableVbva(ScrnInfoPtr pScrn) * information. This function is intended to be called when an X * virtual terminal is disabled, or the X server is terminated. * - * @returns TRUE for success, FALSE for failure * @param pScrn Pointer to a structure describing the X screen in use */ void diff --git a/src/VBox/Debugger/DBGCCmdWorkers.cpp b/src/VBox/Debugger/DBGCCmdWorkers.cpp index 179ba87ebd6..480c2905145 100644 --- a/src/VBox/Debugger/DBGCCmdWorkers.cpp +++ b/src/VBox/Debugger/DBGCCmdWorkers.cpp @@ -273,7 +273,6 @@ DECLHIDDEN(PDBGCTFLOW) dbgcFlowTraceModGet(PDBGC pDbgc, uint32_t iTraceFlowMod) /** * Inserts the given trace flow module into the list. * - * @returns nothing. * @param pDbgc The DBGC instance. * @param pTraceFlow The trace flow module. */ diff --git a/src/VBox/Debugger/DBGCEmulateCodeView.cpp b/src/VBox/Debugger/DBGCEmulateCodeView.cpp index f667c72e9d5..79c355d032e 100644 --- a/src/VBox/Debugger/DBGCEmulateCodeView.cpp +++ b/src/VBox/Debugger/DBGCEmulateCodeView.cpp @@ -1565,7 +1565,6 @@ static bool dbgcCmdUnassembleCfgAddrLower(PDBGFADDRESS pAddr1, PDBGFADDRESS pAdd * Calculates the size required for the given basic block including the * 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. */ @@ -1609,7 +1608,6 @@ static void dbgcCmdUnassembleCfgDumpCalcBbSize(DBGFFLOWBB hFlowBb, PDBGCFLOWBBDU /** * Dumps a top or bottom boundary line. * - * @returns nothing. * @param hScreen The screen to draw to. * @param uStartX Where to start drawing the boundary. * @param uStartY Y coordinate. @@ -1629,7 +1627,6 @@ static void dbgcCmdUnassembleCfgDumpBbBoundary(DBGCSCREEN hScreen, uint32_t uSta /** * 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. * @param uStartY Y coordinate. @@ -1649,7 +1646,6 @@ static void dbgcCmdUnassembleCfgDumpBbSpacing(DBGCSCREEN hScreen, uint32_t uStar /** * Writes a given text to the screen. * - * @returns nothing. * @param hScreen The screen to draw to. * @param uStartX Where to start drawing the line. * @param uStartY Y coordinate. @@ -1672,7 +1668,6 @@ static void dbgcCmdUnassembleCfgDumpBbText(DBGCSCREEN hScreen, uint32_t uStartX, /** * 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. */ @@ -1719,7 +1714,6 @@ static void dbgcCmdUnassembleCfgDumpBb(PDBGCFLOWBBDUMP pDumpBb, DBGCSCREEN hScre /** * 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. */ @@ -5808,7 +5802,6 @@ static DECLCALLBACK(int) dbgcCmdEventCtrlReset(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdH /** * Used during DBGC initialization to configure events with defaults. * - * @returns VBox status code. * @param pDbgc The DBGC instance. */ void dbgcEventInit(PDBGC pDbgc) diff --git a/src/VBox/Debugger/DBGCGdbRemoteStub.cpp b/src/VBox/Debugger/DBGCGdbRemoteStub.cpp index 50a6164efcb..ac8e3c05d5c 100644 --- a/src/VBox/Debugger/DBGCGdbRemoteStub.cpp +++ b/src/VBox/Debugger/DBGCGdbRemoteStub.cpp @@ -354,7 +354,6 @@ static int dbgcGdbStubTpRegister(PGDBSTUBCTX pThis, GDBSTUBTPTYPE enmTpType, uin /** * Deregisters the given trace point (needs to be unregistered from DBGF by the caller before). * - * @returns nothing. * @param pTp The trace point to deregister. */ static void dbgcGdbStubTpDeregister(PGDBSTUBTP pTp) @@ -2133,7 +2132,6 @@ static int dbgcGdbStubCtxPktProcess(PGDBSTUBCTX pThis) /** * Resets the packet buffer. * - * @returns nothing. * @param pThis The GDB stub context. */ static void dbgcGdbStubCtxPktBufReset(PGDBSTUBCTX pThis) @@ -2147,7 +2145,6 @@ static void dbgcGdbStubCtxPktBufReset(PGDBSTUBCTX pThis) /** * Resets the given GDB stub context to the initial state. * - * @returns nothing. * @param pThis The GDB stub context. */ static void dbgcGdbStubCtxReset(PGDBSTUBCTX pThis) @@ -2776,7 +2773,6 @@ static int dbgcGdbStubCtxCreate(PPGDBSTUBCTX ppGdbStubCtx, PCDBGCIO pIo, unsigne /** * Destroys the given GDB stub context. * - * @returns nothing. * @param pThis The GDB stub context to destroy. */ static void dbgcGdbStubDestroy(PGDBSTUBCTX pThis) diff --git a/src/VBox/Debugger/DBGCIo.cpp b/src/VBox/Debugger/DBGCIo.cpp index 4846fc129ed..0be59bef47e 100644 --- a/src/VBox/Debugger/DBGCIo.cpp +++ b/src/VBox/Debugger/DBGCIo.cpp @@ -159,7 +159,6 @@ static const DBGCSTUB g_aStubs[] = /** * 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. */ static void dbgcIoDestroy(PDBGCIOINT pDbgcIo) diff --git a/src/VBox/Debugger/DBGCIoProvInternal.h b/src/VBox/Debugger/DBGCIoProvInternal.h index 0c53f943cc8..fb6895a81c6 100644 --- a/src/VBox/Debugger/DBGCIoProvInternal.h +++ b/src/VBox/Debugger/DBGCIoProvInternal.h @@ -72,7 +72,6 @@ typedef struct DBGCIOPROVREG /** * Destroys the given I/O provider instance. * - * @returns nothing. * @param hDbgcIoProv The I/O provider instance handle to destroy. */ DECLCALLBACKMEMBER(void, pfnDestroy, (DBGCIOPROV hDbgcIoProv)); diff --git a/src/VBox/Debugger/DBGCRemoteKd.cpp b/src/VBox/Debugger/DBGCRemoteKd.cpp index eebae8ee69a..e2b5031b984 100644 --- a/src/VBox/Debugger/DBGCRemoteKd.cpp +++ b/src/VBox/Debugger/DBGCRemoteKd.cpp @@ -1460,7 +1460,7 @@ static const char *dbgcKdPktDumpSubTypeToStr(uint16_t u16SubType) /** * 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). */ static const char *dbgcKdPktDumpManipulateReqToStr(uint32_t idReq) @@ -1506,7 +1506,6 @@ static const char *dbgcKdPktDumpManipulateReqToStr(uint32_t idReq) /** * Dumps the content of a manipulate packet. * - * @returns nothing. * @param pSgBuf S/G buffer containing the manipulate packet payload. */ static void dbgcKdPktDumpManipulate(PRTSGBUF pSgBuf) @@ -1688,7 +1687,6 @@ static void dbgcKdPktDump(PCKDPACKETHDR pPktHdr, PCRTSGSEG paSegs, uint32_t cSeg /** * Resets the emulated hardware breakpoint state to a state similar after a reboot. * - * @returns nothing. * @param pThis The KD context. */ static void dbgcKdCtxHwBpReset(PKDCTX pThis) @@ -1867,7 +1865,6 @@ static uint32_t dbgcKdCtxHwBpDr7Get(PKDCTX pThis) /** * 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. */ @@ -2659,7 +2656,6 @@ DECLINLINE(int) dbgcKdCtxPktSendAck(PKDCTX pThis) /** * Resets the packet receive state machine. * - * @returns nothing. * @param pThis The KD context. */ static void dbgcKdCtxPktRecvReset(PKDCTX pThis) @@ -2714,7 +2710,6 @@ static int dbgcKdCtxDebugIoStrSend(PKDCTX pThis, VMCPUID idCpu, const char *pach /** * 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. * @param pszMsg The message to send. @@ -3722,7 +3717,6 @@ static int dbgcKdCtxPktManipulate64Process(PKDCTX pThis) /** * Tries to detect the guest OS running in the VM looking specifically for the Windows NT kind. * - * @returns Nothing. * @param pThis The KD context. */ static void dbgcKdCtxDetectGstOs(PKDCTX pThis) @@ -4468,7 +4462,6 @@ static int dbgcKdCtxCreate(PPKDCTX ppKdCtx, PCDBGCIO pIo, unsigned fFlags) /** * Destroys the given KD context. * - * @returns nothing. * @param pThis The KD context to destroy. */ static void dbgcKdCtxDestroy(PKDCTX pThis) diff --git a/src/VBox/Debugger/DBGCScreenAscii.cpp b/src/VBox/Debugger/DBGCScreenAscii.cpp index d2ca3b7f22c..cc2483434f5 100644 --- a/src/VBox/Debugger/DBGCScreenAscii.cpp +++ b/src/VBox/Debugger/DBGCScreenAscii.cpp @@ -228,7 +228,6 @@ DECLHIDDEN(int) dbgcScreenAsciiCreate(PDBGCSCREEN phScreen, uint32_t cchWidth, u /** * Destroys a given ASCII screen. * - * @returns nothing. * @param hScreen The screen handle. */ DECLHIDDEN(void) dbgcScreenAsciiDestroy(DBGCSCREEN hScreen) @@ -354,7 +353,7 @@ DECLHIDDEN(int) dbgcScreenAsciiDrawCharacter(DBGCSCREEN hScreen, uint32_t uX, ui /** * 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. * @param uStartY Y position to start drawing. diff --git a/src/VBox/Debugger/DBGPlugInLinux.cpp b/src/VBox/Debugger/DBGPlugInLinux.cpp index 14377c109ae..55543d8b6c7 100644 --- a/src/VBox/Debugger/DBGPlugInLinux.cpp +++ b/src/VBox/Debugger/DBGPlugInLinux.cpp @@ -1257,7 +1257,6 @@ static DECLCALLBACK(int) dbgDiggerLinuxCfgDbDestroyWorker(PRTSTRSPACECORE pStr, /** * Destroy the config database. * - * @returns nothing. * @param pThis The Linux digger data. */ static void dbgDiggerLinuxCfgDbDestroy(PDBGDIGGERLINUX pThis) diff --git a/src/VBox/Debugger/DBGPlugInWinNt.cpp b/src/VBox/Debugger/DBGPlugInWinNt.cpp index a0ffe967d86..2d60f41ba62 100644 --- a/src/VBox/Debugger/DBGPlugInWinNt.cpp +++ b/src/VBox/Debugger/DBGPlugInWinNt.cpp @@ -578,7 +578,6 @@ static int dbgDiggerWinNtDbgPrintResolveWorker(PDBGDIGGERWINNT pThis, PUVM pUVM, * Tries to resolve and hook into the worker for all the DbgPrint like wrappers to be able * to gather debug information from the system. * - * @returns nothing. * @param pThis The instance data. * @param pUVM The user mode VM handle. */ @@ -659,7 +658,6 @@ static void dbgDiggerWinNtDbgPrintHook(PDBGDIGGERWINNT pThis, PUVM pUVM) /** * 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. * @param pVMM The VMM function table. diff --git a/src/VBox/Debugger/VBoxDbgConsole.cpp b/src/VBox/Debugger/VBoxDbgConsole.cpp index 5a8887493df..9aba344432c 100644 --- a/src/VBox/Debugger/VBoxDbgConsole.cpp +++ b/src/VBox/Debugger/VBoxDbgConsole.cpp @@ -881,13 +881,6 @@ VBoxDbgConsole::backSetReady(PCDBGCIO pBack, bool fReady) } -/** - * 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) { diff --git a/src/VBox/Debugger/VBoxDbgStatsQt.cpp b/src/VBox/Debugger/VBoxDbgStatsQt.cpp index 27a5d789f03..e75ff444695 100644 --- a/src/VBox/Debugger/VBoxDbgStatsQt.cpp +++ b/src/VBox/Debugger/VBoxDbgStatsQt.cpp @@ -364,7 +364,6 @@ protected: * updateCallback() worker that advances the update state to the next data node * in anticipation of the next updateCallback call. * - * @returns The current node. * @param pNode The current node. */ void updateCallbackAdvance(PDBGGUISTATSNODE pNode); diff --git a/src/VBox/Devices/Audio/AudioTest.cpp b/src/VBox/Devices/Audio/AudioTest.cpp index 25c6606a5f2..5fef42feb90 100644 --- a/src/VBox/Devices/Audio/AudioTest.cpp +++ b/src/VBox/Devices/Audio/AudioTest.cpp @@ -2418,7 +2418,6 @@ static uint32_t audioTestFilesFindDiffsBinary(PAUDIOTESTVERIFYJOB pVerJob, /** * Initializes a audio test audio beacon. * - * @returns VBox status code. * @param pBeacon Audio test beacon to (re-)initialize. * @param uTest Test number to set beacon to. * @param enmType Beacon type to set. diff --git a/src/VBox/Devices/Audio/AudioTestService.cpp b/src/VBox/Devices/Audio/AudioTestService.cpp index 9ae5fe7236d..b9414a418ab 100644 --- a/src/VBox/Devices/Audio/AudioTestService.cpp +++ b/src/VBox/Devices/Audio/AudioTestService.cpp @@ -858,7 +858,6 @@ static int atsClientDisconnect(PATSSERVER pThis, PATSCLIENTINST pInst) /** * Free's (destroys) a client instance. * - * @returns nothing. * @param pInst The opaque ATS instance structure. */ static void atsClientFree(PATSCLIENTINST pInst) diff --git a/src/VBox/Devices/Audio/AudioTestServiceClient.cpp b/src/VBox/Devices/Audio/AudioTestServiceClient.cpp index f7d9ae0b3c8..2574212c766 100644 --- a/src/VBox/Devices/Audio/AudioTestServiceClient.cpp +++ b/src/VBox/Devices/Audio/AudioTestServiceClient.cpp @@ -228,13 +228,12 @@ static int audioTestSvcClientSendMsg(PATSCLIENT pClient, void *pvHdr, size_t cbH /** * Initializes a client request header. * - * @returns VBox status code. * @param pReqHdr Request header to initialize. * @param cbReq Size (in bytes) the request will have (does *not* include payload). * @param pszOp Operation to perform with the request. * @param cbPayload Size (in bytes) of payload that will follow the header. Optional and can be 0. */ -DECLINLINE (void) audioTestSvcClientReqHdrInit(PATSPKTHDR pReqHdr, size_t cbReq, const char *pszOp, size_t cbPayload) +DECLINLINE(void) audioTestSvcClientReqHdrInit(PATSPKTHDR pReqHdr, size_t cbReq, const char *pszOp, size_t cbPayload) { AssertReturnVoid(strlen(pszOp) >= 2); AssertReturnVoid(strlen(pszOp) <= ATSPKT_OPCODE_MAX_LEN); @@ -318,7 +317,6 @@ int AudioTestSvcClientCreate(PATSCLIENT pClient) /** * Destroys an ATS client. * - * @returns VBox status code. * @param pClient Client to destroy. */ void AudioTestSvcClientDestroy(PATSCLIENT pClient) diff --git a/src/VBox/Devices/Audio/DevIchAc97.cpp b/src/VBox/Devices/Audio/DevIchAc97.cpp index d01c1cbedf2..0f496521876 100644 --- a/src/VBox/Devices/Audio/DevIchAc97.cpp +++ b/src/VBox/Devices/Audio/DevIchAc97.cpp @@ -1623,7 +1623,6 @@ static DECLCALLBACK(void) ichac97R3Timer(PPDMDEVINS pDevIns, TMTIMERHANDLE hTime /** * Locks an AC'97 stream for serialized access. * - * @returns VBox status code. * @param pStreamCC The AC'97 stream to lock (ring-3). */ DECLINLINE(void) ichac97R3StreamLock(PAC97STREAMR3 pStreamCC) @@ -1635,7 +1634,6 @@ DECLINLINE(void) ichac97R3StreamLock(PAC97STREAMR3 pStreamCC) /** * Unlocks a formerly locked AC'97 stream. * - * @returns VBox status code. * @param pStreamCC The AC'97 stream to unlock (ring-3). */ DECLINLINE(void) ichac97R3StreamUnlock(PAC97STREAMR3 pStreamCC) @@ -2406,7 +2404,6 @@ static bool ichac97R3StreamIsEnabled(PAC97STATER3 pThisCC, PAC97STREAM pStream) * * This is called by ichac97R3StreamsDestroy during VM poweroff & destruction. * - * @returns VBox status code. * @param pThisCC The ring-3 AC'97 state. * @param pStream The AC'97 stream to destroy (shared). * @param pStreamCC The AC'97 stream to destroy (ring-3). @@ -3021,7 +3018,6 @@ ichac97IoPortNabmWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT offPort, uint3 /** * Sets a AC'97 mixer control to a specific value. * - * @returns VBox status code. * @param pThis The shared AC'97 state. * @param uMixerIdx Mixer control to set value for. * @param uVal Value to set. diff --git a/src/VBox/Devices/EFI/FlashCore.cpp b/src/VBox/Devices/EFI/FlashCore.cpp index 067ef33a701..c9d81034d7b 100644 --- a/src/VBox/Devices/EFI/FlashCore.cpp +++ b/src/VBox/Devices/EFI/FlashCore.cpp @@ -423,7 +423,6 @@ DECLHIDDEN(int) flashR3Init(PFLASHCORE pThis, PPDMDEVINS pDevIns, uint16_t idFla /** * Destroys the given flash device instance. * - * @returns nothing. * @param pDevIns The parent device instance. * @param pThis The flash device core instance. */ @@ -564,7 +563,6 @@ DECLHIDDEN(int) flashR3SaveToVfs(PFLASHCORE pThis, PPDMDEVINS pDevIns, PPDMIVFSC /** * Resets the dynamic part of the flash device state. * - * @returns nothing. * @param pThis The flash device core instance. */ DECLHIDDEN(void) flashR3Reset(PFLASHCORE pThis) diff --git a/src/VBox/Devices/Graphics/DevVGA-SVGA.cpp b/src/VBox/Devices/Graphics/DevVGA-SVGA.cpp index 5284984c9c7..a8da59d22c5 100644 --- a/src/VBox/Devices/Graphics/DevVGA-SVGA.cpp +++ b/src/VBox/Devices/Graphics/DevVGA-SVGA.cpp @@ -6399,9 +6399,9 @@ static int vmsvgaR3Init3dInterfaces(PPDMDEVINS pDevIns, PVGASTATE pThis, PVGASTA /** * Compute the host capabilities: device and FIFO. + * * Depends on 3D backend initialization. * - * @returns VBox status code. * @param pThis The shared VGA/VMSVGA instance data. * @param pThisCC The VGA/VMSVGA state for ring-3. * @param pu32DeviceCaps Device capabilities (SVGA_CAP_*). @@ -7089,7 +7089,6 @@ static void vmsvgaR3PowerOnDevice(PPDMDEVINS pDevIns, PVGASTATE pThis, PVGASTATE /** * Power On notification. * - * @returns VBox status code. * @param pDevIns The device instance data. * * @remarks Caller enters the device critical section. diff --git a/src/VBox/Devices/Graphics/DevVGA.cpp b/src/VBox/Devices/Graphics/DevVGA.cpp index 26585286a88..82fac47f30b 100644 --- a/src/VBox/Devices/Graphics/DevVGA.cpp +++ b/src/VBox/Devices/Graphics/DevVGA.cpp @@ -4068,8 +4068,6 @@ static int vbeR3ParseBitmap(PVGASTATECC pThisCC) /** * Show logo bitmap data. * - * @returns VBox status code. - * * @param cBits Logo depth. * @param xLogo Logo X position. * @param yLogo Logo Y position. diff --git a/src/VBox/Devices/Input/DevPS2.cpp b/src/VBox/Devices/Input/DevPS2.cpp index f3f470f47d9..9c3f2dc5322 100644 --- a/src/VBox/Devices/Input/DevPS2.cpp +++ b/src/VBox/Devices/Input/DevPS2.cpp @@ -1009,7 +1009,6 @@ static DECLCALLBACK(void) kbdR3InfoState(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, /** * Reset notification. * - * @returns VBox status code. * @param pDevIns The device instance data. */ static DECLCALLBACK(void) kbdR3Reset(PPDMDEVINS pDevIns) diff --git a/src/VBox/Devices/Input/DrvKeyboardQueue.cpp b/src/VBox/Devices/Input/DrvKeyboardQueue.cpp index bc867af37d0..ba8f508de5a 100644 --- a/src/VBox/Devices/Input/DrvKeyboardQueue.cpp +++ b/src/VBox/Devices/Input/DrvKeyboardQueue.cpp @@ -415,7 +415,6 @@ static DECLCALLBACK(bool) drvKbdQueueConsumer(PPDMDRVINS pDrvIns, PPDMQUEUEITEMC /** * Power On notification. * - * @returns VBox status code. * @param pDrvIns The drive instance data. */ static DECLCALLBACK(void) drvKbdQueuePowerOn(PPDMDRVINS pDrvIns) @@ -428,7 +427,6 @@ static DECLCALLBACK(void) drvKbdQueuePowerOn(PPDMDRVINS pDrvIns) /** * Reset notification. * - * @returns VBox status code. * @param pDrvIns The drive instance data. */ static DECLCALLBACK(void) drvKbdQueueReset(PPDMDRVINS pDrvIns) @@ -442,7 +440,6 @@ static DECLCALLBACK(void) drvKbdQueueReset(PPDMDRVINS pDrvIns) /** * Suspend notification. * - * @returns VBox status code. * @param pDrvIns The drive instance data. */ static DECLCALLBACK(void) drvKbdQueueSuspend(PPDMDRVINS pDrvIns) @@ -455,7 +452,6 @@ static DECLCALLBACK(void) drvKbdQueueSuspend(PPDMDRVINS pDrvIns) /** * Resume notification. * - * @returns VBox status code. * @param pDrvIns The drive instance data. */ static DECLCALLBACK(void) drvKbdQueueResume(PPDMDRVINS pDrvIns) diff --git a/src/VBox/Devices/Input/DrvMouseQueue.cpp b/src/VBox/Devices/Input/DrvMouseQueue.cpp index 51d57f2de46..f951317658a 100644 --- a/src/VBox/Devices/Input/DrvMouseQueue.cpp +++ b/src/VBox/Devices/Input/DrvMouseQueue.cpp @@ -277,7 +277,6 @@ static DECLCALLBACK(bool) drvMouseQueueConsumer(PPDMDRVINS pDrvIns, PPDMQUEUEITE /** * Power On notification. * - * @returns VBox status code. * @param pDrvIns The drive instance data. */ static DECLCALLBACK(void) drvMouseQueuePowerOn(PPDMDRVINS pDrvIns) @@ -290,7 +289,6 @@ static DECLCALLBACK(void) drvMouseQueuePowerOn(PPDMDRVINS pDrvIns) /** * Reset notification. * - * @returns VBox status code. * @param pDrvIns The drive instance data. */ static DECLCALLBACK(void) drvMouseQueueReset(PPDMDRVINS pDrvIns) @@ -304,7 +302,6 @@ static DECLCALLBACK(void) drvMouseQueueReset(PPDMDRVINS pDrvIns) /** * Suspend notification. * - * @returns VBox status code. * @param pDrvIns The drive instance data. */ static DECLCALLBACK(void) drvMouseQueueSuspend(PPDMDRVINS pDrvIns) @@ -317,7 +314,6 @@ static DECLCALLBACK(void) drvMouseQueueSuspend(PPDMDRVINS pDrvIns) /** * Resume notification. * - * @returns VBox status code. * @param pDrvIns The drive instance data. */ static DECLCALLBACK(void) drvMouseQueueResume(PPDMDRVINS pDrvIns) diff --git a/src/VBox/Devices/Misc/DevPL031.cpp b/src/VBox/Devices/Misc/DevPL031.cpp index 1339aa44749..296f013219f 100644 --- a/src/VBox/Devices/Misc/DevPL031.cpp +++ b/src/VBox/Devices/Misc/DevPL031.cpp @@ -192,7 +192,6 @@ typedef CTX_SUFF(PDEVPL031) PDEVPL031CC; /** * Updates the IRQ state based on the current device state. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared RTC instance data. */ diff --git a/src/VBox/Devices/Network/DevPCNet.cpp b/src/VBox/Devices/Network/DevPCNet.cpp index 109f1bdd3cb..6b358c9fd46 100644 --- a/src/VBox/Devices/Network/DevPCNet.cpp +++ b/src/VBox/Devices/Network/DevPCNet.cpp @@ -710,7 +710,6 @@ DECLINLINE(bool) pcnetIsLinkUp(PPCNETSTATE pThis) /** * Memory write helper to handle PCI/ISA differences. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the PCNet device instance * @param GCPhys Guest physical memory address @@ -729,7 +728,6 @@ static void pcnetPhysWrite(PPDMDEVINS pDevIns, PPCNETSTATE pThis, RTGCPHYS GCPhy /** * Memory read helper to handle PCI/ISA differences. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the PCNet device instance. * @param GCPhys Guest physical memory address. diff --git a/src/VBox/Devices/Network/DrvNAT.cpp b/src/VBox/Devices/Network/DrvNAT.cpp index 60ce1a7d4fa..e4a39e41658 100644 --- a/src/VBox/Devices/Network/DrvNAT.cpp +++ b/src/VBox/Devices/Network/DrvNAT.cpp @@ -1112,7 +1112,6 @@ static DECLCALLBACK(void) drvNATNotifyDnsChanged(PPDMINETWORKNATCONFIG pInterfac * Callback for the SystemConfiguration framework to notify us whenever the DNS * server changes. * - * @returns nothing. * @param hDynStor The DynamicStore handle. * @param hChangedKey Array of changed keys we watch for. * @param pvUser Opaque user data (NAT driver instance). diff --git a/src/VBox/Devices/PC/BIOS/scsi.c b/src/VBox/Devices/PC/BIOS/scsi.c index a91606bb7e9..59f65e33437 100644 --- a/src/VBox/Devices/PC/BIOS/scsi.c +++ b/src/VBox/Devices/PC/BIOS/scsi.c @@ -296,7 +296,6 @@ uint16_t scsi_cmd_packet(uint16_t device_id, uint8_t cmdlen, char __far *cmdbuf, /** * Enumerate attached devices. * - * @returns nothing. * @param hba_seg Segement of the HBA controller block. * @param idx_hba The HBA driver index used for accessing the enumerated devices. */ diff --git a/src/VBox/Devices/PC/DevQemuFwCfg.cpp b/src/VBox/Devices/PC/DevQemuFwCfg.cpp index b2254d33e85..fc353d5afcd 100644 --- a/src/VBox/Devices/PC/DevQemuFwCfg.cpp +++ b/src/VBox/Devices/PC/DevQemuFwCfg.cpp @@ -307,7 +307,6 @@ typedef FNQEMUFWCFGITEMWRITE *PFNQEMUFWCFGITEMWRITE; /** * Cleans up any allocated resources when the item is de-selected. * - * @returns nothing. * @param pThis The QEMU fw config device instance. * @param pItem Pointer to the selected item. */ @@ -777,7 +776,6 @@ static const QEMUFWCFGITEM g_aQemuFwCfgItems[] = /** * Resets the currently selected item. * - * @returns nothing. * @param pThis The QEMU fw config device instance. */ static void qemuFwCfgR3ItemReset(PDEVQEMUFWCFG pThis) @@ -847,7 +845,6 @@ static int qemuFwCfgItemSelect(PDEVQEMUFWCFG pThis, uint16_t uCfgItem) /** * Processes a DMA transfer. * - * @returns nothing. * @param pThis The QEMU fw config device instance. * @param GCPhysDma The guest physical address of the DMA descriptor. */ diff --git a/src/VBox/Devices/Security/DevTpm.cpp b/src/VBox/Devices/Security/DevTpm.cpp index a47b08cbe76..c37453bd762 100644 --- a/src/VBox/Devices/Security/DevTpm.cpp +++ b/src/VBox/Devices/Security/DevTpm.cpp @@ -616,7 +616,6 @@ static SSMFIELD const g_aTpmFields[] = /** * Sets the IRQ line of the given device to the given state. * - * @returns nothing. * @param pDevIns Pointer to the PDM device instance data. * @param pThis Pointer to the shared TPM device. * @param iLvl The interrupt level to set. @@ -630,7 +629,6 @@ DECLINLINE(void) tpmIrqReq(PPDMDEVINS pDevIns, PDEVTPM pThis, int iLvl) /** * Updates the IRQ status of the given locality. * - * @returns nothing. * @param pDevIns Pointer to the PDM device instance data. * @param pThis Pointer to the shared TPM device. * @param pLoc The locality state. @@ -648,7 +646,6 @@ static void tpmLocIrqUpdate(PPDMDEVINS pDevIns, PDEVTPM pThis, PDEVTPMLOCALITY p /** * Sets the interrupt status for the given locality, firing an interrupt if necessary. * - * @returns nothing. * @param pDevIns Pointer to the PDM device instance data. * @param pThis Pointer to the shared TPM device. * @param pLoc The locality state. @@ -664,7 +661,6 @@ static void tpmLocSetIntSts(PPDMDEVINS pDevIns, PDEVTPM pThis, PDEVTPMLOCALITY p /** * Selects the next locality which has requested access. * - * @returns nothing. * @param pDevIns Pointer to the PDM device instance data. * @param pThis Pointer to the shared TPM device. */ @@ -1456,7 +1452,6 @@ static DECLCALLBACK(void) tpmR3CmdExecWorker(PPDMDEVINS pDevIns, void *pvUser) /** * Resets the shared hardware TPM state. * - * @returns nothing. * @param pThis Pointer to the shared TPM device. */ static void tpmR3HwReset(PDEVTPM pThis) diff --git a/src/VBox/Devices/Serial/DevOxPcie958.cpp b/src/VBox/Devices/Serial/DevOxPcie958.cpp index f5973bed12e..2149397d28c 100644 --- a/src/VBox/Devices/Serial/DevOxPcie958.cpp +++ b/src/VBox/Devices/Serial/DevOxPcie958.cpp @@ -211,7 +211,6 @@ typedef CTX_SUFF(PDEVOX958) PDEVOX958CC; /** * Update IRQ status of the device. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared OXPCIe958 device instance data. */ @@ -290,7 +289,6 @@ static VBOXSTRICTRC ox958UartRegWrite(PPDMDEVINS pDevIns, PDEVOX958 pThis, POX95 /** * UART core IRQ request callback. * - * @returns nothing. * @param pDevIns The device instance. * @param pUart The UART requesting an IRQ update. * @param iLUN The UART index. diff --git a/src/VBox/Devices/Serial/DevPL011.cpp b/src/VBox/Devices/Serial/DevPL011.cpp index 2a9b6e3943b..ad31176e4ec 100644 --- a/src/VBox/Devices/Serial/DevPL011.cpp +++ b/src/VBox/Devices/Serial/DevPL011.cpp @@ -379,7 +379,6 @@ static const char *s_aszStopBits[] = /** * Updates the IRQ state based on the current device state. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -460,7 +459,6 @@ static VBOXSTRICTRC pl011Xmit(PPDMDEVINS pDevIns, PDEVPL011CC pThisCC, PDEVPL011 /** * Updates the serial port parameters of the attached driver with the current configuration. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -533,7 +531,6 @@ static void pl011R3ParamsUpdate(PPDMDEVINS pDevIns, PDEVPL011 pThis, PDEVPL011CC * Reset the transmit/receive related bits to the standard values * (after a detach/attach/reset event). * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -572,7 +569,6 @@ static void pl011R3XferReset(PPDMDEVINS pDevIns, PDEVPL011 pThis, PDEVPL011CC pT /** * Tries to copy the specified amount of data from the active TX queue (register or FIFO). * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. diff --git a/src/VBox/Devices/Serial/DrvHostSerial.cpp b/src/VBox/Devices/Serial/DrvHostSerial.cpp index b95a4e4c1ed..4e77d902f51 100644 --- a/src/VBox/Devices/Serial/DrvHostSerial.cpp +++ b/src/VBox/Devices/Serial/DrvHostSerial.cpp @@ -174,7 +174,6 @@ DECLINLINE(size_t) drvHostSerialReadBufGetRead(PDRVHOSTSERIAL pThis, void **ppv) /** * Advances the write position of the read buffer by the given amount of bytes. * - * @returns nothing. * @param pThis The host serial driver instance. * @param cbAdv Number of bytes to advance. */ @@ -190,7 +189,6 @@ DECLINLINE(void) drvHostSerialReadBufWriteAdv(PDRVHOSTSERIAL pThis, size_t cbAdv /** * Advances the read position of the read buffer by the given amount of bytes. * - * @returns nothing. * @param pThis The host serial driver instance. * @param cbAdv Number of bytes to advance. */ @@ -595,7 +593,6 @@ static int drvHostSerialIoLoopNormal(PPDMDRVINS pDrvIns, PDRVHOSTSERIAL pThis, P /** * The error I/O loop. * - * @returns VBox status code. * @param pThis Host serial driver instance data. * @param pThread Thread instance data. */ diff --git a/src/VBox/Devices/Serial/DrvTCP.cpp b/src/VBox/Devices/Serial/DrvTCP.cpp index 6f9b8811b80..1bc037d0e85 100644 --- a/src/VBox/Devices/Serial/DrvTCP.cpp +++ b/src/VBox/Devices/Serial/DrvTCP.cpp @@ -147,7 +147,6 @@ static int drvTcpPollerKick(PDRVTCP pThis, uint8_t bReason) /** * Closes the connection. * - * @returns nothing. * @param pThis The TCP driver instance. */ static void drvTcpConnectionClose(PDRVTCP pThis) diff --git a/src/VBox/Devices/Serial/UartCore.cpp b/src/VBox/Devices/Serial/UartCore.cpp index 3baf841bcf7..5125bd51800 100644 --- a/src/VBox/Devices/Serial/UartCore.cpp +++ b/src/VBox/Devices/Serial/UartCore.cpp @@ -283,7 +283,6 @@ static const char *s_aszStopBits[] = /** * Updates the IRQ state based on the current device state. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -420,7 +419,6 @@ DECLINLINE(uint8_t) uartFifoGet(PUARTFIFO pFifo) /** * Clears the given FIFO. * - * @returns nothing. * @param pFifo The FIFO to clear. */ DECLINLINE(void) uartFifoClear(PUARTFIFO pFifo) @@ -510,7 +508,6 @@ DECLINLINE(size_t) uartFifoCopyFrom(PUARTFIFO pFifo, void *pvSrc, size_t cbCopy) * Updates the delta bits for the given MSR register value which has the status line * bits set. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -537,7 +534,6 @@ static void uartR3MsrUpdate(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCORECC pTh /** * Updates the serial port parameters of the attached driver with the current configuration. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -609,7 +605,6 @@ static void uartR3ParamsUpdate(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCORECC /** * Updates the internal device state with the given PDM status line states. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -635,7 +630,6 @@ static void uartR3StsLinesUpdate(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCOREC /** * Fills up the receive FIFO with as much data as possible. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -689,7 +683,6 @@ static void uartR3RecvFifoFill(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCORECC /** * Fetches a single byte and writes it to RBR. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -710,7 +703,6 @@ static void uartR3ByteFetch(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCORECC pTh /** * Fetches a ready data based on the FIFO setting. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -730,7 +722,6 @@ static void uartR3DataFetch(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCORECC pTh * Reset the transmit/receive related bits to the standard values * (after a detach/attach/reset event). * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -770,7 +761,6 @@ static void uartR3XferReset(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCORECC pTh /** * Tries to copy the specified amount of data from the active TX queue (register or FIFO). * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -1919,7 +1909,6 @@ DECLHIDDEN(int) uartR3LoadDone(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCORECC /** * Resets the given UART core instance. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -1998,7 +1987,6 @@ DECLHIDDEN(int) uartR3Attach(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCORECC pT /** * Detaches any attached driver from the given UART core instance. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared serial port instance data. * @param pThisCC The serial port instance data for the current context. @@ -2020,7 +2008,6 @@ DECLHIDDEN(void) uartR3Detach(PPDMDEVINS pDevIns, PUARTCORE pThis, PUARTCORECC p /** * Destroys the given UART core instance freeing all allocated resources. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared UART core instance data.. */ diff --git a/src/VBox/Devices/Serial/UartCore.h b/src/VBox/Devices/Serial/UartCore.h index f286a2d19bb..3b63bc03862 100644 --- a/src/VBox/Devices/Serial/UartCore.h +++ b/src/VBox/Devices/Serial/UartCore.h @@ -71,7 +71,6 @@ typedef struct UARTCORE *PUARTCORE; /** * UART core IRQ request callback to let the core instance raise/clear interrupt requests. * - * @returns nothing. * @param pDevIns The owning device instance. * @param pThis The shared UART core instance data. * @param iLUN The LUN associated with the UART core. diff --git a/src/VBox/Devices/Storage/ATAPIPassthrough.cpp b/src/VBox/Devices/Storage/ATAPIPassthrough.cpp index 7bd9f17e147..9aa895c2d15 100644 --- a/src/VBox/Devices/Storage/ATAPIPassthrough.cpp +++ b/src/VBox/Devices/Storage/ATAPIPassthrough.cpp @@ -164,7 +164,6 @@ static int atapiTrackListReallocate(PTRACKLIST pTrackList, unsigned cTracks, uin /** * Initilizes the given track from the given CUE sheet entry. * - * @returns nothing. * @param pTrack The track to initialize. * @param pbCueSheetEntry CUE sheet entry to use. */ @@ -475,7 +474,6 @@ static const char *atapiTrackListSubChnDataFormToString(SUBCHNDATAFORM enmSubChn /** * Dump the complete track list to the release log. * - * @returns nothing. * @param pTrackList The track list to dump. */ static void atapiTrackListDump(PTRACKLIST pTrackList) @@ -516,7 +514,6 @@ DECLHIDDEN(int) ATAPIPassthroughTrackListCreateEmpty(PTRACKLIST *ppTrackList) /** * Destroys the allocated task list handle. * - * @returns nothing. * @param pTrackList The track list handle to destroy. */ DECLHIDDEN(void) ATAPIPassthroughTrackListDestroy(PTRACKLIST pTrackList) @@ -529,7 +526,6 @@ DECLHIDDEN(void) ATAPIPassthroughTrackListDestroy(PTRACKLIST pTrackList) /** * Clears all tracks from the given task list. * - * @returns nothing. * @param pTrackList The track list to clear. */ DECLHIDDEN(void) ATAPIPassthroughTrackListClear(PTRACKLIST pTrackList) diff --git a/src/VBox/Devices/Storage/DevAHCI.cpp b/src/VBox/Devices/Storage/DevAHCI.cpp index e2e5228e63e..bdeac3020df 100644 --- a/src/VBox/Devices/Storage/DevAHCI.cpp +++ b/src/VBox/Devices/Storage/DevAHCI.cpp @@ -636,7 +636,6 @@ AssertCompileSize(SGLEntry, 16); /** * Memory buffer callback. * - * @returns nothing. * @param pDevIns The device instance. * @param GCPhys The guest physical address of the memory buffer. * @param pSgBuf The pointer to the host R3 S/G buffer. @@ -984,7 +983,6 @@ static DECLCALLBACK(void) ahciCccTimer(PPDMDEVINS pDevIns, TMTIMERHANDLE hTimer, /** * Finishes the port reset of the given port. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared AHCI state. * @param pAhciPort The port to finish the reset on, shared bits. @@ -1048,7 +1046,6 @@ static void ahciPortResetFinish(PPDMDEVINS pDevIns, PAHCI pThis, PAHCIPORT pAhci /** * Kicks the I/O thread from RC or R0. * - * @returns nothing. * @param pDevIns The device instance. * @param pAhciPort The port to kick, shared bits. */ @@ -2533,7 +2530,6 @@ static DECLCALLBACK(int) ahciR3PortQueryScsiInqStrings(PPDMIMEDIAPORT pInterface /** * Dump info about the FIS * - * @returns nothing * @param pAhciPort The port the command FIS was read from (shared bits). * @param cmdFis The FIS to print info from. */ @@ -2615,7 +2611,6 @@ static void ahciDumpFisInfo(PAHCIPORT pAhciPort, uint8_t *cmdFis) /** * Dump info about the command header * - * @returns nothing * @param pAhciPort Pointer to the port the command header was read from * (shared bits). * @param pCmdHdr The command header to print info from. @@ -2650,7 +2645,6 @@ static void ahciDumpCmdHdrInfo(PAHCIPORT pAhciPort, CmdHdr *pCmdHdr) /** * Post the first D2H FIS from the device into guest memory. * - * @returns nothing * @param pDevIns The device instance. * @param pAhciPort Pointer to the port which "receives" the FIS (shared bits). */ @@ -2935,7 +2929,6 @@ static int ahciR3AtapiIdentify(PPDMDEVINS pDevIns, PAHCIREQ pAhciReq, PAHCIPORT /** * Reset all values after a reset of the attached storage device. * - * @returns nothing * @param pDevIns The device instance. * @param pThis The shared AHCI state. * @param pAhciPort The port the device is attached to, shared bits(shared @@ -2965,7 +2958,6 @@ static void ahciFinishStorageDeviceReset(PPDMDEVINS pDevIns, PAHCI pThis, PAHCIP /** * Initiates a device reset caused by ATA_DEVICE_RESET (ATAPI only). * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared AHCI state. * @param pAhciPort The device to reset(shared bits). @@ -2987,7 +2979,6 @@ static void ahciDeviceReset(PPDMDEVINS pDevIns, PAHCI pThis, PAHCIPORT pAhciPort /** * Create a PIO setup FIS and post it into the memory area of the guest. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The shared AHCI state. * @param pAhciPort The port of the SATA controller (shared bits). @@ -3055,7 +3046,6 @@ static void ahciSendPioSetupFis(PPDMDEVINS pDevIns, PAHCI pThis, PAHCIPORT pAhci /** * Build a D2H FIS and post into the memory area of the guest. * - * @returns Nothing * @param pDevIns The device instance. * @param pThis The shared AHCI state. * @param pAhciPort The port of the SATA controller (shared bits). @@ -3125,7 +3115,6 @@ static void ahciSendD2HFis(PPDMDEVINS pDevIns, PAHCI pThis, PAHCIPORT pAhciPort, /** * Build a SDB Fis and post it into the memory area of the guest. * - * @returns Nothing * @param pDevIns The device instance. * @param pThis The shared AHCI state. * @param pAhciPort The port for which the SDB Fis is send, shared bits. @@ -3584,7 +3573,6 @@ static PAHCIREQ ahciR3ReqAlloc(PAHCIPORTR3 pAhciPortR3, uint32_t uTag) /** * Frees a given AHCI request structure. * - * @returns nothing. * @param pAhciPortR3 The AHCI port, ring-3 bits. * @param pAhciReq The request to free. */ diff --git a/src/VBox/Devices/Storage/DevATA.cpp b/src/VBox/Devices/Storage/DevATA.cpp index a8cd4d88f3e..28e1fd50f96 100644 --- a/src/VBox/Devices/Storage/DevATA.cpp +++ b/src/VBox/Devices/Storage/DevATA.cpp @@ -1274,7 +1274,6 @@ static void ataHCPIOTransferLimitATAPI(PATADEVSTATE s) /** * Enters the lock protecting the controller data against concurrent access. * - * @returns nothing. * @param pDevIns The device instance. * @param pCtl The controller to lock. */ @@ -1289,7 +1288,6 @@ DECLINLINE(void) ataR3LockEnter(PPDMDEVINS pDevIns, PATACONTROLLER pCtl) /** * Leaves the lock protecting the controller against concurrent data access. * - * @returns nothing. * @param pDevIns The device instance. * @param pCtl The controller to unlock. */ @@ -7135,7 +7133,6 @@ static DECLCALLBACK(int) ataR3Attach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_ /** * Resume notification. * - * @returns VBox status code. * @param pDevIns The device instance data. */ static DECLCALLBACK(void) ataR3Resume(PPDMDEVINS pDevIns) @@ -7600,7 +7597,6 @@ static void ataR3SuspendOrPowerOff(PPDMDEVINS pDevIns) /** * Power Off notification. * - * @returns VBox status code. * @param pDevIns The device instance data. */ static DECLCALLBACK(void) ataR3PowerOff(PPDMDEVINS pDevIns) @@ -7613,7 +7609,6 @@ static DECLCALLBACK(void) ataR3PowerOff(PPDMDEVINS pDevIns) /** * Suspend notification. * - * @returns VBox status code. * @param pDevIns The device instance data. */ static DECLCALLBACK(void) ataR3Suspend(PPDMDEVINS pDevIns) diff --git a/src/VBox/Devices/Storage/DevBusLogic.cpp b/src/VBox/Devices/Storage/DevBusLogic.cpp index a8b71c6b8d4..1cdf739f3e6 100644 --- a/src/VBox/Devices/Storage/DevBusLogic.cpp +++ b/src/VBox/Devices/Storage/DevBusLogic.cpp @@ -1028,7 +1028,6 @@ typedef BUSLOGICCOPYARGS *PBUSLOGICCOPYARGS; /** * Memory buffer callback. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param GCPhys The guest physical address of the memory buffer. @@ -1064,7 +1063,6 @@ static int buslogicR3RegisterISARange(PPDMDEVINS pDevIns, PBUSLOGIC pThis, uint8 * interrupts at once. Instead, new interrupts are postponed if * an interrupt of a different type is still pending. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param fSuppressIrq Flag to suppress IRQ generation regardless of fIRQEnabled @@ -1118,7 +1116,6 @@ static void buslogicSetInterrupt(PPDMDEVINS pDevIns, PBUSLOGIC pThis, bool fSupp /** * Deasserts the interrupt line of the BusLogic adapter. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. */ @@ -1145,7 +1142,6 @@ static void buslogicClearInterrupt(PPDMDEVINS pDevIns, PBUSLOGIC pThis) /** * Advances the mailbox pointer to the next slot. * - * @returns nothing. * @param pThis Pointer to the shared BusLogic instance data. */ DECLINLINE(void) buslogicR3OutgoingMailboxAdvance(PBUSLOGIC pThis) @@ -1156,7 +1152,6 @@ DECLINLINE(void) buslogicR3OutgoingMailboxAdvance(PBUSLOGIC pThis) /** * Initialize local RAM of host adapter with default values. * - * @returns nothing. * @param pThis Pointer to the shared BusLogic instance data. */ static void buslogicR3InitializeLocalRam(PBUSLOGIC pThis) @@ -1231,7 +1226,6 @@ static int buslogicR3HwReset(PPDMDEVINS pDevIns, PBUSLOGIC pThis, bool fResetIO) * Resets the command state machine for the next command and notifies the guest. * Note that suppressing CMDC also suppresses the interrupt, but not vice versa. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param fSuppressIrq Flag to suppress IRQ generation regardless of current state @@ -1262,7 +1256,6 @@ static void buslogicCommandComplete(PPDMDEVINS pDevIns, PBUSLOGIC pThis, bool fS /** * Memory write helper to handle PCI/ISA differences - metadata writes. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param GCPhys Guest physical memory address @@ -1280,7 +1273,6 @@ static void blPhysWriteMeta(PPDMDEVINS pDevIns, PBUSLOGIC pThis, RTGCPHYS GCPhys /** * Memory read helper to handle PCI/ISA differences - metadata reads. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param GCPhys Guest physical memory address. @@ -1295,12 +1287,11 @@ static void blPhysReadMeta(PPDMDEVINS pDevIns, PBUSLOGIC pThis, RTGCPHYS GCPhys, PDMDevHlpPhysReadMeta(pDevIns, GCPhys, pvBuf, cbRead); } -#if defined(IN_RING3) +#ifdef IN_RING3 /** * Memory write helper to handle PCI/ISA differences - userdata writes. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param GCPhys Guest physical memory address @@ -1318,7 +1309,6 @@ static void blPhysWriteUser(PPDMDEVINS pDevIns, PBUSLOGIC pThis, RTGCPHYS GCPhys /** * Memory read helper to handle PCI/ISA differences - userdata reads. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param GCPhys Guest physical memory address. @@ -1336,7 +1326,6 @@ static void blPhysReadUser(PPDMDEVINS pDevIns, PBUSLOGIC pThis, RTGCPHYS GCPhys, /** * Initiates a hard reset which was issued from the guest. * - * @returns nothing * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param fHardReset Flag initiating a hard (vs. soft) reset. @@ -1362,7 +1351,6 @@ static void buslogicR3InitiateReset(PPDMDEVINS pDevIns, PBUSLOGIC pThis, bool fH /** * Send a mailbox with set status codes to the guest. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param GCPhysAddrCCB The physical guest address of the CCB the mailbox is for. @@ -1468,7 +1456,6 @@ static void buslogicR3DumpMailboxInfo(PMailbox32 pMailbox, bool fOutgoing) /** * Dumps the content of a command control block for debugging purposes. * - * @returns nothing. * @param pCCB Pointer to the command control block to dump. * @param fIs24BitCCB Flag to determine CCB format. */ @@ -1841,7 +1828,6 @@ static uint32_t buslogicR3ConvertSenseBufferLength(uint32_t cbSense) /** * Free the sense buffer. * - * @returns nothing. * @param pReq Pointer to the request state. * @param fCopy If sense data should be copied to guest memory. */ @@ -2854,7 +2840,7 @@ buslogicIOPortWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT offPort, uint32_t /** * Update the ISA I/O range. * - * @returns nothing. + * @returns VBox status code. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param uBaseCode Encoded ISA I/O base; only low 3 bits are used. @@ -2913,7 +2899,6 @@ static int buslogicR3RegisterISARange(PPDMDEVINS pDevIns, PBUSLOGIC pThis, uint8 /** * Completes a request initiated by the BIOS through the BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND command. * - * @returns nothing. * @param pThis Pointer to the shared BusLogic instance data. * @param u8ScsiSts The SCSI status code. */ @@ -3384,7 +3369,6 @@ static int buslogicR3ProcessMailboxNext(PPDMDEVINS pDevIns, PBUSLOGIC pThis, PBU /** * Processes a SCSI request issued by the BIOS with the BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND command. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared BusLogic instance data. * @param pThisCC Pointer to the ring-3 BusLogic instance data. diff --git a/src/VBox/Devices/Storage/DevLsiLogicSCSI.cpp b/src/VBox/Devices/Storage/DevLsiLogicSCSI.cpp index 565f2c4c0d2..9f3c74246d2 100644 --- a/src/VBox/Devices/Storage/DevLsiLogicSCSI.cpp +++ b/src/VBox/Devices/Storage/DevLsiLogicSCSI.cpp @@ -100,7 +100,6 @@ typedef struct LSILOGICSCSI *PLSILOGICSCSI; /** * Memory buffer callback. * - * @returns nothing. * @param pDevIns The device instance. * @param GCPhys The guest physical address of the memory buffer. * @param pSgBuf The pointer to the host R3 S/G buffer. @@ -448,7 +447,6 @@ static const uint8_t g_lsilogicDiagnosticAccess[] = {0x04, 0x0b, 0x02, 0x07, 0x0 /** * Updates the status of the interrupt pin of the device. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared LsiLogic device state. */ @@ -479,7 +477,6 @@ static void lsilogicUpdateInterrupt(PPDMDEVINS pDevIns, PLSILOGICSCSI pThis) * Sets a given interrupt status bit in the status register and * updates the interrupt status. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared LsiLogic device state. * @param uStatus The status bit to set. @@ -494,7 +491,6 @@ DECLINLINE(void) lsilogicSetInterrupt(PPDMDEVINS pDevIns, PLSILOGICSCSI pThis, u * Clears a given interrupt status bit in the status register and * updates the interrupt status. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared LsiLogic device state. * @param uStatus The status bit to set. @@ -510,7 +506,6 @@ DECLINLINE(void) lsilogicClearInterrupt(PPDMDEVINS pDevIns, PLSILOGICSCSI pThis, /** * Sets the I/O controller into fault state and sets the fault code. * - * @returns nothing * @param pThis Pointer to the shared LsiLogic device state. * @param uIOCFaultCode Fault code to set. */ @@ -617,7 +612,7 @@ static int lsilogicR3HardReset(PPDMDEVINS pDevIns, PLSILOGICSCSI pThis, PLSILOGI /** * Allocates the configuration pages based on the device. * - * @returns nothing. + * @returns VBox status code. * @param pThis Pointer to the shared LsiLogic device state. * @param pThisCC Pointer to the ring-3 LsiLogic device state. */ @@ -685,7 +680,6 @@ static int lsilogicR3ConfigurationPagesAlloc(PLSILOGICSCSI pThis, PLSILOGICSCSIC /** * Frees the configuration pages if allocated. * - * @returns nothing. * @param pThis Pointer to the shared LsiLogic device state. * @param pThisCC Pointer to the ring-3 LsiLogic device state. */ @@ -731,7 +725,6 @@ static void lsilogicR3ConfigurationPagesFree(PLSILOGICSCSI pThis, PLSILOGICSCSIC /** * Finishes a context reply. * - * @returns nothing * @param pDevIns The device instance. * @param pThis Pointer to the shared LsiLogic device state. * @param u32MessageContext The message context ID to post. @@ -770,7 +763,6 @@ static void lsilogicR3FinishContextReply(PPDMDEVINS pDevIns, PLSILOGICSCSI pThis /** * Takes necessary steps to finish a reply frame. * - * @returns nothing * @param pDevIns The device instance. * @param pThis Pointer to the shared LsiLogic device state. * @param pReply Pointer to the reply message. @@ -890,7 +882,6 @@ static PLSILOGICMEMREGN lsilogicR3MemRegionFindByAddr(PLSILOGICSCSICC pThisCC, u /** * Frees all allocated memory regions. * - * @returns nothing. * @param pThisCC Pointer to the ring-3 LsiLogic device state. */ static void lsilogicR3MemRegionsFree(PLSILOGICSCSICC pThisCC) @@ -909,7 +900,6 @@ static void lsilogicR3MemRegionsFree(PLSILOGICSCSICC pThisCC) /** * Inserts a given memory region into the list. * - * @returns nothing. * @param pThisCC Pointer to the ring-3 LsiLogic device state. * @param pRegion The region to insert. */ @@ -954,7 +944,6 @@ static uint32_t lsilogicR3MemRegionsCount(PLSILOGICSCSICC pThisCC) /** * Handles a write to the diagnostic data register. * - * @returns nothing. * @param pThis Pointer to the shared LsiLogic device state. * @param pThisCC Pointer to the ring-3 LsiLogic device state. * @param u32Data Data to write. @@ -1044,7 +1033,6 @@ static void lsilogicR3DiagRegDataWrite(PLSILOGICSCSI pThis, PLSILOGICSCSICC pThi /** * Handles a read from the diagnostic data register. * - * @returns nothing. * @param pThis Pointer to the shared LsiLogic device state. * @param pThisCC Pointer to the ring-3 LsiLogic device state. * @param pu32Data Where to store the data. @@ -1076,7 +1064,6 @@ static void lsilogicR3DiagRegDataRead(PLSILOGICSCSI pThis, PLSILOGICSCSICC pThis /** * Handles a write to the diagnostic memory address register. * - * @returns nothing. * @param pThis Pointer to the shared LsiLogic device state. * @param u32Addr Address to write. */ @@ -1088,7 +1075,6 @@ static void lsilogicR3DiagRegAddressWrite(PLSILOGICSCSI pThis, uint32_t u32Addr) /** * Handles a read from the diagnostic memory address register. * - * @returns nothing. * @param pThis Pointer to the shared LsiLogic device state. * @param pu32Addr Where to store the current address. */ @@ -1909,7 +1895,6 @@ static DECLCALLBACK(VBOXSTRICTRC) lsilogicDiagnosticRead(PPDMDEVINS pDevIns, voi /** * Dump an SG entry. * - * @returns nothing. * @param pSGEntry Pointer to the SG entry to dump */ static void lsilogicDumpSGEntry(PMptSGEntryUnion pSGEntry) @@ -2219,7 +2204,6 @@ static void lsilogicR3DumpSCSIIORequest(PMptSCSIIORequest pSCSIIORequest) /** * Handles the completion of th given request. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared LsiLogic device state. * @param pReq The request to complete. @@ -3345,7 +3329,6 @@ static int lsilogicR3ProcessConfigurationRequest(PPDMDEVINS pDevIns, PLSILOGICSC /** * Initializes the configuration pages for the SPI SCSI controller. * - * @returns nothing * @param pThis Pointer to the shared LsiLogic device state. * @param pThisCC Pointer to the ring-3 LsiLogic device state. */ @@ -3449,7 +3432,6 @@ DECLINLINE(uint16_t) lsilogicGetHandle(PLSILOGICSCSI pThis) /** * Generates a SAS address (WWID) * - * @returns nothing. * @param pSASAddress Pointer to an unitialised SAS address. * @param iId iId which will go into the address. * @@ -3470,7 +3452,6 @@ void lsilogicSASAddressGenerate(PSASADDRESS pSASAddress, unsigned iId) /** * Initializes the configuration pages for the SAS SCSI controller. * - * @returns nothing * @param pThis Pointer to the shared LsiLogic device state. * @param pThisCC Pointer to the ring-3 LsiLogic device state. */ @@ -3649,7 +3630,6 @@ static void lsilogicR3InitializeConfigurationPagesSas(PLSILOGICSCSI pThis, PLSIL /** * Initializes the configuration pages. * - * @returns nothing * @param pDevIns The device instance. * @param pThis Pointer to the shared LsiLogic device state. * @param pThisCC Pointer to the ring-3 LsiLogic device state. @@ -4105,7 +4085,6 @@ static DECLCALLBACK(int) lsilogicR3WorkerWakeUp(PPDMDEVINS pDevIns, PPDMTHREAD p * Kicks the controller to process pending tasks after the VM was resumed * or loaded from a saved state. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis Pointer to the shared LsiLogic device state. */ diff --git a/src/VBox/Devices/Storage/DevVirtioSCSI.cpp b/src/VBox/Devices/Storage/DevVirtioSCSI.cpp index cedb55349ed..f834b71b94e 100644 --- a/src/VBox/Devices/Storage/DevVirtioSCSI.cpp +++ b/src/VBox/Devices/Storage/DevVirtioSCSI.cpp @@ -720,7 +720,6 @@ static uint8_t virtioScsiEstimateCdbLen(uint8_t uCmd, uint8_t cbMax) /** * Wrapper around virtioCoreR3VirtqUsedBufPut() and virtioCoreVirtqUsedRingSync() doing some device locking. * - * @returns nothing. * @param pDevIns The PDM device instance. * @param pVirtio Pointer to the shared virtio core structure. * @param uVirtqNbr The virtq number. @@ -828,7 +827,6 @@ static int virtioScsiR3SendEvent(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t /** * Releases one reference from the given controller instances active request counter. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis VirtIO SCSI shared instance data. * @param pThisCC VirtIO SCSI ring-3 instance data. @@ -844,7 +842,6 @@ DECLINLINE(void) virtioScsiR3Release(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, PVIR /** * Retains one reference for the given controller instances active request counter. * - * @returns nothing. * @param pThis VirtIO SCSI shared instance data. */ DECLINLINE(void) virtioScsiR3Retain(PVIRTIOSCSI pThis) diff --git a/src/VBox/Devices/Storage/DrvDiskIntegrity.cpp b/src/VBox/Devices/Storage/DrvDiskIntegrity.cpp index 828149cbe05..5913b61969a 100644 --- a/src/VBox/Devices/Storage/DrvDiskIntegrity.cpp +++ b/src/VBox/Devices/Storage/DrvDiskIntegrity.cpp @@ -684,7 +684,6 @@ static int drvdiskintDiscardRecords(PDRVDISKINTEGRITY pThis, PCRTRANGE paRanges, /** * Adds a request to the active list. * - * @returns nothing. * @param pThis The driver instance data. * @param pIoReq The request to add. */ @@ -705,7 +704,6 @@ static void drvdiskintIoReqAdd(PDRVDISKINTEGRITY pThis, PDRVDISKAIOREQ pIoReq) /** * Removes a request from the active list. * - * @returns nothing. * @param pThis The driver instance data. * @param pIoReq The request to remove. */ @@ -786,7 +784,6 @@ static int drvdiskintReadAfterWriteVerify(PDRVDISKINTEGRITY pThis, PDRVDISKAIORE /** * Fires a read event if enabled. * - * @returns nothing. * @param pThis The driver instance data. * @param uGrp The group ID. * @param fAsync Flag whether this is an async request. @@ -807,7 +804,6 @@ DECLINLINE(void) drvdiskintTraceLogFireEvtRead(PDRVDISKINTEGRITY pThis, uintptr_ /** * Fires a write event if enabled. * - * @returns nothing. * @param pThis The driver instance data. * @param uGrp The group ID. * @param fAsync Flag whether this is an async request. @@ -828,7 +824,6 @@ DECLINLINE(void) drvdiskintTraceLogFireEvtWrite(PDRVDISKINTEGRITY pThis, uintptr /** * Fires a flush event if enabled. * - * @returns nothing. * @param pThis The driver instance data. * @param uGrp The group ID. * @param fAsync Flag whether this is an async request. @@ -847,7 +842,6 @@ DECLINLINE(void) drvdiskintTraceLogFireEvtFlush(PDRVDISKINTEGRITY pThis, uintptr /** * Fires a request complete event if enabled. * - * @returns nothing. * @param pThis The driver instance data. * @param uGrp The group ID. * @param rcReq Status code the request completed with. diff --git a/src/VBox/Devices/Storage/DrvHostBase.cpp b/src/VBox/Devices/Storage/DrvHostBase.cpp index 23b2806aada..0808bdf37c1 100644 --- a/src/VBox/Devices/Storage/DrvHostBase.cpp +++ b/src/VBox/Devices/Storage/DrvHostBase.cpp @@ -1148,7 +1148,6 @@ static int drvHostBaseStatsRegister(PDRVHOSTBASE pThis) /** * Deregisters statistics associated with the given media driver. * - * @returns nothing. * @param pThis The media driver instance. */ static void drvhostBaseStatsDeregister(PDRVHOSTBASE pThis) diff --git a/src/VBox/Devices/Storage/DrvRamDisk.cpp b/src/VBox/Devices/Storage/DrvRamDisk.cpp index dc1b4b11aed..dac115a6719 100644 --- a/src/VBox/Devices/Storage/DrvRamDisk.cpp +++ b/src/VBox/Devices/Storage/DrvRamDisk.cpp @@ -1045,7 +1045,6 @@ static int drvramdiskMediaExIoReqReadWriteProcess(PDRVRAMDISK pThis, PPDMMEDIAEX /** * Frees a I/O memory buffer allocated previously. * - * @returns nothing. * @param pThis VBox disk container instance data. * @param pIoReq I/O request for which to free memory. */ diff --git a/src/VBox/Devices/Storage/DrvVD.cpp b/src/VBox/Devices/Storage/DrvVD.cpp index 9fd7af8bbee..73b91166796 100644 --- a/src/VBox/Devices/Storage/DrvVD.cpp +++ b/src/VBox/Devices/Storage/DrvVD.cpp @@ -2475,7 +2475,6 @@ static int drvvdMediaExIoReqRemove(PVBOXDISK pThis, PPDMMEDIAEXIOREQINT pIoReq) * Retires a given I/O request marking it as complete and notiyfing the * device/driver above about the completion if requested. * - * @returns VBox status code. * @param pThis VBox disk container instance data. * @param pIoReq I/O request to complete. * @param rcReq The status code the request completed with. @@ -3026,7 +3025,6 @@ static int drvvdMediaExIoReqReadWriteProcess(PVBOXDISK pThis, PPDMMEDIAEXIOREQIN /** * Tries to process any requests waiting for available I/O memory. * - * @returns nothing. * @param pThis VBox disk container instance data. */ static void drvvdMediaExIoReqProcessWaiting(PVBOXDISK pThis) @@ -3107,7 +3105,6 @@ static void drvvdMediaExIoReqProcessWaiting(PVBOXDISK pThis) /** * Frees a I/O memory buffer allocated previously. * - * @returns nothing. * @param pThis VBox disk container instance data. * @param pIoReq I/O request for which to free memory. */ @@ -3185,7 +3182,6 @@ DECLINLINE(const char *) drvvdMediaExIoReqTypeStringify(PDMMEDIAEXIOREQTYPE enmT /** * Dumps the interesting bits about the given I/O request to the release log. * - * @returns nothing. * @param pThis VBox disk container instance data. * @param pIoReq The I/O request to dump. */ @@ -4200,7 +4196,6 @@ static int drvvdStatsRegister(PVBOXDISK pThis) /** * Deregisters statistics associated with the given media driver. * - * @returns nothing. * @param pThis The media driver instance. */ static void drvvdStatsDeregister(PVBOXDISK pThis) @@ -4283,7 +4278,6 @@ static DECLCALLBACK(int) drvvdLoadDone(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM) /** * Worker for the power off or destruct callback. * - * @returns nothing. * @param pDrvIns The driver instance. */ static void drvvdPowerOffOrDestructOrUnmount(PPDMDRVINS pDrvIns) diff --git a/src/VBox/Devices/Storage/HBDMgmt-darwin.cpp b/src/VBox/Devices/Storage/HBDMgmt-darwin.cpp index a0bb0961592..aee80ad72ed 100644 --- a/src/VBox/Devices/Storage/HBDMgmt-darwin.cpp +++ b/src/VBox/Devices/Storage/HBDMgmt-darwin.cpp @@ -123,7 +123,6 @@ typedef HBDMGRDACLBKARGS *PHBDMGRDACLBKARGS; /** * Unclaims the given block device and frees its state removing it from the list. * - * @returns nothing. * @param pDev The block device to unclaim. */ static void hbdMgrDevUnclaim(PHBDMGRDEV pDev) @@ -294,7 +293,6 @@ static DADissenterRef hbdMgrDAMountApprovalCallback(DADiskRef hDiskRef, void *pv * * Dummy handler for the wakeup source to kick the worker thread. * - * @returns nothing. * @param pInfo Opaque user data given during source creation, unused. */ static void hbdMgrDAPerformWakeup(void *pInfo) diff --git a/src/VBox/Devices/Storage/HBDMgmt-win.cpp b/src/VBox/Devices/Storage/HBDMgmt-win.cpp index 96807c1d344..e1378beb61f 100644 --- a/src/VBox/Devices/Storage/HBDMgmt-win.cpp +++ b/src/VBox/Devices/Storage/HBDMgmt-win.cpp @@ -94,7 +94,6 @@ typedef HBDMGRINT *PHBDMGRINT; /** * Unclaims the given block device and frees its state removing it from the list. * - * @returns nothing. * @param pDev The block device to unclaim. */ static void hbdMgrDevUnclaim(PHBDMGRDEV pDev) diff --git a/src/VBox/Devices/Storage/HBDMgmt.h b/src/VBox/Devices/Storage/HBDMgmt.h index b09fece71ba..ee3872d5192 100644 --- a/src/VBox/Devices/Storage/HBDMgmt.h +++ b/src/VBox/Devices/Storage/HBDMgmt.h @@ -56,7 +56,6 @@ DECLHIDDEN(int) HBDMgrCreate(PHBDMGR phHbdMgr); /** * Destroys the given block device manager unclaiming all managed block devices. * - * @returns nothing. * @param hHbdMgr The block device manager. */ DECLHIDDEN(void) HBDMgrDestroy(HBDMGR hHbdMgr); diff --git a/src/VBox/Devices/Storage/IOBufMgmt.cpp b/src/VBox/Devices/Storage/IOBufMgmt.cpp index 863b8bf9a22..546f4706bc7 100644 --- a/src/VBox/Devices/Storage/IOBufMgmt.cpp +++ b/src/VBox/Devices/Storage/IOBufMgmt.cpp @@ -175,7 +175,6 @@ DECLINLINE(void *) iobufMgrBinObjRemove(PIOBUFMGRBIN pBin) /** * Resets the bins to factory default (memory resigin in the largest bin). * - * @returns nothing. * @param pThis The I/O buffer manager instance. */ static void iobufMgrResetBins(PIOBUFMGRINT pThis) diff --git a/src/VBox/Devices/Storage/IOBufMgmt.h b/src/VBox/Devices/Storage/IOBufMgmt.h index bf0d7e6cc37..0113008bcde 100644 --- a/src/VBox/Devices/Storage/IOBufMgmt.h +++ b/src/VBox/Devices/Storage/IOBufMgmt.h @@ -110,7 +110,6 @@ DECLHIDDEN(int) IOBUFMgrAllocBuf(IOBUFMGR hIoBufMgr, PIOBUFDESC pIoBufDesc, size /** * Frees a given I/O buffer. * - * @returns nothing. * @param pIoBufDesc The I/O buffer descriptor to free. */ DECLHIDDEN(void) IOBUFMgrFreeBuf(PIOBUFDESC pIoBufDesc); diff --git a/src/VBox/Devices/Storage/UsbMsd.cpp b/src/VBox/Devices/Storage/UsbMsd.cpp index 91e92410204..a7f6219ece8 100644 --- a/src/VBox/Devices/Storage/UsbMsd.cpp +++ b/src/VBox/Devices/Storage/UsbMsd.cpp @@ -1077,7 +1077,6 @@ static int usbMsdResetWorker(PUSBMSD pThis, PVUSBURB pUrb, bool fSetConfig) /** * Process a completed request. * - * @returns nothing. * @param pThis The MSD instance. * @param pReq The request. * @param rcReq The completion status. diff --git a/src/VBox/Devices/Storage/VSCSI/VSCSIInternal.h b/src/VBox/Devices/Storage/VSCSI/VSCSIInternal.h index 8d7908351a9..4c58962eec0 100644 --- a/src/VBox/Devices/Storage/VSCSI/VSCSIInternal.h +++ b/src/VBox/Devices/Storage/VSCSI/VSCSIInternal.h @@ -320,7 +320,6 @@ typedef struct VSCSILUNDESC /** * Completes a SCSI request and calls the completion handler. * - * @returns nothing. * @param pVScsiDevice The virtual SCSI device. * @param pVScsiReq The request which completed. * @param rcScsiCode The status code @@ -334,7 +333,6 @@ void vscsiDeviceReqComplete(PVSCSIDEVICEINT pVScsiDevice, PVSCSIREQINT pVScsiReq /** * Init the sense data state. * - * @returns nothing. * @param pVScsiSense The SCSI sense data state to init. */ void vscsiSenseInit(PVSCSISENSE pVScsiSense); @@ -395,7 +393,6 @@ int vscsiVpdPagePoolInit(PVSCSIVPDPOOL pVScsiVpdPool); /** * Destroys the given VPD page pool freeing all pages in it. * - * @returns nothing. * @param pVScsiVpdPool The VPD page pool to destroy. */ void vscsiVpdPagePoolDestroy(PVSCSIVPDPOOL pVScsiVpdPool); @@ -494,7 +491,6 @@ uint32_t vscsiIoReqOutstandingCountGet(PVSCSILUNINT pVScsiLun); /** * Sets the transfer size for the given request. * - * @returns nothing. * @param pVScsiReq The SCSI request. * @param cbXfer The transfer size for the request. */ @@ -506,7 +502,6 @@ DECLINLINE(void) vscsiReqSetXferSize(PVSCSIREQINT pVScsiReq, size_t cbXfer) /** * Sets the transfer direction for the given request. * - * @returns nothing. * @param pVScsiReq The SCSI request. * @param cbXfer The transfer size for the request. */ diff --git a/src/VBox/Devices/Trace/DrvIfsTrace-serial.cpp b/src/VBox/Devices/Trace/DrvIfsTrace-serial.cpp index 4b69a80c701..998c282c5ae 100644 --- a/src/VBox/Devices/Trace/DrvIfsTrace-serial.cpp +++ b/src/VBox/Devices/Trace/DrvIfsTrace-serial.cpp @@ -430,7 +430,6 @@ static DECLCALLBACK(int) drvIfTraceISerialConnector_QueuesFlush(PPDMISERIALCONNE /** * Initializes serial port relaated interfaces. * - * @returns nothing. * @param pThis The interface callback trace driver instance. */ DECLHIDDEN(void) drvIfsTrace_SerialIfInit(PDRVIFTRACE pThis) diff --git a/src/VBox/Devices/USB/DevEHCI.cpp b/src/VBox/Devices/USB/DevEHCI.cpp index c0f9b5fe07a..317e5c36e20 100644 --- a/src/VBox/Devices/USB/DevEHCI.cpp +++ b/src/VBox/Devices/USB/DevEHCI.cpp @@ -1522,7 +1522,6 @@ DECLINLINE(void) ehciR3WriteQTD(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, PEHCI_QTD p * Updates the QHD in guest memory only updating portions of the QHD the controller * is allowed to write to. * - * @returns nothing. * @param pDevIns The device instance. * @param GCPhys Physical guest address of the QHD. * @param pQHD The QHD to update the guest memory with. @@ -4793,7 +4792,6 @@ static DECLCALLBACK(void) ehciR3Reset(PPDMDEVINS pDevIns) /** * Reset notification. * - * @returns VBox status code. * @param pDevIns The device instance data. */ static DECLCALLBACK(void) ehciR3Resume(PPDMDEVINS pDevIns) diff --git a/src/VBox/Devices/USB/DevOHCI.cpp b/src/VBox/Devices/USB/DevOHCI.cpp index 828a695411c..d5007bcb039 100644 --- a/src/VBox/Devices/USB/DevOHCI.cpp +++ b/src/VBox/Devices/USB/DevOHCI.cpp @@ -947,7 +947,6 @@ DECLINLINE(int) ohciR3SetInterruptInt(PPDMDEVINS pDevIns, POHCI ohci, int rcBusy /** * Sets the HC in the unrecoverable error state and raises the appropriate interrupt. * - * @returns nothing. * @param pDevIns The device instance. * @param pThis The OHCI instance. * @param iCode Diagnostic code. @@ -1480,7 +1479,6 @@ static void ohciR3PhysReadCacheRead(PPDMDEVINS pDevIns, POHCIPAGECACHE pPageCach * Updates the data in the given page cache if the given guest physical address is currently contained * in the cache. * - * @returns nothing. * @param pPageCache The page cache to update. * @param GCPhys The guest physical address needing the update. * @param pvBuf Pointer to the buffer to update the page cache with. @@ -1500,7 +1498,6 @@ static void ohciR3PhysCacheUpdate(POHCIPAGECACHE pPageCache, RTGCPHYS GCPhys, co /** * Update any cached ED data with the given endpoint descriptor at the given address. * - * @returns nothing. * @param pThisCC The OHCI instance data for the current context. * @param EdAddr Endpoint descriptor address. * @param pEd The endpoint descriptor which got updated. @@ -1514,7 +1511,6 @@ DECLINLINE(void) ohciR3CacheEdUpdate(POHCICC pThisCC, RTGCPHYS32 EdAddr, PCOHCIE /** * Update any cached TD data with the given transfer descriptor at the given address. * - * @returns nothing. * @param pThisCC The OHCI instance data, current context. * @param TdAddr Transfer descriptor address. * @param pTd The transfer descriptor which got updated. @@ -2555,7 +2551,6 @@ static uint32_t ohciR3VUsbStatus2OhciStatus(VUSBSTATUS enmStatus) /** * Lock the given OHCI controller instance. * - * @returns nothing. * @param pThisCC The OHCI controller instance to lock, ring-3 edition. */ DECLINLINE(void) ohciR3Lock(POHCICC pThisCC) @@ -2573,7 +2568,6 @@ DECLINLINE(void) ohciR3Lock(POHCICC pThisCC) /** * Unlocks the given OHCI controller instance. * - * @returns nothing. * @param pThisCC The OHCI controller instance to unlock, ring-3 edition. */ DECLINLINE(void) ohciR3Unlock(POHCICC pThisCC) @@ -5694,7 +5688,6 @@ static DECLCALLBACK(int) ohciR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uin /** * Reset notification. * - * @returns VBox status code. * @param pDevIns The device instance data. */ static DECLCALLBACK(void) ohciR3Reset(PPDMDEVINS pDevIns) @@ -5718,7 +5711,6 @@ static DECLCALLBACK(void) ohciR3Reset(PPDMDEVINS pDevIns) /** * Resume notification. * - * @returns VBox status code. * @param pDevIns The device instance data. */ static DECLCALLBACK(void) ohciR3Resume(PPDMDEVINS pDevIns) diff --git a/src/VBox/Devices/USB/DevXHCI.cpp b/src/VBox/Devices/USB/DevXHCI.cpp index 255a9f5cc4f..6b4bbc1d68b 100644 --- a/src/VBox/Devices/USB/DevXHCI.cpp +++ b/src/VBox/Devices/USB/DevXHCI.cpp @@ -5519,7 +5519,6 @@ static void xhciR3PortPower(PXHCI pThis, PXHCICC pThisCC, unsigned iPort, bool f /** * Port reset done callback. * - * @returns nothing. * @param pDevIns The device instance data. * @param iPort The XHCI port index of the port being resetted. */ diff --git a/src/VBox/Devices/USB/DrvVUSBRootHub.cpp b/src/VBox/Devices/USB/DrvVUSBRootHub.cpp index 07b26922938..bd407819dae 100644 --- a/src/VBox/Devices/USB/DrvVUSBRootHub.cpp +++ b/src/VBox/Devices/USB/DrvVUSBRootHub.cpp @@ -645,7 +645,6 @@ static void vusbRhR3CalcTimerIntervals(PVUSBROOTHUB pThis, uint32_t u32FrameRate * Calculates the new frame rate based on the idle detection and number of idle * cycles. * - * @returns nothing. * @param pThis The roothub instance data. * @param fIdle Flag whether the last frame didn't produce any activity. */ diff --git a/src/VBox/Devices/USB/VUSBDevice.cpp b/src/VBox/Devices/USB/VUSBDevice.cpp index 867802ec1d4..2017f94479e 100644 --- a/src/VBox/Devices/USB/VUSBDevice.cpp +++ b/src/VBox/Devices/USB/VUSBDevice.cpp @@ -1164,7 +1164,6 @@ static DECLCALLBACK(int) vusbDevCancelAllUrbsWorker(PVUSBDEV pDev, bool fDetachi * on a device. This is typically done as part of a reset and * before detaching a device. * - * @returns nothing. * @param pDev The VUSB device instance. * @param fDetaching If set, we will unconditionally unlink (and leak) * any URBs which isn't reaped. diff --git a/src/VBox/Devices/USB/VUSBInternal.h b/src/VBox/Devices/USB/VUSBInternal.h index 9b0eda3c4b8..fb28c198557 100644 --- a/src/VBox/Devices/USB/VUSBInternal.h +++ b/src/VBox/Devices/USB/VUSBInternal.h @@ -522,7 +522,6 @@ DECLHIDDEN(int) vusbUrbPoolInit(PVUSBURBPOOL pUrbPool); /** * Destroy a given URB pool freeing all ressources. * - * @returns nothing. * @param pUrbPool The URB pool to destroy. */ DECLHIDDEN(void) vusbUrbPoolDestroy(PVUSBURBPOOL pUrbPool); @@ -546,17 +545,16 @@ DECLHIDDEN(PVUSBURB) vusbUrbPoolAlloc(PVUSBURBPOOL pUrbPool, VUSBXFERTYPE enmTyp /** * Frees a given URB. * - * @returns nothing. * @param pUrbPool The URB pool the URB was allocated from. * @param pUrb The URB to free. */ DECLHIDDEN(void) vusbUrbPoolFree(PVUSBURBPOOL pUrbPool, PVUSBURB pUrb); #ifdef LOG_ENABLED + /** * Logs an URB in the debug log. * - * @returns nothing. * @param pUrb The URB to log. * @param pszMsg Additional message to log. * @param fComplete Flag whther the URB is completing. @@ -577,7 +575,8 @@ DECLHIDDEN(const char *) vusbUrbTypeName(VUSBXFERTYPE enmType); * Return the URB status as string from the given enum. */ DECLHIDDEN(const char *) vusbUrbStatusName(VUSBSTATUS enmStatus); -#endif + +#endif /* LOG_ENABLED*/ DECLINLINE(void) vusbUrbUnlink(PVUSBURB pUrb) { diff --git a/src/VBox/Devices/USB/VUSBSniffer.cpp b/src/VBox/Devices/USB/VUSBSniffer.cpp index 19b4636816d..2d51f189117 100644 --- a/src/VBox/Devices/USB/VUSBSniffer.cpp +++ b/src/VBox/Devices/USB/VUSBSniffer.cpp @@ -201,7 +201,6 @@ DECLHIDDEN(int) VUSBSnifferCreate(PVUSBSNIFFER phSniffer, uint32_t fFlags, /** * Destroys the given VUSB sniffer instance. * - * @returns nothing. * @param hSniffer The sniffer instance to destroy. */ DECLHIDDEN(void) VUSBSnifferDestroy(VUSBSNIFFER hSniffer) diff --git a/src/VBox/Devices/USB/VUSBSniffer.h b/src/VBox/Devices/USB/VUSBSniffer.h index 1fb6c26a5a4..50bd17fff3a 100644 --- a/src/VBox/Devices/USB/VUSBSniffer.h +++ b/src/VBox/Devices/USB/VUSBSniffer.h @@ -90,7 +90,6 @@ DECLHIDDEN(int) VUSBSnifferCreate(PVUSBSNIFFER phSniffer, uint32_t fFlags, /** * Destroys the given VUSB sniffer instance. * - * @returns nothing. * @param hSniffer The sniffer instance to destroy. */ DECLHIDDEN(void) VUSBSnifferDestroy(VUSBSNIFFER hSniffer); diff --git a/src/VBox/Devices/USB/VUSBSnifferInternal.h b/src/VBox/Devices/USB/VUSBSnifferInternal.h index 54da496eb43..8f3b5601013 100644 --- a/src/VBox/Devices/USB/VUSBSnifferInternal.h +++ b/src/VBox/Devices/USB/VUSBSnifferInternal.h @@ -87,7 +87,6 @@ typedef struct VUSBSNIFFERFMT /** * Destroys the format instance. * - * @returns nothing. * @param pThis Pointer to the format specific state. */ DECLR3CALLBACKMEMBER(void, pfnDestroy, (PVUSBSNIFFERFMTINT pThis)); diff --git a/src/VBox/Devices/USB/VUSBUrb.cpp b/src/VBox/Devices/USB/VUSBUrb.cpp index 8befaca1c46..7a407bc44d5 100644 --- a/src/VBox/Devices/USB/VUSBUrb.cpp +++ b/src/VBox/Devices/USB/VUSBUrb.cpp @@ -471,7 +471,6 @@ int vusbUrbQueueAsyncRh(PVUSBURB pUrb) /** * Send a control message *synchronously*. - * @return */ static void vusbMsgSubmitSynchronously(PVUSBURB pUrb, bool fSafeRequest) { @@ -1304,7 +1303,6 @@ void vusbUrbDoReapAsync(PRTLISTANCHOR pUrbLst, RTMSINTERVAL cMillies) /** * Reap URBs on a per device level. * - * @returns nothing. * @param pDev The device instance to reap URBs for. * @param cMillies Number of milliseconds to block in each reap operation. * Use 0 to not block at all. diff --git a/src/VBox/Devices/USB/darwin/USBProxyDevice-darwin.cpp b/src/VBox/Devices/USB/darwin/USBProxyDevice-darwin.cpp index 70061228b2e..83d06884bb5 100644 --- a/src/VBox/Devices/USB/darwin/USBProxyDevice-darwin.cpp +++ b/src/VBox/Devices/USB/darwin/USBProxyDevice-darwin.cpp @@ -309,7 +309,6 @@ static DECLCALLBACK(int32_t) usbProxyDarwinInitOnce(void *pvUser1) * Kicks the reaper thread if it sleeps currently to respond to state changes * or to pick up completed URBs. * - * @returns nothing. * @param pDevOsX The darwin device instance data. */ static void usbProxyDarwinReaperKick(PUSBPROXYDEVOSX pDevOsX) diff --git a/src/VBox/Devices/USB/linux/USBProxyDevice-linux.cpp b/src/VBox/Devices/USB/linux/USBProxyDevice-linux.cpp index 34ec1f458d4..de8b7412f1f 100644 --- a/src/VBox/Devices/USB/linux/USBProxyDevice-linux.cpp +++ b/src/VBox/Devices/USB/linux/USBProxyDevice-linux.cpp @@ -259,7 +259,6 @@ static void usbProxyLinuxSetConnected(PUSBPROXYDEV pProxyDev, int iIf, bool fCon /** * Links the given URB into the in flight list. * - * @returns nothing. * @param pDevLnx The proxy device instance - Linux specific data. * @param pUrbLnx The URB to link into the in flight list. */ @@ -275,7 +274,6 @@ static void usbProxyLinuxUrbLinkInFlight(PUSBPROXYDEVLNX pDevLnx, PUSBPROXYURBLN /** * Unlinks the given URB from the in flight list. * - * @returns nothing. * @param pDevLnx The proxy device instance - Linux specific data. * @param pUrbLnx The URB to link into the in flight list. */ diff --git a/src/VBox/Devices/USB/usbip/USBProxyDevice-usbip.cpp b/src/VBox/Devices/USB/usbip/USBProxyDevice-usbip.cpp index da60fa5963a..443958726e5 100644 --- a/src/VBox/Devices/USB/usbip/USBProxyDevice-usbip.cpp +++ b/src/VBox/Devices/USB/usbip/USBProxyDevice-usbip.cpp @@ -456,7 +456,6 @@ typedef struct USBPROXYDEVUSBIP /** * Converts a request/reply header from network to host endianness. * - * @returns nothing. * @param pHdr The header to convert. */ DECLINLINE(void) usbProxyUsbIpReqRetHdrN2H(PUsbIpReqRetHdr pHdr) @@ -471,7 +470,6 @@ DECLINLINE(void) usbProxyUsbIpReqRetHdrN2H(PUsbIpReqRetHdr pHdr) /** * Converts a request/reply header from host to network endianness. * - * @returns nothing. * @param pHdr The header to convert. */ DECLINLINE(void) usbProxyUsbIpReqRetHdrH2N(PUsbIpReqRetHdr pHdr) @@ -486,7 +484,6 @@ DECLINLINE(void) usbProxyUsbIpReqRetHdrH2N(PUsbIpReqRetHdr pHdr) /** * Converts a submit request from host to network endianness. * - * @returns nothing. * @param pReqSubmit The submit request to convert. */ DECLINLINE(void) usbProxyUsbIpReqSubmitH2N(PUsbIpReqSubmit pReqSubmit) @@ -502,7 +499,6 @@ DECLINLINE(void) usbProxyUsbIpReqSubmitH2N(PUsbIpReqSubmit pReqSubmit) /** * Converts a submit reply from network to host endianness. * - * @returns nothing. * @param pReqSubmit The submit reply to convert. */ DECLINLINE(void) usbProxyUsbIpRetSubmitN2H(PUsbIpRetSubmit pRetSubmit) @@ -518,7 +514,6 @@ DECLINLINE(void) usbProxyUsbIpRetSubmitN2H(PUsbIpRetSubmit pRetSubmit) /** * Converts a isochronous packet descriptor from host to network endianness. * - * @returns nothing. * @param pIsocPktDesc The packet descriptor to convert. */ DECLINLINE(void) usbProxyUsbIpIsocPktDescH2N(PUsbIpIsocPktDesc pIsocPktDesc) @@ -532,7 +527,6 @@ DECLINLINE(void) usbProxyUsbIpIsocPktDescH2N(PUsbIpIsocPktDesc pIsocPktDesc) /** * Converts a isochronous packet descriptor from network to host endianness. * - * @returns nothing. * @param pIsocPktDesc The packet descriptor to convert. */ DECLINLINE(void) usbProxyUsbIpIsocPktDescN2H(PUsbIpIsocPktDesc pIsocPktDesc) @@ -546,7 +540,6 @@ DECLINLINE(void) usbProxyUsbIpIsocPktDescN2H(PUsbIpIsocPktDesc pIsocPktDesc) /** * Converts a unlink request from host to network endianness. * - * @returns nothing. * @param pReqUnlink The unlink request to convert. */ DECLINLINE(void) usbProxyUsbIpReqUnlinkH2N(PUsbIpReqUnlink pReqUnlink) @@ -558,7 +551,6 @@ DECLINLINE(void) usbProxyUsbIpReqUnlinkH2N(PUsbIpReqUnlink pReqUnlink) /** * Converts a unlink reply from network to host endianness. * - * @returns nothing. * @param pRetUnlink The unlink reply to convert. */ DECLINLINE(void) usbProxyUsbIpRetUnlinkN2H(PUsbIpRetUnlink pRetUnlink) @@ -570,7 +562,6 @@ DECLINLINE(void) usbProxyUsbIpRetUnlinkN2H(PUsbIpRetUnlink pRetUnlink) /** * Convert the given exported device structure from host to network byte order. * - * @returns nothing. * @param pDevice The device structure to convert. */ DECLINLINE(void) usbProxyUsbIpExportedDeviceN2H(PUsbIpExportedDevice pDevice) @@ -623,7 +614,6 @@ DECLINLINE(uint32_t) usbProxyUsbIpSeqNumGet(PUSBPROXYDEVUSBIP pProxyDevUsbIp) /** * Links a given URB into the given list. * - * @returns nothing. * @param pProxyDevUsbIp The USB/IP proxy device data. * @param pList The list to link the URB into. * @param pUrbUsbIp The URB to link. @@ -639,7 +629,6 @@ DECLINLINE(void) usbProxyUsbIpLinkUrb(PUSBPROXYDEVUSBIP pProxyDevUsbIp, PRTLISTA /** * Unlinks a given URB from the current assigned list. * - * @returns nothing. * @param pProxyDevUsbIp The USB/IP proxy device data. * @param pUrbUsbIp The URB to unlink. */ @@ -666,7 +655,6 @@ static PUSBPROXYURBUSBIP usbProxyUsbIpUrbAlloc(PUSBPROXYDEVUSBIP pProxyDevUsbIp) /** * Frees the given USB/IP URB state. * - * @returns nothing. * @param pProxyDevUsbIp The USB/IP proxy device data. * @param pUrbUsbIp The USB/IP speciic URB data. */ @@ -896,7 +884,6 @@ static PUSBPROXYURBUSBIP usbProxyUsbIpGetCancelledUrbFromSeqNum(PUSBPROXYDEVUSBI /** * Resets the receive state for a new reply. * - * @returns nothing. * @param pProxyDevUsbIp The USB/IP proxy device data. */ static void usbProxyUsbIpResetRecvState(PUSBPROXYDEVUSBIP pProxyDevUsbIp) diff --git a/src/VBox/Devices/VMMDev/VMMDevTesting.cpp b/src/VBox/Devices/VMMDev/VMMDevTesting.cpp index 21c738928e6..098ef4dfb3b 100644 --- a/src/VBox/Devices/VMMDev/VMMDevTesting.cpp +++ b/src/VBox/Devices/VMMDev/VMMDevTesting.cpp @@ -998,7 +998,6 @@ static DECLCALLBACK(int) vmmdevR3TestingLockingThreadWakeup(PPDMDEVINS pDevIns, /** * Initializes the testing part of the VMMDev if enabled. * - * @returns VBox status code. * @param pDevIns The VMMDev device instance. */ void vmmdevR3TestingTerminate(PPDMDEVINS pDevIns) diff --git a/src/VBox/Devices/VirtIO/VirtioCore.h b/src/VBox/Devices/VirtIO/VirtioCore.h index 51924c58299..61d00ad8d91 100644 --- a/src/VBox/Devices/VirtIO/VirtioCore.h +++ b/src/VBox/Devices/VirtIO/VirtioCore.h @@ -550,7 +550,6 @@ void virtioCoreResetAll(PVIRTIOCORE pVirtio); /** * Resets the device state upon a VM reset for instance. * - * @returns nothing. * @param pVirtio Pointer to the virtio state. * * @note Calls back into the upper device when the status changes. diff --git a/src/VBox/Devices/testcase/tstDeviceCfg.cpp b/src/VBox/Devices/testcase/tstDeviceCfg.cpp index 97fbdfe94c5..a0a93fa1f73 100644 --- a/src/VBox/Devices/testcase/tstDeviceCfg.cpp +++ b/src/VBox/Devices/testcase/tstDeviceCfg.cpp @@ -75,7 +75,6 @@ static int tstDevCfgErrorRc(PRTERRINFO pErrInfo, int rc, const char *pszFormat, /** * Destroys the given configuration item array freeing all allocated resources. * - * @returns nothing. * @param paCfg The configuration item array to destroy. * @param cCfgItems Number of items in the array. */ diff --git a/src/VBox/Devices/testcase/tstDeviceCfg.h b/src/VBox/Devices/testcase/tstDeviceCfg.h index 1083fca223f..c514f987b82 100644 --- a/src/VBox/Devices/testcase/tstDeviceCfg.h +++ b/src/VBox/Devices/testcase/tstDeviceCfg.h @@ -160,7 +160,6 @@ DECLHIDDEN(int) tstDevCfgLoad(const char *pszCfgFilename, PRTERRINFO pErrInfo, P /** * Destroys the given test configuration freeing all allocated resources. * - * @returns nothing. * @param pDevTstCfg The test configuration to destroy. */ DECLHIDDEN(void) tstDevCfgDestroy(PCTSTDEVCFG pDevTstCfg); diff --git a/src/VBox/Frontends/VBoxAutostart/VBoxAutostart.h b/src/VBox/Frontends/VBoxAutostart/VBoxAutostart.h index ec96bf43e4f..d18c874203f 100644 --- a/src/VBox/Frontends/VBoxAutostart/VBoxAutostart.h +++ b/src/VBox/Frontends/VBoxAutostart/VBoxAutostart.h @@ -149,7 +149,6 @@ DECLHIDDEN(void) autostartSvcShowVersion(bool fBrief); /** * Log messages to the system and release log. * - * @returns nothing. * @param pszMsg Message to log. * @param enmLogType Log type to use. */ @@ -185,7 +184,6 @@ DECLHIDDEN(int) autostartParseConfig(const char *pszFilename, PCFGAST *ppCfgAst) /** * Destroys the config AST and frees all resources. * - * @returns nothing. * @param pCfgAst The config AST. */ DECLHIDDEN(void) autostartConfigAstDestroy(PCFGAST pCfgAst); diff --git a/src/VBox/Frontends/VBoxAutostart/VBoxAutostartCfg.cpp b/src/VBox/Frontends/VBoxAutostart/VBoxAutostartCfg.cpp index 341aab056eb..a58305eafd5 100644 --- a/src/VBox/Frontends/VBoxAutostart/VBoxAutostartCfg.cpp +++ b/src/VBox/Frontends/VBoxAutostart/VBoxAutostartCfg.cpp @@ -131,7 +131,6 @@ typedef struct CFGTOKENIZER /** * Free a config token. * - * @returns nothing. * @param pCfgTokenizer The config tokenizer. * @param pToken The token to free. */ @@ -321,7 +320,6 @@ static int autostartConfigTokenizerCreateToken(PCFGTOKENIZER pCfgTokenizer, /** * Destroys the given config tokenizer. * - * @returns nothing. * @param pCfgTokenizer The config tokenizer to destroy. */ static void autostartConfigTokenizerDestroy(PCFGTOKENIZER pCfgTokenizer) diff --git a/src/VBox/Frontends/VBoxManage/VBoxInternalManage.cpp b/src/VBox/Frontends/VBoxManage/VBoxInternalManage.cpp index 102ae12c350..aafd9a78de3 100644 --- a/src/VBox/Frontends/VBoxManage/VBoxInternalManage.cpp +++ b/src/VBox/Frontends/VBoxManage/VBoxInternalManage.cpp @@ -404,7 +404,6 @@ static RTEXITCODE errorGetOptInternal(USAGECATEGORY enmCommand, int vrc, union R * Externally visible wrapper around printUsageInternal() to dump the * complete usage text. * - * @returns nothing. * @param pStrm The stream to dump the usage text to. */ DECLHIDDEN(void) printUsageInternalCmds(PRTSTREAM pStrm) diff --git a/src/VBox/HostDrivers/Support/SUPDrvInternal.h b/src/VBox/HostDrivers/Support/SUPDrvInternal.h index 5a4f88563c9..c3a07509010 100644 --- a/src/VBox/HostDrivers/Support/SUPDrvInternal.h +++ b/src/VBox/HostDrivers/Support/SUPDrvInternal.h @@ -1069,7 +1069,6 @@ int VBOXCALL supdrvOSInitGipGroupTable(PSUPDRVDEVEXT pDevExt, PSUPGLOBALINFOP * * This is currently only implemented on windows [lazy bird]. * - * @returns CPU group number. * @param pDevExt The device globals. * @param pGip The GIP. * @param pGipCpu The GIP CPU structure being initialized. diff --git a/src/VBox/HostDrivers/Support/SUPDrvTracer.cpp b/src/VBox/HostDrivers/Support/SUPDrvTracer.cpp index 578969b01d5..54aa444200c 100644 --- a/src/VBox/HostDrivers/Support/SUPDrvTracer.cpp +++ b/src/VBox/HostDrivers/Support/SUPDrvTracer.cpp @@ -2477,7 +2477,6 @@ int VBOXCALL supdrvTracerInit(PSUPDRVDEVEXT pDevExt) /** * Late module termination hook. * - * @returns VBox status code. * @param pDevExt The device extension structure. */ void VBOXCALL supdrvTracerTerm(PSUPDRVDEVEXT pDevExt) diff --git a/src/VBox/HostDrivers/Support/SUPR0IdcClientStubs.c b/src/VBox/HostDrivers/Support/SUPR0IdcClientStubs.c index 97ed333fa67..dc5435d1ced 100644 --- a/src/VBox/HostDrivers/Support/SUPR0IdcClientStubs.c +++ b/src/VBox/HostDrivers/Support/SUPR0IdcClientStubs.c @@ -46,8 +46,6 @@ /** * Resolves a symbol. * - * @returns Pointer to the symbol on success, NULL on failure. - * * @param pHandle The IDC handle. * @param ppfn Where to return the address of the symbol. * @param pszName The name of the symbol. @@ -74,8 +72,6 @@ static void supR0IdcGetSymbol(PSUPDRVIDCHANDLE pHandle, PFNRT *ppfn, const char /** * Resolves a symbol. * - * @returns Pointer to the symbol on success, NULL on failure. - * * @param pSession The IDC session. * @param ppfn Where to return the address of the symbol. * @param pszName The name of the symbol. diff --git a/src/VBox/HostDrivers/Support/SUPR3HardenedMain.cpp b/src/VBox/HostDrivers/Support/SUPR3HardenedMain.cpp index b12e8450934..bd9a0535056 100644 --- a/src/VBox/HostDrivers/Support/SUPR3HardenedMain.cpp +++ b/src/VBox/HostDrivers/Support/SUPR3HardenedMain.cpp @@ -1176,9 +1176,6 @@ static void suplibHardenedPathStripFilename(char *pszPath) } -/** - * @copydoc RTPathFilename - */ DECLHIDDEN(char *) supR3HardenedPathFilename(const char *pszPath) { const char *psz = pszPath; @@ -1212,9 +1209,6 @@ DECLHIDDEN(char *) supR3HardenedPathFilename(const char *pszPath) } -/** - * @copydoc RTPathAppPrivateNoArch - */ DECLHIDDEN(int) supR3HardenedPathAppPrivateNoArch(char *pszPath, size_t cchPath) { #if !defined(RT_OS_WINDOWS) && defined(RTPATH_APP_PRIVATE) @@ -1231,9 +1225,6 @@ DECLHIDDEN(int) supR3HardenedPathAppPrivateNoArch(char *pszPath, size_t cchPath) } -/** - * @copydoc RTPathAppPrivateArch - */ DECLHIDDEN(int) supR3HardenedPathAppPrivateArch(char *pszPath, size_t cchPath) { #if !defined(RT_OS_WINDOWS) && defined(RTPATH_APP_PRIVATE_ARCH) @@ -1250,9 +1241,6 @@ DECLHIDDEN(int) supR3HardenedPathAppPrivateArch(char *pszPath, size_t cchPath) } -/** - * @copydoc RTPathSharedLibs - */ DECLHIDDEN(int) supR3HardenedPathAppSharedLibs(char *pszPath, size_t cchPath) { #if !defined(RT_OS_WINDOWS) && defined(RTPATH_SHARED_LIBS) @@ -1269,9 +1257,6 @@ DECLHIDDEN(int) supR3HardenedPathAppSharedLibs(char *pszPath, size_t cchPath) } -/** - * @copydoc RTPathAppDocs - */ DECLHIDDEN(int) supR3HardenedPathAppDocs(char *pszPath, size_t cchPath) { #if !defined(RT_OS_WINDOWS) && defined(RTPATH_APP_DOCS) @@ -1290,8 +1275,6 @@ DECLHIDDEN(int) supR3HardenedPathAppDocs(char *pszPath, size_t cchPath) /** * Returns the full path to the executable in g_szSupLibHardenedExePath. - * - * @returns IPRT status code. */ static void supR3HardenedGetFullExePath(void) { @@ -2244,7 +2227,6 @@ static unsigned supR3HardenedMainShouldPurgeArg(const char *pszArg) /** * Purges any command line arguments considered harmful. * - * @returns nothing. * @param cArgsOrig The original number of arguments. * @param papszArgsOrig The original argument vector. * @param pcArgsNew Where to store the new number of arguments on success. diff --git a/src/VBox/HostDrivers/Support/SUPSvc.cpp b/src/VBox/HostDrivers/Support/SUPSvc.cpp index 4361ee889ba..fdf7873e7b7 100644 --- a/src/VBox/HostDrivers/Support/SUPSvc.cpp +++ b/src/VBox/HostDrivers/Support/SUPSvc.cpp @@ -87,7 +87,6 @@ typedef struct SUPSVCSERVICE /** * Start the service. * - * @returns VBox status code, log entry is written on failure. * @param pvInstance The instance handle. */ DECLCALLBACKMEMBER(void, pfnStart,(void *pvInstance)); diff --git a/src/VBox/HostDrivers/Support/darwin/SUPR3HardenedMain-darwin.cpp b/src/VBox/HostDrivers/Support/darwin/SUPR3HardenedMain-darwin.cpp index 70ba8b09f2b..6fedcca6031 100644 --- a/src/VBox/HostDrivers/Support/darwin/SUPR3HardenedMain-darwin.cpp +++ b/src/VBox/HostDrivers/Support/darwin/SUPR3HardenedMain-darwin.cpp @@ -194,7 +194,6 @@ static int supR3HardenedDarwinIssetugidInterpose(void) /** * Callback to get notified of new images being loaded to be able to apply our dlopn() interposer. * - * @returns nothing. * @param mh Pointer to the mach header of the loaded image. * @param vmaddr_slide The slide value for ASLR. */ @@ -209,8 +208,6 @@ static DECLCALLBACK(void) supR3HardenedDarwinAddImage(const struct mach_header * /** * Hardening initialization for macOS hosts. * - * @returns nothing. - * * @note Doesn't return on error. */ DECLHIDDEN(void) supR3HardenedDarwinInit(void) diff --git a/src/VBox/HostDrivers/Support/freebsd/SUPDrv-freebsd.c b/src/VBox/HostDrivers/Support/freebsd/SUPDrv-freebsd.c index 75ad475f215..74cce2b7339 100644 --- a/src/VBox/HostDrivers/Support/freebsd/SUPDrv-freebsd.c +++ b/src/VBox/HostDrivers/Support/freebsd/SUPDrv-freebsd.c @@ -281,7 +281,6 @@ static int VBoxDrvFreeBSDOpenUsr(struct cdev *pDev, int fOpen, int iDevType, str /** * Close a file device previously opened by VBoxDrvFreeBSDOpen. * - * @returns 0 on success. * @param pvData The session being closed. */ static void vboxdrvFreeBSDDtr(void *pvData) diff --git a/src/VBox/HostDrivers/Support/posix/SUPR3HardenedMain-posix.cpp b/src/VBox/HostDrivers/Support/posix/SUPR3HardenedMain-posix.cpp index a06be6c8fe2..d5666d53601 100644 --- a/src/VBox/HostDrivers/Support/posix/SUPR3HardenedMain-posix.cpp +++ b/src/VBox/HostDrivers/Support/posix/SUPR3HardenedMain-posix.cpp @@ -642,8 +642,6 @@ static DECLCALLBACK(void) supR3HardenedPosixMonitorDlmopenResolve(void) /** * Hardening initialization for POSIX compatible hosts. * - * @returns nothing. - * * @note Doesn't return on error. */ DECLHIDDEN(void) supR3HardenedPosixInit(void) diff --git a/src/VBox/HostDrivers/VBoxNetAdp/VBoxNetAdpInternal.h b/src/VBox/HostDrivers/VBoxNetAdp/VBoxNetAdpInternal.h index da29afb3aee..e33ccae0495 100644 --- a/src/VBox/HostDrivers/VBoxNetAdp/VBoxNetAdpInternal.h +++ b/src/VBox/HostDrivers/VBoxNetAdp/VBoxNetAdpInternal.h @@ -176,7 +176,6 @@ DECLHIDDEN(int) vboxNetAdpOsInit(PVBOXNETADP pThis); /** * Counter part to vboxNetAdpOsCreate(). * - * @return IPRT status code. * @param pThis The new instance. * * @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port. diff --git a/src/VBox/HostDrivers/VBoxNetFlt/VBoxNetFltInternal.h b/src/VBox/HostDrivers/VBoxNetFlt/VBoxNetFltInternal.h index 1cd0fb0a5ad..b72c3d820b0 100644 --- a/src/VBox/HostDrivers/VBoxNetFlt/VBoxNetFltInternal.h +++ b/src/VBox/HostDrivers/VBoxNetFlt/VBoxNetFltInternal.h @@ -459,7 +459,6 @@ DECLHIDDEN(int) vboxNetFltOsConnectIt(PVBOXNETFLTINS pThis); /** * Counter part to vboxNetFltOsInitInstance(). * - * @return IPRT status code. * @param pThis The new instance. * * @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port. diff --git a/src/VBox/HostDrivers/VBoxNetFlt/darwin/VBoxNetFlt-darwin.cpp b/src/VBox/HostDrivers/VBoxNetFlt/darwin/VBoxNetFlt-darwin.cpp index 9f629179794..e73cd65161d 100644 --- a/src/VBox/HostDrivers/VBoxNetFlt/darwin/VBoxNetFlt-darwin.cpp +++ b/src/VBox/HostDrivers/VBoxNetFlt/darwin/VBoxNetFlt-darwin.cpp @@ -591,7 +591,6 @@ DECLINLINE(unsigned) vboxNetFltDarwinMBufCalcSGSegs(PVBOXNETFLTINS pThis, mbuf_t /** * Initializes a SG list from an mbuf. * - * @returns Number of segments. * @param pThis The instance. * @param pMBuf The mbuf. * @param pSG The SG. diff --git a/src/VBox/HostDrivers/VBoxNetFlt/linux/VBoxNetFlt-linux.c b/src/VBox/HostDrivers/VBoxNetFlt/linux/VBoxNetFlt-linux.c index eed12e8dcde..0c3d2f90cf0 100644 --- a/src/VBox/HostDrivers/VBoxNetFlt/linux/VBoxNetFlt-linux.c +++ b/src/VBox/HostDrivers/VBoxNetFlt/linux/VBoxNetFlt-linux.c @@ -836,7 +836,6 @@ DECLINLINE(unsigned) vboxNetFltLinuxGetChecksumStartOffset(struct sk_buff *pBuf) /** * Initializes a SG list from an sk_buff. * - * @returns Number of segments. * @param pThis The instance. * @param pBuf The sk_buff. * @param pSG The SG. diff --git a/src/VBox/HostDrivers/VBoxUSB/solaris/VBoxUSB-solaris.c b/src/VBox/HostDrivers/VBoxUSB/solaris/VBoxUSB-solaris.c index c6fe1762145..4bb05e27603 100644 --- a/src/VBox/HostDrivers/VBoxUSB/solaris/VBoxUSB-solaris.c +++ b/src/VBox/HostDrivers/VBoxUSB/solaris/VBoxUSB-solaris.c @@ -1567,8 +1567,6 @@ LOCAL int vboxUsbSolarisInitPower(vboxusb_state_t *pState) * * @param pState The USB device instance. * @remarks Requires the device state mutex to be held. - * - * @returns VBox status code. */ LOCAL void vboxUsbSolarisDestroyPower(vboxusb_state_t *pState) { diff --git a/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h b/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h index ede25ba883a..619a39d54be 100644 --- a/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h +++ b/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h @@ -365,7 +365,6 @@ void ShClBackendDestroy(PSHCLBACKEND pBackend); /** * Called when a new HGCM client connects. * - * @returns VBox status code. * @param pBackend Shared Clipboard backend to set callbacks for. * @param pCallbacks Backend callbacks to use. * When NULL is specified, the backend's default callbacks are being used. diff --git a/src/VBox/HostServices/auth/winlogon/winlogon.cpp b/src/VBox/HostServices/auth/winlogon/winlogon.cpp index 21c97fb258b..5bdbc142c64 100644 --- a/src/VBox/HostServices/auth/winlogon/winlogon.cpp +++ b/src/VBox/HostServices/auth/winlogon/winlogon.cpp @@ -107,24 +107,24 @@ static WCHAR *utf8ToWideChar(const char *pszString) } /* Prototype it to make sure we've got the right prototype. */ -extern "C" #if defined(_MSC_VER) -__declspec(dllexport) +extern "C" __declspec(dllexport) FNAUTHENTRY3 AuthEntry; +#else +extern "C" FNAUTHENTRY3 AuthEntry; #endif -FNAUTHENTRY3 AuthEntry; /** * @callback_method_impl{FNAUTHENTRY3} */ -extern "C" -AuthResult AUTHCALL AuthEntry(const char *pszCaller, - PAUTHUUID pUuid, - AuthGuestJudgement guestJudgement, - const char *pszUser, - const char *pszPassword, - const char *pszDomain, - int fLogon, - unsigned clientId) +extern "C" DECLEXPORT(AuthResult) AUTHCALL +AuthEntry(const char *pszCaller, + PAUTHUUID pUuid, + AuthGuestJudgement guestJudgement, + const char *pszUser, + const char *pszPassword, + const char *pszDomain, + int fLogon, + unsigned clientId) { RT_NOREF4(pszCaller, pUuid, guestJudgement, clientId); if (!fLogon) diff --git a/src/VBox/ImageMounter/vboximg-mount/vboximg-mount.cpp b/src/VBox/ImageMounter/vboximg-mount/vboximg-mount.cpp index d6f5d25fc32..173b03a4900 100644 --- a/src/VBox/ImageMounter/vboximg-mount/vboximg-mount.cpp +++ b/src/VBox/ImageMounter/vboximg-mount/vboximg-mount.cpp @@ -818,8 +818,6 @@ static int vboximgOp_readlink(const char *pszPath, char *buf, size_t size) /** * Displays the list of volumes on the opened image. - * - * @returns nothing. */ static void vboxImgMntVolumesDisplay(void) { diff --git a/src/VBox/Main/include/GuestCtrlImplPrivate.h b/src/VBox/Main/include/GuestCtrlImplPrivate.h index a9365b74b9f..1ad99a3cbe5 100644 --- a/src/VBox/Main/include/GuestCtrlImplPrivate.h +++ b/src/VBox/Main/include/GuestCtrlImplPrivate.h @@ -512,7 +512,7 @@ public: } /** - * @copydoc copy() + * @copydoc GuestEnvironment::copy() */ GuestEnvironment &operator=(const GuestEnvironmentBase &rThat) { @@ -522,11 +522,11 @@ public: return *this; } - /** @copydoc copy() */ + /** @copydoc GuestEnvironment::copy() */ GuestEnvironment &operator=(const GuestEnvironment &rThat) { return operator=((const GuestEnvironmentBase &)rThat); } - /** @copydoc copy() */ + /** @copydoc GuestEnvironment::copy() */ GuestEnvironment &operator=(const GuestEnvironmentChanges &rThat) { return operator=((const GuestEnvironmentBase &)rThat); } @@ -594,7 +594,8 @@ public: } /** - * @copydoc copy() + * @copydoc GuestEnvironmentChanges::copy() + * @throws HRESULT */ GuestEnvironmentChanges &operator=(const GuestEnvironmentBase &rThat) { @@ -604,11 +605,13 @@ public: return *this; } - /** @copydoc copy() */ + /** @copydoc GuestEnvironmentChanges::copy() + * @throws HRESULT */ GuestEnvironmentChanges &operator=(const GuestEnvironmentChanges &rThat) { return operator=((const GuestEnvironmentBase &)rThat); } - /** @copydoc copy() */ + /** @copydoc GuestEnvironmentChanges::copy() + * @throws HRESULT */ GuestEnvironmentChanges &operator=(const GuestEnvironment &rThat) { return operator=((const GuestEnvironmentBase &)rThat); } }; diff --git a/src/VBox/Main/include/GuestSessionImpl.h b/src/VBox/Main/include/GuestSessionImpl.h index 8188eb51606..0a5a4e73e19 100644 --- a/src/VBox/Main/include/GuestSessionImpl.h +++ b/src/VBox/Main/include/GuestSessionImpl.h @@ -360,7 +360,8 @@ public: /** @} */ /** @name Public internal methods for supporting older Guest Additions via - VBoxService' built-in toolbox (< 7.1). */ + * VBoxService' built-in toolbox (< 7.1). + * @{ */ int i_directoryCreateViaToolbox(const Utf8Str &strPath, uint32_t uMode, uint32_t uFlags, int *pvrcGuest); int i_fileRemoveViaToolbox(const Utf8Str &strPath, int *pvrcGuest); int i_fsCreateTempViaToolbox(const Utf8Str &strTemplate, const Utf8Str &strPath, bool fDirectory, Utf8Str &strName, diff --git a/src/VBox/Main/src-all/NvramStoreImpl.cpp b/src/VBox/Main/src-all/NvramStoreImpl.cpp index 035aee3369d..e22bc3df892 100644 --- a/src/VBox/Main/src-all/NvramStoreImpl.cpp +++ b/src/VBox/Main/src-all/NvramStoreImpl.cpp @@ -611,8 +611,8 @@ int NvramStore::i_loadStoreFromTar(RTVFSFSSTREAM hVfsFssTar) return vrc; } - #ifdef VBOX_WITH_FULL_VM_ENCRYPTION + /** * Sets up the encryption or decryption machinery. * @@ -674,7 +674,6 @@ int NvramStore::i_setupEncryptionOrDecryption(RTVFSIOSTREAM hVfsIosInOut, bool f /** * Releases all resources acquired in NvramStore::i_setupEncryptionOrDecryption(). * - * @returns nothing. * @param hVfsIos Handle to the I/O stream previously created. * @param pCryptoIf Pointer to the cryptographic interface being released. * @param pKey Pointer to the key buffer being released. @@ -690,8 +689,8 @@ void NvramStore::i_releaseEncryptionOrDecryptionResources(RTVFSIOSTREAM hVfsIos, pKey->release(); RTVfsIoStrmRelease(hVfsIos); } -#endif +#endif /* VBOX_WITH_FULL_VM_ENCRYPTION */ /** * Loads the NVRAM store. diff --git a/src/VBox/Main/src-all/win/VBoxProxyStub.c b/src/VBox/Main/src-all/win/VBoxProxyStub.c index a46c2711cfd..32a89ad49ae 100644 --- a/src/VBox/Main/src-all/win/VBoxProxyStub.c +++ b/src/VBox/Main/src-all/win/VBoxProxyStub.c @@ -1319,7 +1319,6 @@ LSTATUS VbpsRegisterClassId(VBPSREGSTATE *pState, const CLSID *pClsId, const cha /** * Register modules and classes from the VirtualBox.xidl file. * - * @returns COM status code. * @param pState * @param pwszVBoxDir The VirtualBox application directory. * @param fIs32On64 Set if this is the 32-bit on 64-bit component. diff --git a/src/VBox/Main/src-client/ConsoleImpl.cpp b/src/VBox/Main/src-client/ConsoleImpl.cpp index 6d2353c658e..d0c3b932968 100644 --- a/src/VBox/Main/src-client/ConsoleImpl.cpp +++ b/src/VBox/Main/src-client/ConsoleImpl.cpp @@ -11872,7 +11872,6 @@ DECLCALLBACK(void *) Console::i_drvStatus_QueryInterface(PPDMIBASE pInterface, /** * Destruct a status driver instance. * - * @returns VBox status code. * @param pDrvIns The driver instance data. */ DECLCALLBACK(void) Console::i_drvStatus_Destruct(PPDMDRVINS pDrvIns) diff --git a/src/VBox/Main/src-client/DisplayImpl.cpp b/src/VBox/Main/src-client/DisplayImpl.cpp index e80e8dd5cc0..a6b301cac38 100644 --- a/src/VBox/Main/src-client/DisplayImpl.cpp +++ b/src/VBox/Main/src-client/DisplayImpl.cpp @@ -3685,7 +3685,6 @@ DECLCALLBACK(void) Display::i_drvPowerOff(PPDMDRVINS pDrvIns) /** * Destruct a display driver instance. * - * @returns VBox status code. * @param pDrvIns The driver instance data. */ DECLCALLBACK(void) Display::i_drvDestruct(PPDMDRVINS pDrvIns) diff --git a/src/VBox/Main/src-client/DrvAudioRec.cpp b/src/VBox/Main/src-client/DrvAudioRec.cpp index 98baf77cd65..4d281ce4601 100644 --- a/src/VBox/Main/src-client/DrvAudioRec.cpp +++ b/src/VBox/Main/src-client/DrvAudioRec.cpp @@ -629,7 +629,6 @@ static DECLCALLBACK(void *) drvAudioVideoRecQueryInterface(PPDMIBASE pInterface, /** * Shuts down (closes) a recording sink, * - * @returns VBox status code. * @param pSink Recording sink to shut down. */ static void avRecSinkShutdown(PAVRECSINK pSink) diff --git a/src/VBox/Main/src-client/GuestImpl.cpp b/src/VBox/Main/src-client/GuestImpl.cpp index 4108dfae607..a18fab16d73 100644 --- a/src/VBox/Main/src-client/GuestImpl.cpp +++ b/src/VBox/Main/src-client/GuestImpl.cpp @@ -1080,7 +1080,6 @@ bool Guest::i_facilityUpdate(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacil /** * Issued by the guest when a guest user changed its state. * - * @return IPRT status code. * @param aUser Guest user name. * @param aDomain Domain of guest user account. Optional. * @param enmState New state to indicate. diff --git a/src/VBox/Main/src-client/HGCM.cpp b/src/VBox/Main/src-client/HGCM.cpp index fed932212c6..19ea49d9baf 100644 --- a/src/VBox/Main/src-client/HGCM.cpp +++ b/src/VBox/Main/src-client/HGCM.cpp @@ -468,9 +468,8 @@ int HGCMService::loadServiceDLL(void) return vrc; } -/** Helper function to free a local service DLL. - * - * @return VBox code +/** + * Helper function to free a local service DLL. */ void HGCMService::unloadServiceDLL(void) { @@ -2098,7 +2097,6 @@ int HGCMService::GuestCall(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmd, uint32_t * @param pHGCMPort The port to be used for completion confirmation * @param pCmd The VBox HGCM context. * @param idClient The client handle to be disconnected and deleted. - * @return VBox status code. */ void HGCMService::GuestCancelled(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmd, uint32_t idClient) { diff --git a/src/VBox/Main/src-client/KeyboardImpl.cpp b/src/VBox/Main/src-client/KeyboardImpl.cpp index ba0e766e5d3..c8c4bb12764 100644 --- a/src/VBox/Main/src-client/KeyboardImpl.cpp +++ b/src/VBox/Main/src-client/KeyboardImpl.cpp @@ -410,7 +410,6 @@ DECLCALLBACK(void *) Keyboard::i_drvQueryInterface(PPDMIBASE pInterface, const c /** * Destruct a keyboard driver instance. * - * @returns VBox status code. * @param pDrvIns The driver instance data. */ DECLCALLBACK(void) Keyboard::i_drvDestruct(PPDMDRVINS pDrvIns) diff --git a/src/VBox/Main/src-client/MouseImpl.cpp b/src/VBox/Main/src-client/MouseImpl.cpp index 288fdf6a3d0..bd5425ea40f 100644 --- a/src/VBox/Main/src-client/MouseImpl.cpp +++ b/src/VBox/Main/src-client/MouseImpl.cpp @@ -1262,7 +1262,6 @@ DECLCALLBACK(void *) Mouse::i_drvQueryInterface(PPDMIBASE pInterface, const cha /** * Destruct a mouse driver instance. * - * @returns VBox status code. * @param pDrvIns The driver instance data. */ DECLCALLBACK(void) Mouse::i_drvDestruct(PPDMDRVINS pDrvIns) diff --git a/src/VBox/Main/src-client/RecordingInternals.cpp b/src/VBox/Main/src-client/RecordingInternals.cpp index 604bb55edb7..20da636fbb5 100644 --- a/src/VBox/Main/src-client/RecordingInternals.cpp +++ b/src/VBox/Main/src-client/RecordingInternals.cpp @@ -31,6 +31,7 @@ #include #ifdef VBOX_WITH_AUDIO_RECORDING + /** * Initializes a recording frame. * @@ -92,7 +93,8 @@ void RecordingAudioFrameFree(PRECORDINGAUDIOFRAME pFrame) RTMemFree(pFrame); pFrame = NULL; } -#endif + +#endif /* VBOX_WITH_AUDIO_RECORDING */ /** * Destroys a recording video frame. @@ -112,7 +114,6 @@ void RecordingVideoFrameDestroy(PRECORDINGVIDEOFRAME pFrame) /** * Frees a recording video frame. * - * @returns VBox status code. * @param pFrame Pointer to video frame to free. The pointer will be invalid after return. */ void RecordingVideoFrameFree(PRECORDINGVIDEOFRAME pFrame) @@ -128,7 +129,6 @@ void RecordingVideoFrameFree(PRECORDINGVIDEOFRAME pFrame) /** * Frees a recording frame. * - * @returns VBox status code. * @param pFrame Pointer to recording frame to free. The pointer will be invalid after return. */ void RecordingFrameFree(PRECORDINGFRAME pFrame) diff --git a/src/VBox/Main/src-server/MachineImpl.cpp b/src/VBox/Main/src-server/MachineImpl.cpp index af782db33cf..50c5797015b 100644 --- a/src/VBox/Main/src-server/MachineImpl.cpp +++ b/src/VBox/Main/src-server/MachineImpl.cpp @@ -5414,7 +5414,6 @@ private: * @note Locks this object for writing. * * @param task - * @return */ void Machine::i_deleteConfigHandler(DeleteConfigTask &task) { @@ -13535,7 +13534,6 @@ private: * @note Locks this object for writing. * * @param task - * @return */ void SessionMachine::i_saveStateHandler(SaveStateTask &task) { diff --git a/src/VBox/Main/src-server/MediumImpl.cpp b/src/VBox/Main/src-server/MediumImpl.cpp index 5ef5b1eae52..1e607a0a0e9 100644 --- a/src/VBox/Main/src-server/MediumImpl.cpp +++ b/src/VBox/Main/src-server/MediumImpl.cpp @@ -5190,7 +5190,6 @@ bool Medium::i_isReadOnly() /** * Internal method to update the medium's id. Must have caller + locking! - * @return */ void Medium::i_updateId(const Guid &id) { diff --git a/src/VBox/Main/src-server/SnapshotImpl.cpp b/src/VBox/Main/src-server/SnapshotImpl.cpp index cd5a5ca7ec0..42347dc3621 100644 --- a/src/VBox/Main/src-server/SnapshotImpl.cpp +++ b/src/VBox/Main/src-server/SnapshotImpl.cpp @@ -1726,7 +1726,6 @@ HRESULT SessionMachine::takeSnapshot(const com::Utf8Str &aName, * @note Locks this object for writing. * * @param task - * @return */ void SessionMachine::i_takeSnapshotHandler(TakeSnapshotTask &task) { diff --git a/src/VBox/Main/src-server/USBProxyBackend.cpp b/src/VBox/Main/src-server/USBProxyBackend.cpp index 15e69b6a4c0..56bde261e33 100644 --- a/src/VBox/Main/src-server/USBProxyBackend.cpp +++ b/src/VBox/Main/src-server/USBProxyBackend.cpp @@ -200,7 +200,6 @@ int USBProxyBackend::captureDevice(HostUSBDevice *aDevice) * * This is used by the proxy to release temporary filters. * - * @returns VBox status code. * @param aDevice The device in question. * @param aSuccess Whether it succeeded or failed. */ @@ -232,7 +231,6 @@ int USBProxyBackend::releaseDevice(HostUSBDevice *aDevice) * * This is used by the proxy to release temporary filters. * - * @returns VBox status code. * @param aDevice The device in question. * @param aSuccess Whether it succeeded or failed. */ diff --git a/src/VBox/Main/src-server/USBProxyService.cpp b/src/VBox/Main/src-server/USBProxyService.cpp index 03823e3cd56..342088ff312 100644 --- a/src/VBox/Main/src-server/USBProxyService.cpp +++ b/src/VBox/Main/src-server/USBProxyService.cpp @@ -643,7 +643,6 @@ void USBProxyService::i_deviceRemoved(ComObjPtr &aDevice) * * This is responsible for calling HostUSBDevice::updateState(). * - * @returns true if there is a state change. * @param aDevice The device in question. * @param aUSBDevice The USB device structure for the last enumeration. * @param fFakeUpdate Flag whether to fake updating state. diff --git a/src/VBox/Main/src-server/UefiVariableStoreImpl.cpp b/src/VBox/Main/src-server/UefiVariableStoreImpl.cpp index 65300842039..f3163de032e 100644 --- a/src/VBox/Main/src-server/UefiVariableStoreImpl.cpp +++ b/src/VBox/Main/src-server/UefiVariableStoreImpl.cpp @@ -713,7 +713,6 @@ uint32_t UefiVariableStore::i_uefiVarAttrToMask(const std::vector& VirtualBox::i_performanceCollector() cons /** * Returns the default machine folder from the system properties * with proper locking. - * @return */ void VirtualBox::i_getDefaultMachineFolder(Utf8Str &str) const { @@ -4425,7 +4424,6 @@ void VirtualBox::i_getDefaultMachineFolder(Utf8Str &str) const /** * Returns the default hard disk format from the system properties * with proper locking. - * @return */ void VirtualBox::i_getDefaultHardDiskFormat(Utf8Str &str) const { @@ -5513,8 +5511,6 @@ void VirtualBox::i_unmarkRegistryModified(const Guid &uuid) * * This locks machines and the VirtualBox object as necessary, so better not * hold any locks before calling this. - * - * @return */ void VirtualBox::i_saveModifiedRegistries() { diff --git a/src/VBox/Main/src-server/darwin/iokit.cpp b/src/VBox/Main/src-server/darwin/iokit.cpp index ec93290cd36..ac6974ba70a 100644 --- a/src/VBox/Main/src-server/darwin/iokit.cpp +++ b/src/VBox/Main/src-server/darwin/iokit.cpp @@ -927,7 +927,6 @@ static bool darwinUSBDeviceIsGrabbedDetermineState(PUSBDEVICE pCur, io_object_t * Worker for determining the USB device state for devices which are not captured by the VBoxUSB driver * Works for both, IOUSBDevice (legacy on release >= El Capitan) and IOUSBHostDevice (available on >= El Capitan). * - * @returns nothing. * @param pCur The USB device data. * @param USBDevice I/O Kit USB device object (either IOUSBDevice or IOUSBHostDevice). */ diff --git a/src/VBox/Main/src-server/generic/USBProxyBackendUsbIp.cpp b/src/VBox/Main/src-server/generic/USBProxyBackendUsbIp.cpp index 9e9e91c5fea..f66990ee4fa 100644 --- a/src/VBox/Main/src-server/generic/USBProxyBackendUsbIp.cpp +++ b/src/VBox/Main/src-server/generic/USBProxyBackendUsbIp.cpp @@ -262,7 +262,6 @@ struct USBProxyBackendUsbIp::Data /** * Convert the given exported device structure from host to network byte order. * - * @returns nothing. * @param pDevice The device structure to convert. */ DECLINLINE(void) usbProxyBackendUsbIpExportedDeviceN2H(PUsbIpExportedDevice pDevice) @@ -659,7 +658,6 @@ PUSBDEVICE USBProxyBackendUsbIp::getDevices(void) /** * Frees a given device list. * - * @returns nothing. * @param pHead The head of the device list to free. */ void USBProxyBackendUsbIp::freeDeviceList(PUSBDEVICE pHead) @@ -675,8 +673,6 @@ void USBProxyBackendUsbIp::freeDeviceList(PUSBDEVICE pHead) /** * Resets the receive state to the idle state. - * - * @returns nothing. */ void USBProxyBackendUsbIp::resetRecvState() { @@ -694,8 +690,6 @@ void USBProxyBackendUsbIp::resetRecvState() /** * Disconnects from the host and resets the receive state. - * - * @returns nothing. */ void USBProxyBackendUsbIp::disconnect() { @@ -803,7 +797,6 @@ int USBProxyBackendUsbIp::startListExportedDevicesReq() /** * Advances the state machine to the given state. * - * @returns nothing. * @param enmRecvState The new receive state. */ void USBProxyBackendUsbIp::advanceState(USBIPRECVSTATE enmRecvState) diff --git a/src/VBox/Main/src-server/linux/HostHardwareLinux.cpp b/src/VBox/Main/src-server/linux/HostHardwareLinux.cpp index 8d8da113c5a..8526627322b 100644 --- a/src/VBox/Main/src-server/linux/HostHardwareLinux.cpp +++ b/src/VBox/Main/src-server/linux/HostHardwareLinux.cpp @@ -167,7 +167,6 @@ static bool floppyGetName(const char *pcszNode, unsigned Number, floppy_drive_na * We deliberately return an ugly sequence of characters as the description * rather than an English language string to avoid translation issues. * - * @returns true if we know the device to be valid, false otherwise * @param pcszName the floppy driver name for the device (optional) * @param Number the number of the floppy (0 to 3 on FDC 0, 4 to 7 on * FDC 1) diff --git a/src/VBox/Main/testcase/tstVBoxCrypto.cpp b/src/VBox/Main/testcase/tstVBoxCrypto.cpp index 34126ba7893..2ee84715747 100644 --- a/src/VBox/Main/testcase/tstVBoxCrypto.cpp +++ b/src/VBox/Main/testcase/tstVBoxCrypto.cpp @@ -239,7 +239,6 @@ static int tstCryptoVfsReadAndVerify(RTVFSFILE hVfsFile, size_t cbFile) /** * Testing some basics of the encrypted file VFS code. * - * @returns nothing. * @param pCryptoIf Pointer to the callback table. */ static void tstCryptoVfsBasics(PCVBOXCRYPTOIF pCryptoIf) @@ -325,7 +324,6 @@ static void tstCryptoVfsBasics(PCVBOXCRYPTOIF pCryptoIf) /** * Testing some basics of the crypto keystore code. * - * @returns nothing. * @param pCryptoIf Pointer to the callback table. */ static void tstCryptoKeyStoreBasics(PCVBOXCRYPTOIF pCryptoIf) diff --git a/src/VBox/Main/webservice/vboxweb.cpp b/src/VBox/Main/webservice/vboxweb.cpp index e6c22843b03..45865398663 100644 --- a/src/VBox/Main/webservice/vboxweb.cpp +++ b/src/VBox/Main/webservice/vboxweb.cpp @@ -1789,7 +1789,6 @@ static bool SplitManagedObjectRef(const WSDLT_ID &id, * @param sz Buffer with at least 34 bytes space to receive MOR string. * @param websessId * @param objId - * @return */ static void MakeManagedObjectRef(char *sz, uint64_t websessId, diff --git a/src/VBox/Main/xml/ovfreader.cpp b/src/VBox/Main/xml/ovfreader.cpp index 1f74386fcb5..ab2e53fcc82 100644 --- a/src/VBox/Main/xml/ovfreader.cpp +++ b/src/VBox/Main/xml/ovfreader.cpp @@ -146,7 +146,6 @@ void OVFReader::parse() * @param pReferencesElem "References" element from OVF, for looking up file specifications; * can be NULL if no such element is present. * @param pCurElem Element whose children are to be analyzed here. - * @return */ void OVFReader::LoopThruSections(const xml::ElementNode *pReferencesElem, const xml::ElementNode *pCurElem) @@ -317,8 +316,6 @@ void OVFReader::HandleDiskSection(const xml::ElementNode *pReferencesElem, /** * Private helper method that handles network sections in the OVF XML. * Gets called indirectly from IAppliance::read(). - * - * @return */ void OVFReader::HandleNetworkSection(const xml::ElementNode * /* pSectionElem */) { @@ -344,7 +341,6 @@ void OVFReader::HandleNetworkSection(const xml::ElementNode * /* pSectionElem */ * Gets called indirectly from IAppliance::read(). * * @param pelmVirtualSystem - * @return */ void OVFReader::HandleVirtualSystemContent(const xml::ElementNode *pelmVirtualSystem) { diff --git a/src/VBox/Runtime/Doxyfile b/src/VBox/Runtime/Doxyfile index c3b5d01429d..5a0d39746a3 100644 --- a/src/VBox/Runtime/Doxyfile +++ b/src/VBox/Runtime/Doxyfile @@ -2135,6 +2135,8 @@ PREDEFINED += \ RT_ASM_DECL_PRAGMA_WATCOM(type)=type \ RT_ASM_DECL_PRAGMA_WATCOM_386(type)=type \ DECLNORETURN(type)=type \ + DECL_CHECK_RETURN(type)=type \ + DECL_CHECK_RETURN_NOT_R3(type)=type \ RTCALL= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this diff --git a/src/VBox/Runtime/common/dvm/dvmbsdlabel.cpp b/src/VBox/Runtime/common/dvm/dvmbsdlabel.cpp index 2c53c4c6165..440ddce3bcd 100644 --- a/src/VBox/Runtime/common/dvm/dvmbsdlabel.cpp +++ b/src/VBox/Runtime/common/dvm/dvmbsdlabel.cpp @@ -209,7 +209,6 @@ static uint16_t rtDvmFmtBsdLblDiskLabelChkSum(PBsdLabel pBsdLabel) /** * Converts a partition entry to the host endianness. * - * @returns nothing. * @param pPartition The partition to decode. */ static void rtDvmFmtBsdLblDiskLabelDecodePartition(PBsdLabelPartition pPartition) diff --git a/src/VBox/Runtime/common/efi/efivarstorevfs.cpp b/src/VBox/Runtime/common/efi/efivarstorevfs.cpp index 337744570c4..16f5d3c11cd 100644 --- a/src/VBox/Runtime/common/efi/efivarstorevfs.cpp +++ b/src/VBox/Runtime/common/efi/efivarstorevfs.cpp @@ -332,10 +332,10 @@ static int rtEfiVarStore_NewDirByType(PRTEFIVARSTORE pThis, RTEFIVARSTOREDIRTYPE #ifdef LOG_ENABLED + /** * Logs a firmware volume header. * - * @returns nothing. * @param pFvHdr The firmware volume header. */ static void rtEfiVarStoreFvHdr_Log(PCEFI_FIRMWARE_VOLUME_HEADER pFvHdr) @@ -360,7 +360,6 @@ static void rtEfiVarStoreFvHdr_Log(PCEFI_FIRMWARE_VOLUME_HEADER pFvHdr) /** * Logs a variable store header. * - * @returns nothing. * @param pStoreHdr The variable store header. */ static void rtEfiVarStoreHdr_Log(PCEFI_VARSTORE_HEADER pStoreHdr) @@ -379,7 +378,6 @@ static void rtEfiVarStoreHdr_Log(PCEFI_VARSTORE_HEADER pStoreHdr) /** * Logs a authenticated variable header. * - * @returns nothing. * @param pVarHdr The authenticated variable header. * @param offVar Offset of the authenticated variable header. */ @@ -410,8 +408,8 @@ static void rtEfiVarStoreAuthVarHdr_Log(PCEFI_AUTH_VAR_HEADER pVarHdr, uint64_t Log2(("EfiVarStore: GuidVendor %#.*Rhxs\n", sizeof(pVarHdr->GuidVendor), &pVarHdr->GuidVendor)); } } -#endif +#endif /* LOG_ENABLED */ /** * Worker for rtEfiVarStoreFile_QueryInfo() and rtEfiVarStoreDir_QueryInfo(). diff --git a/src/VBox/Runtime/common/fs/extvfs.cpp b/src/VBox/Runtime/common/fs/extvfs.cpp index 67aa281adf6..ab9f6359be0 100644 --- a/src/VBox/Runtime/common/fs/extvfs.cpp +++ b/src/VBox/Runtime/common/fs/extvfs.cpp @@ -270,10 +270,10 @@ typedef struct RTFSEXTVOL static int rtFsExtVol_OpenDirByInode(PRTFSEXTVOL pThis, uint32_t iInode, PRTVFSDIR phVfsDir); #ifdef LOG_ENABLED + /** * Logs the ext filesystem superblock. * - * @returns nothing. * @param pSb Pointer to the superblock. */ static void rtFsExtSb_Log(PCEXTSUPERBLOCK pSb) @@ -415,7 +415,6 @@ static void rtFsExtSb_Log(PCEXTSUPERBLOCK pSb) /** * Logs a ext filesystem block group descriptor. * - * @returns nothing. * @param pThis The ext volume instance. * @param iBlockGroup Block group number. * @param pBlockGroup Pointer to the block group. @@ -459,7 +458,6 @@ static void rtFsExtBlockGroup_Log(PRTFSEXTVOL pThis, uint32_t iBlockGroup, PCEXT /** * Logs a ext filesystem inode. * - * @returns nothing. * @param pThis The ext volume instance. * @param iInode Inode number. * @param pInode Pointer to the inode. @@ -520,7 +518,6 @@ static void rtFsExtInode_Log(PRTFSEXTVOL pThis, uint32_t iInode, PCEXTINODECOMB /** * Logs a ext filesystem directory entry. * - * @returns nothing. * @param pThis The ext volume instance. * @param idxDirEntry Directory entry index number. * @param pDirEntry The directory entry. @@ -553,7 +550,6 @@ static void rtFsExtDirEntry_Log(PRTFSEXTVOL pThis, uint32_t idxDirEntry, PCEXTDI /** * Logs an extent header. * - * @returns nothing. * @param pExtentHdr The extent header node. */ static void rtFsExtExtentHdr_Log(PCEXTEXTENTHDR pExtentHdr) @@ -573,7 +569,6 @@ static void rtFsExtExtentHdr_Log(PCEXTEXTENTHDR pExtentHdr) /** * Logs an extent index node. * - * @returns nothing. * @param pExtentIdx The extent index node. */ static void rtFsExtExtentIdx_Log(PCEXTEXTENTIDX pExtentIdx) @@ -591,7 +586,6 @@ static void rtFsExtExtentIdx_Log(PCEXTEXTENTIDX pExtentIdx) /** * Logs an extent. * - * @returns nothing. * @param pExtent The extent. */ static void rtFsExtExtent_Log(PCEXTEXTENT pExtent) @@ -605,8 +599,8 @@ static void rtFsExtExtent_Log(PCEXTEXTENT pExtent) Log2(("EXT: offStartLow %#RX16\n", RT_LE2H_U16(pExtent->offStartLow))); } } -#endif +#endif /* LOG_ENABLED */ /** * Converts a block number to a byte offset. @@ -722,7 +716,6 @@ static PRTFSEXTBLOCKENTRY rtFsExtVol_BlockGetNew(PRTFSEXTVOL pThis, uint64_t iBl /** * Frees the given block. * - * @returns nothing. * @param pThis The ext volume instance. * @param pBlock The block to free. */ @@ -808,7 +801,6 @@ static int rtFsExtVol_BlockLoad(PRTFSEXTVOL pThis, uint64_t iBlock, PRTFSEXTBLOC /** * Releases a reference of the given block. * - * @returns nothing. * @param pThis The ext volume instance. * @param pBlock The block to release. */ @@ -846,7 +838,6 @@ static PRTFSEXTBLKGRP rtFsExtBlockGroupAlloc(PRTFSEXTVOL pThis, size_t cbAlloc, /** * Frees the given block group. * - * @returns nothing. * @param pThis The ext volume instance. * @param pBlockGroup The block group to free. */ @@ -984,7 +975,6 @@ static int rtFsExtBlockGroupLoad(PRTFSEXTVOL pThis, uint32_t iBlockGroup, PRTFSE /** * Releases a reference of the given block group. * - * @returns nothing. * @param pThis The ext volume instance. * @param pBlockGroup The block group to release. */ @@ -1020,7 +1010,6 @@ static PRTFSEXTINODE rtFsExtInodeAlloc(PRTFSEXTVOL pThis, uint32_t iInode) /** * Frees the given inode. * - * @returns nothing. * @param pThis The ext volume instance. * @param pInode The inode to free. */ @@ -1235,7 +1224,6 @@ static int rtFsExtInodeLoad(PRTFSEXTVOL pThis, uint32_t iInode, PRTFSEXTINODE *p /** * Releases a reference of the given inode. * - * @returns nothing. * @param pThis The ext volume instance. * @param pInode The inode to release. */ diff --git a/src/VBox/Runtime/common/fs/xfsvfs.cpp b/src/VBox/Runtime/common/fs/xfsvfs.cpp index d33e9a2e13a..d5ce2063780 100644 --- a/src/VBox/Runtime/common/fs/xfsvfs.cpp +++ b/src/VBox/Runtime/common/fs/xfsvfs.cpp @@ -266,7 +266,6 @@ static int rtFsXfsVol_OpenDirByInode(PRTFSXFSVOL pThis, uint32_t iInode, PRTVFSD /** * Logs the XFS filesystem superblock. * - * @returns nothing. * @param iAg The allocation group number for the given super block. * @param pSb Pointer to the superblock. */ @@ -348,7 +347,6 @@ static void rtFsXfsSb_Log(uint32_t iAg, PCXFSSUPERBLOCK pSb) /** * Logs a AG free space block. * - * @returns nothing. * @param iAg The allocation group number for the given free space block. * @param pAgf The AG free space block. */ @@ -387,7 +385,6 @@ static void rtFsXfsAgf_Log(uint32_t iAg, PCXFSAGF pAgf) /** * Loads an AG inode information block. * - * @returns nothing. * @param iAg The allocation group number for the given inode information block. * @param pAgi The AG inode information block. */ @@ -418,7 +415,6 @@ static void rtFsXfsAgi_Log(uint32_t iAg, PCXFSAGI pAgi) /** * Logs a XFS filesystem inode. * - * @returns nothing. * @param pThis The XFS volume instance. * @param iInode Inode number. * @param pInode Pointer to the inode. @@ -491,7 +487,6 @@ static void rtFsXfsInode_Log(PRTFSXFSVOL pThis, XFSINO iInode, PCXFSINODECORE pI /** * Logs a XFS filesystem directory entry. * - * @returns nothing. * @param pThis The XFS volume instance. * @param idxDirEntry Directory entry index number. * @param pDirEntry The directory entry. @@ -536,7 +531,6 @@ DECLINLINE(uint64_t) rtFsXfsDiskOffsetToBlockIdx(PRTFSXFSVOL pThis, uint64_t off * Splits the given absolute inode number into the AG number, block inside the AG * and the offset into the block where to find the inode structure. * - * @returns nothing. * @param pThis The XFS volume instance. * @param iInode The inode to split. * @param piAg Where to store the AG number. @@ -647,7 +641,6 @@ static PRTFSXFSBLOCKENTRY rtFsXfsVol_BlockGetNew(PRTFSXFSVOL pThis, uint64_t iBl /** * Frees the given block. * - * @returns nothing. * @param pThis The XFS volume instance. * @param pBlock The block to free. */ @@ -733,7 +726,6 @@ static int rtFsXfsVol_BlockLoad(PRTFSXFSVOL pThis, uint64_t iBlock, PRTFSXFSBLOC /** * Releases a reference of the given block. * - * @returns nothing. * @param pThis The XFS volume instance. * @param pBlock The block to release. */ @@ -769,7 +761,6 @@ static PRTFSXFSAG rtFsXfsAg_Alloc(PRTFSXFSVOL pThis, uint32_t iAg) /** * Frees the given allocation group. * - * @returns nothing. * @param pThis The XFS volume instance. * @param pAg The allocation group to free. */ @@ -888,7 +879,6 @@ static int rtFsXfsAg_Load(PRTFSXFSVOL pThis, uint32_t iAg, PRTFSXFSAG *ppAg) /** * Releases a reference of the given allocation group. * - * @returns nothing. * @param pThis The XFS volume instance. * @param pAg The allocation group to release. */ @@ -925,7 +915,6 @@ static PRTFSXFSINODE rtFsXfsInode_Alloc(PRTFSXFSVOL pThis, uint32_t iInode) /** * Frees the given inode. * - * @returns nothing. * @param pThis The XFS volume instance. * @param pInode The inode to free. */ @@ -1132,7 +1121,6 @@ static int rtFsXfsInode_Load(PRTFSXFSVOL pThis, XFSINO iInode, PRTFSXFSINODE *pp /** * Releases a reference of the given inode. * - * @returns nothing. * @param pThis The XFS volume instance. * @param pInode The inode to release. */ diff --git a/src/VBox/Runtime/common/fuzz/fuzz-config.cpp b/src/VBox/Runtime/common/fuzz/fuzz-config.cpp index a05ea19b99b..d9d71bc080f 100644 --- a/src/VBox/Runtime/common/fuzz/fuzz-config.cpp +++ b/src/VBox/Runtime/common/fuzz/fuzz-config.cpp @@ -519,7 +519,6 @@ static int rtFuzzCfgAddFuzzCtxInputs(PRTFUZZCFGINT pThis, RTJSONVAL hJsonValCorp /** * Destroys the given fuzzing config. * - * @returns nothing. * @param pThis The fuzzing config instance to destroy. */ static void rtFuzzCfgDestroy(PRTFUZZCFGINT pThis) diff --git a/src/VBox/Runtime/common/fuzz/fuzz-observer.cpp b/src/VBox/Runtime/common/fuzz/fuzz-observer.cpp index 8ee09bb28d7..9e4941394a3 100644 --- a/src/VBox/Runtime/common/fuzz/fuzz-observer.cpp +++ b/src/VBox/Runtime/common/fuzz/fuzz-observer.cpp @@ -438,7 +438,6 @@ static int rtFuzzObsExecCtxCreate(PPRTFUZZOBSEXECCTX ppExecCtx, PRTFUZZOBSINT pT /** * Destroys the given execution context. * - * @returns nothing. * @param pThis The internal fuzzing observer state. * @param pExecCtx The execution context to destroy. */ diff --git a/src/VBox/Runtime/common/fuzz/fuzz-target-recorder.cpp b/src/VBox/Runtime/common/fuzz/fuzz-target-recorder.cpp index c2446ed4772..04d3c89a11f 100644 --- a/src/VBox/Runtime/common/fuzz/fuzz-target-recorder.cpp +++ b/src/VBox/Runtime/common/fuzz/fuzz-target-recorder.cpp @@ -184,7 +184,6 @@ typedef struct RTFUZZTGTRECINT /** * Initializes the given stdout/stderr buffer. * - * @returns nothing. * @param pBuf The buffer to initialize. */ static void rtFuzzTgtStdOutErrBufInit(PRTFUZZTGTSTDOUTERRBUF pBuf) @@ -198,7 +197,6 @@ static void rtFuzzTgtStdOutErrBufInit(PRTFUZZTGTSTDOUTERRBUF pBuf) /** * Frees all allocated resources in the given stdout/stderr buffer. * - * @returns nothing. * @param pBuf The buffer to free. */ static void rtFuzzTgtStdOutErrBufFree(PRTFUZZTGTSTDOUTERRBUF pBuf) @@ -357,7 +355,6 @@ static int rtFuzzTgtRecScanStateForNewEdges(PRTFUZZTGTRECINT pThis, PRTFUZZTGTST /** * Destorys the given fuzzer target recorder freeing all allocated resources. * - * @returns nothing. * @param pThis The fuzzer target recorder instance. */ static void rtFuzzTgtRecDestroy(PRTFUZZTGTRECINT pThis) @@ -369,7 +366,6 @@ static void rtFuzzTgtRecDestroy(PRTFUZZTGTRECINT pThis) /** * Destroys the given fuzzer target state freeing all allocated resources. * - * @returns nothing. * @param pThis The fuzzed target state instance. */ static void rtFuzzTgtStateDestroy(PRTFUZZTGTSTATEINT pThis) diff --git a/src/VBox/Runtime/common/fuzz/fuzz.cpp b/src/VBox/Runtime/common/fuzz/fuzz.cpp index 5fe237e3104..cafd459efd4 100644 --- a/src/VBox/Runtime/common/fuzz/fuzz.cpp +++ b/src/VBox/Runtime/common/fuzz/fuzz.cpp @@ -574,7 +574,6 @@ static void *rtFuzzCtxMemoryAlloc(PRTFUZZCTXINT pThis, size_t cb) /** * Frees the given memory. * - * @returns nothing. * @param pThis The fuzzer context instance. * @param pv Pointer to the memory area to free. */ @@ -619,7 +618,6 @@ static bool rtFuzzCtxMutationAllocReclaim(PRTFUZZCTXINT pThis, size_t cb) /** * Updates the cache status of the given mutation. * - * @returns nothing. * @param pThis The fuzzer context instance. * @param pMutation The mutation to update. */ @@ -654,7 +652,6 @@ static void rtFuzzCtxMutationMaybeEnterCache(PRTFUZZCTXINT pThis, PRTFUZZMUTATIO /** * Removes a cached mutation from the cache. * - * @returns nothing. * @param pThis The fuzzer context instance. * @param pMutation The mutation to remove. */ @@ -674,7 +671,6 @@ static void rtFuzzCtxMutationCacheRemove(PRTFUZZCTXINT pThis, PRTFUZZMUTATION pM /** * Destroys the given mutation. * - * @returns nothing. * @param pMutation The mutation to destroy. */ static void rtFuzzMutationDestroy(PRTFUZZMUTATION pMutation) @@ -869,7 +865,6 @@ DECLINLINE(PRTFUZZMUTATION) rtFuzzMutationCreate(PRTFUZZCTXINT pThis, uint64_t o /** * Destroys the given fuzzer context freeing all allocated resources. * - * @returns nothing. * @param pThis The fuzzer context instance. */ static void rtFuzzCtxDestroy(PRTFUZZCTXINT pThis) @@ -1512,7 +1507,6 @@ static int rtFuzzCtxCreateEmpty(PRTFUZZCTXINT *ppThis, RTFUZZCTXTYPE enmType) /** * Destroys the given fuzzing input. * - * @returns nothing. * @param pThis The fuzzing input to destroy. */ static void rtFuzzInputDestroy(PRTFUZZINPUTINT pThis) diff --git a/src/VBox/Runtime/common/fuzz/fuzzmastercmd.cpp b/src/VBox/Runtime/common/fuzz/fuzzmastercmd.cpp index 5488630afd0..ec8b306d935 100644 --- a/src/VBox/Runtime/common/fuzz/fuzzmastercmd.cpp +++ b/src/VBox/Runtime/common/fuzz/fuzzmastercmd.cpp @@ -1579,7 +1579,6 @@ static int rtFuzzCmdMasterFuzzCfgLoadFromFile(PRTFUZZCMDMASTER pThis, const char /** * Destroys all running fuzzers for the given master state. * - * @returns nothing. * @param pThis The fuzzing master command state. */ static void rtFuzzCmdMasterDestroy(PRTFUZZCMDMASTER pThis) @@ -1591,7 +1590,6 @@ static void rtFuzzCmdMasterDestroy(PRTFUZZCMDMASTER pThis) /** * Sends an ACK response to the client. * - * @returns nothing. * @param hSocket The socket handle to send the ACK to. * @param pszResponse Additional response data. */ @@ -1622,7 +1620,6 @@ static void rtFuzzCmdMasterTcpSendAck(RTSOCKET hSocket, const char *pszResponse) /** * Sends an NACK response to the client. * - * @returns nothing. * @param hSocket The socket handle to send the ACK to. * @param pErrInfo Optional error information to send along. */ diff --git a/src/VBox/Runtime/common/ioqueue/ioqueue-stdfile-provider.cpp b/src/VBox/Runtime/common/ioqueue/ioqueue-stdfile-provider.cpp index 80b08d14877..4cfb0b93aa7 100644 --- a/src/VBox/Runtime/common/ioqueue/ioqueue-stdfile-provider.cpp +++ b/src/VBox/Runtime/common/ioqueue/ioqueue-stdfile-provider.cpp @@ -152,7 +152,6 @@ typedef RTIOQUEUEPROVINT *PRTIOQUEUEPROVINT; /** * Processes the given submission queue entry and reports back the result in the completion queue. * - * @returns nothing. * @param pSqEntry The submission queue entry to process. * @param pCqEntry The comppletion queue entry to store the result in. */ diff --git a/src/VBox/Runtime/common/log/tracelogreader.cpp b/src/VBox/Runtime/common/log/tracelogreader.cpp index 5d283fb5adc..a7a59504950 100644 --- a/src/VBox/Runtime/common/log/tracelogreader.cpp +++ b/src/VBox/Runtime/common/log/tracelogreader.cpp @@ -304,7 +304,6 @@ DECLINLINE(int) rtTraceLogRdrStreamRead(PRTTRACELOGRDRINT pThis, void *pvBuf, si /** * Converts the header endianess to the host endianess. * - * @returns nothing. * @param pHdr The trace log header to convert. */ static void rtTraceLogRdrHdrEndianessConv(PTRACELOGHDR pHdr) @@ -320,7 +319,6 @@ static void rtTraceLogRdrHdrEndianessConv(PTRACELOGHDR pHdr) /** * Converts the event descriptor endianess to the host endianess. * - * @returns nothing. * @param pEvtDesc The trace log event descriptor to convert. */ static void rtTraceLogRdrEvtDescEndianessConv(PTRACELOGEVTDESC pEvtDesc) @@ -336,7 +334,6 @@ static void rtTraceLogRdrEvtDescEndianessConv(PTRACELOGEVTDESC pEvtDesc) /** * Converts the event item descriptor endianess to host endianess. * - * @returns nothing. * @param pEvtItemDesc The trace log event item descriptor to convert. */ static void rtTraceLogRdrEvtItemDescEndianessConv(PTRACELOGEVTITEMDESC pEvtItemDesc) @@ -351,7 +348,6 @@ static void rtTraceLogRdrEvtItemDescEndianessConv(PTRACELOGEVTITEMDESC pEvtItemD /** * Converts the event marker endianess to host endianess. * - * @returns nothing. * @param pEvt The trace log event marker to convert. */ static void rtTraceLogRdrEvtEndianessConv(PTRACELOGEVT pEvt) @@ -532,7 +528,6 @@ static size_t rtTraceLogRdrGetEvtItemDataSz(PRTTRACELOGRDRINT pThis, PCRTTRACELO /** * Calculates the overall event data size from the items in the event descriptor. * - * @returns nothing. * @param pThis The trace log reader instance. * @param pEvtDesc The event descriptor. */ diff --git a/src/VBox/Runtime/common/misc/json.cpp b/src/VBox/Runtime/common/misc/json.cpp index 71b4859871c..8f5975d3439 100644 --- a/src/VBox/Runtime/common/misc/json.cpp +++ b/src/VBox/Runtime/common/misc/json.cpp @@ -361,7 +361,6 @@ DECLINLINE(bool) rtJsonTokenizerIsEos(PRTJSONTOKENIZER pTokenizer) /** * Skip one character in the input stream. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ DECLINLINE(void) rtJsonTokenizerSkipCh(PRTJSONTOKENIZER pTokenizer) @@ -406,7 +405,6 @@ DECLINLINE(char) rtJsonTokenizerGetCh(PRTJSONTOKENIZER pTokenizer) /** * Sets a new line for the tokenizer. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param cSkip Amount of characters to skip making up the new line. */ @@ -445,7 +443,6 @@ DECLINLINE(bool) rtJsonTokenizerIsSkipNewLine(PRTJSONTOKENIZER pTokenizer) * Skip all whitespace starting from the current input buffer position. * Skips all present comments too. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ DECLINLINE(void) rtJsonTokenizerSkipWhitespace(PRTJSONTOKENIZER pTokenizer) @@ -947,7 +944,6 @@ static int rtJsonTokenizerInit(PRTJSONTOKENIZER pTokenizer, PFNRTJSONTOKENIZERRE /** * Cleans up any resources still in control of the given token. * - * @returns nothing. * @param pToken The toke nto clean up. */ static void rtJsonTokenizerTokenCleanup(PRTJSONTOKEN pToken) @@ -960,7 +956,6 @@ static void rtJsonTokenizerTokenCleanup(PRTJSONTOKEN pToken) /** * Destroys a given tokenizer state. * - * @returns nothing. * @param pTokenizer The tokenizer to destroy. */ static void rtJsonTokenizerDestroy(PRTJSONTOKENIZER pTokenizer) @@ -990,7 +985,6 @@ DECLINLINE(int) rtJsonTokenizerGetToken(PRTJSONTOKENIZER pTokenizer, PRTJSONTOKE /** * Consume the current token advancing to the next in the stream. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ static void rtJsonTokenizerConsume(PRTJSONTOKENIZER pTokenizer) @@ -1030,7 +1024,6 @@ static bool rtJsonTokenizerConsumeIfMatched(PRTJSONTOKENIZER pTokenizer, RTJSONT /** * Destroys a given JSON value releasing the reference to all child values. * - * @returns nothing. * @param pThis The JSON value to destroy. */ static void rtJsonValDestroy(PRTJSONVALINT pThis) diff --git a/src/VBox/Runtime/common/zip/tarvfswriter.cpp b/src/VBox/Runtime/common/zip/tarvfswriter.cpp index 6c4b5e06e5b..6c95a575d99 100644 --- a/src/VBox/Runtime/common/zip/tarvfswriter.cpp +++ b/src/VBox/Runtime/common/zip/tarvfswriter.cpp @@ -511,7 +511,6 @@ static int rtZipTarFssWriter_ObjInfoToHdrTar(PRTZIPTARFSSTREAMWRITER pThis, cons /** * Formats a given 32-bit value into a CPIO header field. * - * @returns nothing. * @param pach8Field The field to format the value into. * @param u32 The value to format. */ diff --git a/src/VBox/Runtime/include/internal/dvm.h b/src/VBox/Runtime/include/internal/dvm.h index 805eed3a538..d12086fb258 100644 --- a/src/VBox/Runtime/include/internal/dvm.h +++ b/src/VBox/Runtime/include/internal/dvm.h @@ -127,7 +127,6 @@ typedef struct RTDVMFMTOPS /** * Closes the volume format. * - * @returns nothing. * @param hVolMgrFmt The format specific volume manager handle. */ DECLCALLBACKMEMBER(void, pfnClose,(RTDVMFMT hVolMgrFmt)); @@ -219,7 +218,6 @@ typedef struct RTDVMFMTOPS /** * Closes a volume handle. * - * @returns nothing. * @param hVolFmt The format specific volume handle. */ DECLCALLBACKMEMBER(void, pfnVolumeClose,(RTDVMVOLUMEFMT hVolFmt)); diff --git a/src/VBox/Runtime/r3/darwin/krnlmod-darwin.cpp b/src/VBox/Runtime/r3/darwin/krnlmod-darwin.cpp index a2af5f0c02f..5c34621a39d 100644 --- a/src/VBox/Runtime/r3/darwin/krnlmod-darwin.cpp +++ b/src/VBox/Runtime/r3/darwin/krnlmod-darwin.cpp @@ -166,7 +166,6 @@ static CFDictionaryRef rtKrnlModDarwinGetKextInfoByName(const char *pszName) /** * Destroy the given kernel module information record. * - * @returns nothing. * @param pThis The record to destroy. */ static void rtKrnlModInfoDestroy(PRTKRNLMODINFOINT pThis) diff --git a/src/VBox/Runtime/r3/linux/ioqueue-iouringfile-provider.cpp b/src/VBox/Runtime/r3/linux/ioqueue-iouringfile-provider.cpp index 00dbfc9937d..3a92f9ca046 100644 --- a/src/VBox/Runtime/r3/linux/ioqueue-iouringfile-provider.cpp +++ b/src/VBox/Runtime/r3/linux/ioqueue-iouringfile-provider.cpp @@ -555,7 +555,6 @@ DECLINLINE(int) rtIoQueueLnxEventfd2(uint32_t uValInit, uint32_t fFlags, int *pi /** * Checks the completion event queue for pending events. * - * @returns nothing. * @param pThis The provider instance. * @param paCEvt Pointer to the array of completion events. * @param cCEvt Maximum number of completion events the array can hold. diff --git a/src/VBox/Runtime/r3/linux/krnlmod-linux.cpp b/src/VBox/Runtime/r3/linux/krnlmod-linux.cpp index a5cd65cb6c9..70652a17a33 100644 --- a/src/VBox/Runtime/r3/linux/krnlmod-linux.cpp +++ b/src/VBox/Runtime/r3/linux/krnlmod-linux.cpp @@ -78,7 +78,6 @@ typedef const RTKRNLMODINFOINT *PCRTKRNLMODINFOINT; /** * Destroy the given kernel module information record. * - * @returns nothing. * @param pThis The record to destroy. */ static void rtKrnlModInfoDestroy(PRTKRNLMODINFOINT pThis) diff --git a/src/VBox/Runtime/r3/posix/serialport-posix.cpp b/src/VBox/Runtime/r3/posix/serialport-posix.cpp index 05a05e7030b..8da6033aee2 100644 --- a/src/VBox/Runtime/r3/posix/serialport-posix.cpp +++ b/src/VBox/Runtime/r3/posix/serialport-posix.cpp @@ -644,7 +644,6 @@ static int rtSerialPortMonitorThreadCreate(PRTSERIALPORTINTERNAL pThis) /** * Shuts down the status line monitor thread. * - * @returns nothing. * @param pThis The internal serial port instance data. */ static void rtSerialPortMonitorThreadShutdown(PRTSERIALPORTINTERNAL pThis) diff --git a/src/VBox/Runtime/r3/solaris/krnlmod-solaris.cpp b/src/VBox/Runtime/r3/solaris/krnlmod-solaris.cpp index 84d806ad0df..ea56e3e9d90 100644 --- a/src/VBox/Runtime/r3/solaris/krnlmod-solaris.cpp +++ b/src/VBox/Runtime/r3/solaris/krnlmod-solaris.cpp @@ -79,7 +79,6 @@ typedef const RTKRNLMODINFOINT *PCRTKRNLMODINFOINT; /** * Destroy the given kernel module information record. * - * @returns nothing. * @param pThis The record to destroy. */ static void rtKrnlModInfoDestroy(PRTKRNLMODINFOINT pThis) diff --git a/src/VBox/Runtime/r3/win/krnlmod-win.cpp b/src/VBox/Runtime/r3/win/krnlmod-win.cpp index f84d96ec717..ea0e950e7c9 100644 --- a/src/VBox/Runtime/r3/win/krnlmod-win.cpp +++ b/src/VBox/Runtime/r3/win/krnlmod-win.cpp @@ -80,7 +80,6 @@ typedef const RTKRNLMODINFOINT *PCRTKRNLMODINFOINT; /** * Destroy the given kernel module information record. * - * @returns nothing. * @param pThis The record to destroy. */ static void rtKrnlModInfoDestroy(PRTKRNLMODINFOINT pThis) diff --git a/src/VBox/Storage/CUE.cpp b/src/VBox/Storage/CUE.cpp index ac6b1691ec8..d374db20b86 100644 --- a/src/VBox/Storage/CUE.cpp +++ b/src/VBox/Storage/CUE.cpp @@ -333,7 +333,6 @@ DECLINLINE(bool) cueTokenizerIsEos(PCUETOKENIZER pTokenizer) /** * Skip one character in the input stream. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ DECLINLINE(void) cueTokenizerSkipCh(PCUETOKENIZER pTokenizer) @@ -378,7 +377,6 @@ DECLINLINE(char) cueTokenizerGetCh(PCUETOKENIZER pTokenizer) /** * Sets a new line for the tokenizer. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param cSkip How many characters to skip. */ @@ -414,7 +412,6 @@ DECLINLINE(bool) cueTokenizerIsSkipNewLine(PCUETOKENIZER pTokenizer) * Skip all whitespace starting from the current input buffer position. * Skips all present comments too. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ DECLINLINE(void) cueTokenizerSkipWhitespace(PCUETOKENIZER pTokenizer) @@ -434,7 +431,6 @@ DECLINLINE(void) cueTokenizerSkipWhitespace(PCUETOKENIZER pTokenizer) /** * Skips a multi line comment. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ DECLINLINE(void) cueTokenizerSkipComment(PCUETOKENIZER pTokenizer) @@ -448,7 +444,6 @@ DECLINLINE(void) cueTokenizerSkipComment(PCUETOKENIZER pTokenizer) /** * Get an identifier token from the tokenizer. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param pToken The uninitialized token. */ @@ -511,7 +506,6 @@ static void cueTokenizerGetKeyword(PCUETOKENIZER pTokenizer, PCUETOKEN pToken) /** * Get an integer value or MSF location indicator from the tokenizer. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param pToken The uninitialized token. */ @@ -576,7 +570,6 @@ static void cueTokenizerGetIntegerOrMsf(PCUETOKENIZER pTokenizer, PCUETOKEN pTok /** * Parses a string constant. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param pToken The uninitialized token. * @@ -612,7 +605,6 @@ static void cueTokenizerGetStringConst(PCUETOKENIZER pTokenizer, PCUETOKEN pToke /** * Get the end of stream token. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param pToken The uninitialized token. */ @@ -626,7 +618,6 @@ static void cueTokenizerGetEos(PCUETOKENIZER pTokenizer, PCUETOKEN pToken) /** * Read the next token from the tokenizer stream. * - * @returns nothing. * @param pTokenizer The tokenizer to read from. * @param pToken Uninitialized token to fill the token data into. */ @@ -696,7 +687,6 @@ DECLINLINE(CUETOKENTYPE) cueTokenizerGetTokenType(PCUETOKENIZER pTokenizer) /** * Consume the current token advancing to the next in the stream. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ static void cueTokenizerConsume(PCUETOKENIZER pTokenizer) diff --git a/src/VBox/Storage/ISCSI.cpp b/src/VBox/Storage/ISCSI.cpp index d6adba34895..f86956b33bc 100644 --- a/src/VBox/Storage/ISCSI.cpp +++ b/src/VBox/Storage/ISCSI.cpp @@ -838,7 +838,6 @@ static PISCSICMD iscsiCmdRemoveAll(PISCSIIMAGE pImage) /** * Dumps an iSCSI packet if enabled. * - * @returns nothing. * @param pImage The iSCSI image instance data. * @param paISCSISegs Pointer to the segments array. * @param cnISCSISegs Number of segments in the array. diff --git a/src/VBox/Storage/QCOW.cpp b/src/VBox/Storage/QCOW.cpp index 1a234bab0b1..bd32033152a 100644 --- a/src/VBox/Storage/QCOW.cpp +++ b/src/VBox/Storage/QCOW.cpp @@ -453,7 +453,6 @@ static bool qcowHdrConvertToHostEndianess(PQCowHeader pHeader) /** * Creates a QCOW header from the given image state. * - * @returns nothing. * @param pImage Image instance data. * @param pHeader Pointer to the header to convert. * @param pcbHeader Where to store the size of the header to write. @@ -499,13 +498,12 @@ static void qcowHdrConvertFromHostEndianess(PQCOWIMAGE pImage, PQCowHeader pHead /** * Convert table entries from little endian to host endianess. * - * @returns nothing. * @param paTbl Pointer to the table. * @param cEntries Number of entries in the table. */ static void qcowTableConvertToHostEndianess(uint64_t *paTbl, uint32_t cEntries) { - while(cEntries-- > 0) + while (cEntries-- > 0) { *paTbl = RT_BE2H_U64(*paTbl); paTbl++; @@ -515,15 +513,14 @@ static void qcowTableConvertToHostEndianess(uint64_t *paTbl, uint32_t cEntries) /** * Convert table entries from host to little endian format. * - * @returns nothing. * @param paTblImg Pointer to the table which will store the little endian table. * @param paTbl The source table to convert. * @param cEntries Number of entries in the table. */ -static void qcowTableConvertFromHostEndianess(uint64_t *paTblImg, uint64_t *paTbl, +static void qcowTableConvertFromHostEndianess(uint64_t *paTblImg, uint64_t const *paTbl, uint32_t cEntries) { - while(cEntries-- > 0) + while (cEntries-- > 0) { *paTblImg = RT_H2BE_U64(*paTbl); paTbl++; @@ -549,7 +546,6 @@ static int qcowL2TblCacheCreate(PQCOWIMAGE pImage) /** * Destroys the L2 table cache. * - * @returns nothing. * @param pImage The image instance data. */ static void qcowL2TblCacheDestroy(PQCOWIMAGE pImage) @@ -608,7 +604,6 @@ static PQCOWL2CACHEENTRY qcowL2TblCacheRetain(PQCOWIMAGE pImage, uint64_t offL2T /** * Releases a L2 table cache entry. * - * @returns nothing. * @param pL2Entry The L2 cache entry. */ static void qcowL2TblCacheEntryRelease(PQCOWL2CACHEENTRY pL2Entry) @@ -674,7 +669,6 @@ static PQCOWL2CACHEENTRY qcowL2TblCacheEntryAlloc(PQCOWIMAGE pImage) /** * Frees a L2 table cache entry. * - * @returns nothing. * @param pImage The image instance data. * @param pL2Entry The L2 cache entry to free. */ @@ -690,7 +684,6 @@ static void qcowL2TblCacheEntryFree(PQCOWIMAGE pImage, PQCOWL2CACHEENTRY pL2Entr /** * Inserts an entry in the L2 table cache. * - * @returns nothing. * @param pImage The image instance data. * @param pL2Entry The L2 cache entry to insert. */ @@ -789,7 +782,6 @@ static int qcowL2TblCacheFetch(PQCOWIMAGE pImage, PVDIOCTX pIoCtx, uint64_t offL /** * Sets the L1, L2 and offset bitmasks and L1 and L2 bit shift members. * - * @returns nothing. * @param pImage The image instance data. */ static void qcowTableMasksInit(PQCOWIMAGE pImage) @@ -810,7 +802,6 @@ static void qcowTableMasksInit(PQCOWIMAGE pImage) /** * Converts a given logical offset into the * - * @returns nothing. * @param pImage The image instance data. * @param off The logical offset to convert. * @param pidxL1 Where to store the index in the L1 table on success. diff --git a/src/VBox/Storage/QED.cpp b/src/VBox/Storage/QED.cpp index a973b8916ed..f9308a07dcd 100644 --- a/src/VBox/Storage/QED.cpp +++ b/src/VBox/Storage/QED.cpp @@ -1,6 +1,13 @@ /* $Id$ */ /** @file * QED - QED Disk image. + * + * The QED backend implements support for the qemu enhanced disk format (short QED) + * The specification for the format is available under http://wiki.qemu.org/Features/QED/Specification + * + * Missing things to implement: + * - compaction + * - resizing which requires block relocation (very rare case) */ /* @@ -44,15 +51,6 @@ #include "VDBackends.h" #include "VDBackendsInline.h" -/** - * The QED backend implements support for the qemu enhanced disk format (short QED) - * The specification for the format is available under http://wiki.qemu.org/Features/QED/Specification - * - * Missing things to implement: - * - compaction - * - resizing which requires block relocation (very rare case) - */ - /********************************************************************************************************************************* * Structures in a QED image, little endian * @@ -329,7 +327,6 @@ static bool qedHdrConvertToHostEndianess(PQedHeader pHeader) /** * Creates a QED header from the given image state. * - * @returns nothing. * @param pImage Image instance data. * @param pHeader Pointer to the header to convert. */ @@ -351,13 +348,12 @@ static void qedHdrConvertFromHostEndianess(PQEDIMAGE pImage, PQedHeader pHeader) /** * Convert table entries from little endian to host endianess. * - * @returns nothing. * @param paTbl Pointer to the table. * @param cEntries Number of entries in the table. */ static void qedTableConvertToHostEndianess(uint64_t *paTbl, uint32_t cEntries) { - while(cEntries-- > 0) + while (cEntries-- > 0) { *paTbl = RT_LE2H_U64(*paTbl); paTbl++; @@ -368,15 +364,14 @@ static void qedTableConvertToHostEndianess(uint64_t *paTbl, uint32_t cEntries) /** * Convert table entries from host to little endian format. * - * @returns nothing. * @param paTblImg Pointer to the table which will store the little endian table. * @param paTbl The source table to convert. * @param cEntries Number of entries in the table. */ -static void qedTableConvertFromHostEndianess(uint64_t *paTblImg, uint64_t *paTbl, +static void qedTableConvertFromHostEndianess(uint64_t *paTblImg, uint64_t const *paTbl, uint32_t cEntries) { - while(cEntries-- > 0) + while (cEntries-- > 0) { *paTblImg = RT_H2LE_U64(*paTbl); paTbl++; @@ -403,7 +398,6 @@ static int qedL2TblCacheCreate(PQEDIMAGE pImage) /** * Destroys the L2 table cache. * - * @returns nothing. * @param pImage The image instance data. */ static void qedL2TblCacheDestroy(PQEDIMAGE pImage) @@ -462,7 +456,6 @@ static PQEDL2CACHEENTRY qedL2TblCacheRetain(PQEDIMAGE pImage, uint64_t offL2Tbl) /** * Releases a L2 table cache entry. * - * @returns nothing. * @param pL2Entry The L2 cache entry. */ static void qedL2TblCacheEntryRelease(PQEDL2CACHEENTRY pL2Entry) @@ -528,7 +521,6 @@ static PQEDL2CACHEENTRY qedL2TblCacheEntryAlloc(PQEDIMAGE pImage) /** * Frees a L2 table cache entry. * - * @returns nothing. * @param pImage The image instance data. * @param pL2Entry The L2 cache entry to free. */ @@ -544,7 +536,6 @@ static void qedL2TblCacheEntryFree(PQEDIMAGE pImage, PQEDL2CACHEENTRY pL2Entry) /** * Inserts an entry in the L2 table cache. * - * @returns nothing. * @param pImage The image instance data. * @param pL2Entry The L2 cache entry to insert. */ @@ -662,7 +653,6 @@ static uint32_t qedGetPowerOfTwo(uint32_t u32) /** * Sets the L1, L2 and offset bitmasks and L1 and L2 bit shift members. * - * @returns nothing. * @param pImage The image instance data. */ static void qedTableMasksInit(PQEDIMAGE pImage) @@ -684,7 +674,6 @@ static void qedTableMasksInit(PQEDIMAGE pImage) /** * Converts a given logical offset into the * - * @returns nothing. * @param pImage The image instance data. * @param off The logical offset to convert. * @param pidxL1 Where to store the index in the L1 table on success. diff --git a/src/VBox/Storage/VCICache.cpp b/src/VBox/Storage/VCICache.cpp index 579ad00d57a..99b17ffef4a 100644 --- a/src/VBox/Storage/VCICache.cpp +++ b/src/VBox/Storage/VCICache.cpp @@ -506,7 +506,6 @@ static int vciBlkMapCreate(uint64_t cBlocks, PVCIBLKMAP *ppBlkMap, uint32_t *pcB /** * Frees a block map. * - * @returns nothing. * @param pBlkMap The block bitmap to destroy. */ static void vciBlkMapDestroy(PVCIBLKMAP pBlkMap) @@ -925,7 +924,6 @@ static int vciBlkMapRealloc(PVCIBLKMAP pBlkMap, uint32_t cBlocksNew, uint64_t of /** * Frees a range of blocks. * - * @returns nothing. * @param pBlkMap The block bitmap. * @param offBlockAddr Address of the first block to free. * @param cBlocks How many blocks to free. diff --git a/src/VBox/Storage/VD.cpp b/src/VBox/Storage/VD.cpp index 31947d4facd..94ade76f2b2 100644 --- a/src/VBox/Storage/VD.cpp +++ b/src/VBox/Storage/VD.cpp @@ -1486,7 +1486,6 @@ static int vdDiskProcessWaitingIoCtx(PVDISK pDisk, PVDIOCTX pIoCtxRc) /** * Processes the list of blocked I/O contexts. * - * @returns nothing. * @param pDisk The disk structure. */ static void vdDiskProcessBlockedIoCtx(PVDISK pDisk) @@ -3604,7 +3603,6 @@ static int vdMetaXferCompleted(PVDIOSTORAGE pIoStorage, PFNVDXFERCOMPLETED pfnCo /** * Processes a list of waiting I/O tasks. The disk lock must be held by caller. * - * @returns nothing. * @param pDisk The disk to process the list for. */ static void vdIoTaskProcessWaitingList(PVDISK pDisk) @@ -3649,7 +3647,6 @@ static void vdIoTaskProcessWaitingList(PVDISK pDisk) /** * Process any I/O context on the halted list. * - * @returns nothing. * @param pDisk The disk. */ static void vdIoCtxProcessHaltedList(PVDISK pDisk) @@ -3739,7 +3736,6 @@ static int vdDiskUnlock(PVDISK pDisk, PVDIOCTX pIoCtxRc) * Try to lock the disk to complete pressing of the I/O task. * The completion is deferred if the disk is locked already. * - * @returns nothing. * @param pIoTask The I/O task to complete. */ static void vdXferTryLockDiskDeferIoTask(PVDIOTASK pIoTask) @@ -4933,7 +4929,6 @@ static void vdFixupLCHSGeometry(PVDGEOMETRY pLCHS, uint64_t cbSize) /** * Sets the I/O callbacks of the given interface to the fallback methods * - * @returns nothing. * @param pIfIo The I/O interface to setup. */ static void vdIfIoFallbackCallbacksSetup(PVDINTERFACEIO pIfIo) @@ -4958,7 +4953,6 @@ static void vdIfIoFallbackCallbacksSetup(PVDINTERFACEIO pIfIo) /** * Sets the internal I/O callbacks of the given interface. * - * @returns nothing. * @param pIfIoInt The internal I/O interface to setup. */ static void vdIfIoIntCallbacksSetup(PVDINTERFACEIOINT pIfIoInt) diff --git a/src/VBox/Storage/VDI.cpp b/src/VBox/Storage/VDI.cpp index c959d1b654c..66ad0f00df1 100644 --- a/src/VBox/Storage/VDI.cpp +++ b/src/VBox/Storage/VDI.cpp @@ -350,7 +350,6 @@ static unsigned vdiTranslateVDI2ImageFlags(VDIIMAGETYPE enmType) /** * Internal: Init VDI header. Always use latest header version. * - * @returns nothing. * @param pHeader Assumes it was initially initialized to all zeros. * @param uImageFlags Flags for this image. * @param pszComment Optional comment to set for the image. diff --git a/src/VBox/Storage/VHDX.cpp b/src/VBox/Storage/VHDX.cpp index e43573af95c..65b8b4668a8 100644 --- a/src/VBox/Storage/VHDX.cpp +++ b/src/VBox/Storage/VHDX.cpp @@ -616,7 +616,6 @@ static const VHDXMETADATAITEMPROPS s_aVhdxMetadataItemProps[] = /** * Converts the file identifier between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pFileIdentifierConv Where to store the converted file identifier. * @param pFileIdentifier The file identifier to convert. @@ -634,7 +633,6 @@ DECLINLINE(void) vhdxConvFileIdentifierEndianess(VHDXECONV enmConv, PVhdxFileIde /** * Converts a UUID between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pUuidConv Where to store the converted UUID. * @param pUuid The UUID to convert. @@ -664,7 +662,6 @@ DECLINLINE(void) vhdxConvUuidEndianess(VHDXECONV enmConv, PRTUUID pUuidConv, PRT /** * Converts a VHDX header between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pHdrConv Where to store the converted header. * @param pHdr The VHDX header to convert. @@ -688,7 +685,6 @@ DECLINLINE(void) vhdxConvHeaderEndianess(VHDXECONV enmConv, PVhdxHeader pHdrConv /** * Converts a VHDX region table header between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pRegTblHdrConv Where to store the converted header. * @param pRegTblHdr The VHDX region table header to convert. @@ -707,7 +703,6 @@ DECLINLINE(void) vhdxConvRegionTblHdrEndianess(VHDXECONV enmConv, PVhdxRegionTbl /** * Converts a VHDX region table entry between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pRegTblEntConv Where to store the converted region table entry. * @param pRegTblEnt The VHDX region table entry to convert. @@ -728,7 +723,6 @@ DECLINLINE(void) vhdxConvRegionTblEntryEndianess(VHDXECONV enmConv, PVhdxRegionT /** * Converts a VHDX log entry header between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pLogEntryHdrConv Where to store the converted log entry header. * @param pLogEntryHdr The VHDX log entry header to convert. @@ -752,7 +746,6 @@ DECLINLINE(void) vhdxConvLogEntryHdrEndianess(VHDXECONV enmConv, PVhdxLogEntryHd /** * Converts a VHDX log zero descriptor between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pLogZeroDescConv Where to store the converted log zero descriptor. * @param pLogZeroDesc The VHDX log zero descriptor to convert. @@ -773,7 +766,6 @@ DECLINLINE(void) vhdxConvLogZeroDescEndianess(VHDXECONV enmConv, PVhdxLogZeroDes /** * Converts a VHDX log data descriptor between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pLogDataDescConv Where to store the converted log data descriptor. * @param pLogDataDesc The VHDX log data descriptor to convert. @@ -794,7 +786,6 @@ DECLINLINE(void) vhdxConvLogDataDescEndianess(VHDXECONV enmConv, PVhdxLogDataDes /** * Converts a VHDX log data sector between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pLogDataSectorConv Where to store the converted log data sector. * @param pLogDataSector The VHDX log data sector to convert. @@ -814,7 +805,6 @@ DECLINLINE(void) vhdxConvLogDataSectorEndianess(VHDXECONV enmConv, PVhdxLogDataS /** * Converts a BAT between file and host endianess. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param paBatEntriesConv Where to store the converted BAT. * @param paBatEntries The VHDX BAT to convert. @@ -832,7 +822,6 @@ DECLINLINE(void) vhdxConvBatTableEndianess(VHDXECONV enmConv, PVhdxBatEntry paBa /** * Converts a VHDX metadata table header between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pMetadataTblHdrConv Where to store the converted metadata table header. * @param pMetadataTblHdr The VHDX metadata table header to convert. @@ -852,7 +841,6 @@ DECLINLINE(void) vhdxConvMetadataTblHdrEndianess(VHDXECONV enmConv, PVhdxMetadat /** * Converts a VHDX metadata table entry between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pMetadataTblEntryConv Where to store the converted metadata table entry. * @param pMetadataTblEntry The VHDX metadata table entry to convert. @@ -872,7 +860,6 @@ DECLINLINE(void) vhdxConvMetadataTblEntryEndianess(VHDXECONV enmConv, PVhdxMetad /** * Converts a VHDX file parameters item between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pFileParamsConv Where to store the converted file parameters item entry. * @param pFileParams The VHDX file parameters item to convert. @@ -889,7 +876,6 @@ DECLINLINE(void) vhdxConvFileParamsEndianess(VHDXECONV enmConv, PVhdxFileParamet /** * Converts a VHDX virtual disk size item between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pVDiskSizeConv Where to store the converted virtual disk size item entry. * @param pVDiskSize The VHDX virtual disk size item to convert. @@ -907,7 +893,6 @@ DECLINLINE(void) vhdxConvVDiskSizeEndianess(VHDXECONV enmConv, PVhdxVDiskSize pV /** * Converts a VHDX page 83 data item between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pPage83DataConv Where to store the converted page 83 data item entry. * @param pPage83Data The VHDX page 83 data item to convert. @@ -924,7 +909,6 @@ DECLINLINE(void) vhdxConvPage83DataEndianess(VHDXECONV enmConv, PVhdxPage83Data /** * Converts a VHDX logical sector size item between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pVDiskLogSectSizeConv Where to store the converted logical sector size item entry. * @param pVDiskLogSectSize The VHDX logical sector size item to convert. @@ -942,7 +926,6 @@ DECLINLINE(void) vhdxConvVDiskLogSectSizeEndianess(VHDXECONV enmConv, PVhdxVDisk /** * Converts a VHDX physical sector size item between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pVDiskPhysSectSizeConv Where to store the converted physical sector size item entry. * @param pVDiskPhysSectSize The VHDX physical sector size item to convert. @@ -959,7 +942,6 @@ DECLINLINE(void) vhdxConvVDiskPhysSectSizeEndianess(VHDXECONV enmConv, PVhdxVDis /** * Converts a VHDX parent locator header item between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pParentLocatorHdrConv Where to store the converted parent locator header item entry. * @param pParentLocatorHdr The VHDX parent locator header item to convert. @@ -978,7 +960,6 @@ DECLINLINE(void) vhdxConvParentLocatorHeaderEndianness(VHDXECONV enmConv, PVhdxP /** * Converts a VHDX parent locator entry between file and host endianness. * - * @returns nothing. * @param enmConv Direction of the conversion. * @param pParentLocatorEntryConv Where to store the converted parent locator entry. * @param pParentLocatorEntry The VHDX parent locator entry to convert. diff --git a/src/VBox/Storage/VMDK.cpp b/src/VBox/Storage/VMDK.cpp index 9d8bf8e4e9a..11a27cb677c 100644 --- a/src/VBox/Storage/VMDK.cpp +++ b/src/VBox/Storage/VMDK.cpp @@ -1165,7 +1165,6 @@ static int vmdkAllocGrainDirectory(PVMDKIMAGE pImage, PVMDKEXTENT pExtent) /** * Converts the grain directory from little to host endianess. * - * @returns nothing. * @param pGD The grain directory. * @param cGDEntries Number of entries in the grain directory to convert. */ @@ -7370,7 +7369,6 @@ static int vmdkRenameStatePrepare(PVMDKIMAGE pImage, PVMDKRENAMESTATE pRenameSta /** * Destroys the given rename state, freeing all allocated memory. * - * @returns nothing. * @param pRenameState The rename state to destroy. */ static void vmdkRenameStateDestroy(PVMDKRENAMESTATE pRenameState) diff --git a/src/VBox/Storage/testcase/VDIoBackend.h b/src/VBox/Storage/testcase/VDIoBackend.h index eb19ffc5216..4c0de108d95 100644 --- a/src/VBox/Storage/testcase/VDIoBackend.h +++ b/src/VBox/Storage/testcase/VDIoBackend.h @@ -49,7 +49,7 @@ typedef PVDIOSTORAGE *PPVDIOSTORAGE; /** * Completion handler. * - * @returns nothing. + * @returns IPRT status code. * @param pvUser Opaque user data. * @param rcReq Completion code for the request. */ @@ -69,8 +69,6 @@ int VDIoBackendCreate(PPVDIOBACKEND ppIoBackend); /** * Destroys a memory I/O backend. * - * @returns nothing. - * * @param pIoBackend The backend to destroy. */ void VDIoBackendDestroy(PVDIOBACKEND pIoBackend); diff --git a/src/VBox/Storage/testcase/VDIoBackendMem.h b/src/VBox/Storage/testcase/VDIoBackendMem.h index 8d96f27990b..bc0aba3df32 100644 --- a/src/VBox/Storage/testcase/VDIoBackendMem.h +++ b/src/VBox/Storage/testcase/VDIoBackendMem.h @@ -43,8 +43,8 @@ typedef PVDIOBACKENDMEM *PPVDIOBACKENDMEM; /** * Completion handler. - * - * @returns nothing. + * + * @returns IPRT status code. * @param pvUser Opaque user data. * @param rcReq Completion code for the request. */ diff --git a/src/VBox/Storage/testcase/VDMemDisk.h b/src/VBox/Storage/testcase/VDMemDisk.h index ea74daeca94..cae29133412 100644 --- a/src/VBox/Storage/testcase/VDMemDisk.h +++ b/src/VBox/Storage/testcase/VDMemDisk.h @@ -54,8 +54,6 @@ int VDMemDiskCreate(PPVDMEMDISK ppMemDisk, uint64_t cbSize); /** * Destroys a memory disk. * - * @returns nothing. - * * @param pMemDisk The memory disk to destroy. */ void VDMemDiskDestroy(PVDMEMDISK pMemDisk); diff --git a/src/VBox/Storage/testcase/VDScript.cpp b/src/VBox/Storage/testcase/VDScript.cpp index 6e63cb5e4b4..81a6877eb69 100644 --- a/src/VBox/Storage/testcase/VDScript.cpp +++ b/src/VBox/Storage/testcase/VDScript.cpp @@ -337,7 +337,6 @@ DECLINLINE(bool) vdScriptTokenizerIsEos(PVDTOKENIZER pTokenizer) /** * Skip one character in the input stream. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ DECLINLINE(void) vdScriptTokenizerSkipCh(PVDTOKENIZER pTokenizer) @@ -382,7 +381,6 @@ DECLINLINE(char) vdScriptTokenizerGetCh(PVDTOKENIZER pTokenizer) /** * Sets a new line for the tokenizer. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ DECLINLINE(void) vdScriptTokenizerNewLine(PVDTOKENIZER pTokenizer, unsigned cSkip) @@ -419,7 +417,6 @@ DECLINLINE(bool) vdScriptTokenizerIsSkipNewLine(PVDTOKENIZER pTokenizer) /** * Skips a multi line comment. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ DECLINLINE(void) vdScriptTokenizerSkipComment(PVDTOKENIZER pTokenizer) @@ -442,7 +439,6 @@ DECLINLINE(void) vdScriptTokenizerSkipComment(PVDTOKENIZER pTokenizer) * Skip all whitespace starting from the current input buffer position. * Skips all present comments too. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ DECLINLINE(void) vdScriptTokenizerSkipWhitespace(PVDTOKENIZER pTokenizer) @@ -472,7 +468,6 @@ DECLINLINE(void) vdScriptTokenizerSkipWhitespace(PVDTOKENIZER pTokenizer) /** * Get an identifier token from the tokenizer. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param pToken The uninitialized token. */ @@ -519,7 +514,6 @@ static void vdScriptTokenizerGetIdeOrKeyword(PVDTOKENIZER pTokenizer, PVDSCRIPTT /** * Get a numerical constant from the tokenizer. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param pToken The uninitialized token. */ @@ -565,11 +559,10 @@ static void vdScriptTokenizerGetNumberConst(PVDTOKENIZER pTokenizer, PVDSCRIPTTO /** * Parses a string constant. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param pToken The uninitialized token. * - * @remarks: No escape sequences allowed at this time. + * @remarks No escape sequences allowed at this time. */ static void vdScriptTokenizerGetStringConst(PVDTOKENIZER pTokenizer, PVDSCRIPTTOKEN pToken) { @@ -597,7 +590,6 @@ static void vdScriptTokenizerGetStringConst(PVDTOKENIZER pTokenizer, PVDSCRIPTTO /** * Get the end of stream token. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param pToken The uninitialized token. */ @@ -612,7 +604,6 @@ static void vdScriptTokenizerGetEos(PVDTOKENIZER pTokenizer, PVDSCRIPTTOKEN pTok /** * Get operator or punctuator token. * - * @returns nothing. * @param pTokenizer The tokenizer state. * @param pToken The uninitialized token. */ @@ -668,7 +659,6 @@ static void vdScriptTokenizerGetOperatorOrPunctuator(PVDTOKENIZER pTokenizer, PV /** * Read the next token from the tokenizer stream. * - * @returns nothing. * @param pTokenizer The tokenizer to read from. * @param pToken Uninitialized token to fill the token data into. */ @@ -720,7 +710,6 @@ static PVDTOKENIZER vdScriptTokenizerCreate(const char *pszInput) /** * Destroys a given tokenizer state. * - * @returns nothing. * @param pTokenizer The tokenizer to destroy. */ static void vdScriptTokenizerDestroy(PVDTOKENIZER pTokenizer) @@ -765,7 +754,6 @@ DECLINLINE(VDTOKENCLASS) vdScriptTokenizerPeekNextClass(PVDTOKENIZER pTokenizer) /** * Consume the current token advancing to the next in the stream. * - * @returns nothing. * @param pTokenizer The tokenizer state. */ static void vdScriptTokenizerConsume(PVDTOKENIZER pTokenizer) @@ -1320,7 +1308,6 @@ static int vdScriptParseUnaryExpression(PVDSCRIPTCTXINT pThis, PVDSCRIPTASTEXPR /** * Parse a storage class specifier. * - * @returns nothing. * @param pThis The script context. * @param penmStorageClass Where to return the parsed storage classe. * Contains VDSCRIPTASTSTORAGECLASS_INVALID if no @@ -1354,7 +1341,6 @@ static void vdScriptParseStorageClassSpecifier(PVDSCRIPTCTXINT pThis, PVDSCRIPTA /** * Parse a type qualifier. * - * @returns nothing. * @param pThis The script context. * @param penmTypeQualifier Where to return the parsed type qualifier. * Contains VDSCRIPTASTTYPEQUALIFIER_INVALID if no diff --git a/src/VBox/Storage/testcase/VDScript.h b/src/VBox/Storage/testcase/VDScript.h index f23cb1f538e..d6611b32e50 100644 --- a/src/VBox/Storage/testcase/VDScript.h +++ b/src/VBox/Storage/testcase/VDScript.h @@ -165,7 +165,6 @@ DECLHIDDEN(int) VDScriptCtxCreate(PVDSCRIPTCTX phScriptCtx); /** * Destroys the given scripting context. * - * @returns nothing. * @param hScriptCtx The script context to destroy. */ DECLHIDDEN(void) VDScriptCtxDestroy(VDSCRIPTCTX hScriptCtx); diff --git a/src/VBox/Storage/testcase/VDScriptAst.cpp b/src/VBox/Storage/testcase/VDScriptAst.cpp index 77ca4c33eb2..06fcc18bce2 100644 --- a/src/VBox/Storage/testcase/VDScriptAst.cpp +++ b/src/VBox/Storage/testcase/VDScriptAst.cpp @@ -37,7 +37,6 @@ /** * Put all child nodes of the given expression AST node onto the given to free list. * - * @returns nothing. * @param pList The free list to append everything to. * @param pAstNode The expression node to free. */ @@ -146,7 +145,6 @@ static void vdScriptAstNodeExpressionPutOnFreeList(PRTLISTANCHOR pList, PVDSCRIP /** * Free a given statement AST node and put everything on the given to free list. * - * @returns nothing. * @param pList The free list to append everything to. * @param pAstNode The statement node to free. */ diff --git a/src/VBox/Storage/testcase/VDScriptAst.h b/src/VBox/Storage/testcase/VDScriptAst.h index d57bf640f1c..5b58a36d515 100644 --- a/src/VBox/Storage/testcase/VDScriptAst.h +++ b/src/VBox/Storage/testcase/VDScriptAst.h @@ -568,7 +568,6 @@ typedef VDSCRIPTASTFN *PVDSCRIPTASTFN; * Free the given AST node and all subsequent nodes pointed to * by the given node. * - * @returns nothing. * @param pAstNode The AST node to free. */ DECLHIDDEN(void) vdScriptAstNodeFree(PVDSCRIPTASTCORE pAstNode); diff --git a/src/VBox/Storage/testcase/VDScriptInterp.cpp b/src/VBox/Storage/testcase/VDScriptInterp.cpp index 216410d9f37..ce5e7f41f74 100644 --- a/src/VBox/Storage/testcase/VDScriptInterp.cpp +++ b/src/VBox/Storage/testcase/VDScriptInterp.cpp @@ -184,7 +184,6 @@ static int vdScriptInterpreterError(PVDSCRIPTINTERPCTX pThis, int rc, RT_SRC_POS /** * Pops the topmost value from the value stack. * - * @returns nothing. * @param pThis The interpreter context. * @param pVal Where to store the value. */ @@ -429,7 +428,6 @@ static int vdScriptInterpreterScopeCreate(PVDSCRIPTINTERPCTX pThis) /** * Destroys the current scope. * - * @returns nothing. * @param pThis The interpreter context. */ static void vdScriptInterpreterScopeDestroyCurr(PVDSCRIPTINTERPCTX pThis) diff --git a/src/VBox/Storage/testcase/VDScriptStack.h b/src/VBox/Storage/testcase/VDScriptStack.h index bc758e9d669..1d39591e928 100644 --- a/src/VBox/Storage/testcase/VDScriptStack.h +++ b/src/VBox/Storage/testcase/VDScriptStack.h @@ -56,7 +56,6 @@ typedef VDSCRIPTSTACK *PVDSCRIPTSTACK; /** * Init the stack structure. * - * @returns nothing. * @param pStack The stack to initialize. * @param cbStackEntry The size of one stack entry. */ @@ -71,7 +70,6 @@ DECLINLINE(void) vdScriptStackInit(PVDSCRIPTSTACK pStack, size_t cbStackEntry) /** * Destroys the given stack freeing all memory. * - * @returns nothing. * @param pStack The stack to destroy. */ DECLINLINE(void) vdScriptStackDestroy(PVDSCRIPTSTACK pStack) @@ -134,7 +132,6 @@ DECLINLINE(void *)vdScriptStackGetUsed(PVDSCRIPTSTACK pStack) /** * Increases the used element count for the given stack. * - * @returns nothing. * @param pStack The stack. */ DECLINLINE(void) vdScriptStackPush(PVDSCRIPTSTACK pStack) @@ -145,7 +142,6 @@ DECLINLINE(void) vdScriptStackPush(PVDSCRIPTSTACK pStack) /** * Decreases the used element count for the given stack. * - * @returns nothing. * @param pStack The stack. */ DECLINLINE(void) vdScriptStackPop(PVDSCRIPTSTACK pStack) diff --git a/src/VBox/Storage/testcase/tstVDIo.cpp b/src/VBox/Storage/testcase/tstVDIo.cpp index 87f219d9e27..4a8181b4280 100644 --- a/src/VBox/Storage/testcase/tstVDIo.cpp +++ b/src/VBox/Storage/testcase/tstVDIo.cpp @@ -2777,7 +2777,6 @@ static int tstVDIoPatternGetBuffer(PVDPATTERN pPattern, void **ppv, size_t cb) /** * Executes the given script. * - * @returns nothing. * @param pszName The script name. * @param pszScript The script to execute. */ @@ -2902,8 +2901,6 @@ static void tstVDIoScriptExec(const char *pszName, const char *pszScript) /** * Executes the given I/O script using the new scripting engine. * - * @returns nothing. - * * @param pcszFilename The script to execute. */ static void tstVDIoScriptRun(const char *pcszFilename) @@ -2929,8 +2926,6 @@ static void tstVDIoScriptRun(const char *pcszFilename) /** * Run builtin tests. - * - * @returns nothing. */ static void tstVDIoRunBuiltinTests(void) { diff --git a/src/VBox/VMM/VMMAll/APICAll.cpp b/src/VBox/VMM/VMMAll/APICAll.cpp index e4d7aeca7fe..8ef82239ea2 100644 --- a/src/VBox/VMM/VMMAll/APICAll.cpp +++ b/src/VBox/VMM/VMMAll/APICAll.cpp @@ -3428,7 +3428,6 @@ VMM_INT_DECL(bool) APICGetHighestPendingInterrupt(PVMCPUCC pVCpu, uint8_t *pu8Pe /** * Posts an interrupt to a target APIC, Hyper-V interface. * - * @returns true if the interrupt was accepted, false otherwise. * @param pVCpu The cross context virtual CPU structure. * @param uVector The vector of the interrupt to be posted. * @param fAutoEoi Whether this interrupt has automatic EOI diff --git a/src/VBox/VMM/VMMAll/CPUMAllRegs.cpp b/src/VBox/VMM/VMMAll/CPUMAllRegs.cpp index c60dc8274eb..3504668df8b 100644 --- a/src/VBox/VMM/VMMAll/CPUMAllRegs.cpp +++ b/src/VBox/VMM/VMMAll/CPUMAllRegs.cpp @@ -1727,7 +1727,6 @@ VMMDECL(bool) CPUMIsHyperDebugStateActive(PVMCPU pVCpu) /** * Mark the guest's debug state as inactive. * - * @returns boolean * @param pVCpu The cross context virtual CPU structure of the calling EMT. * @todo This API doesn't make sense any more. */ diff --git a/src/VBox/VMM/VMMAll/DBGFAllTracer.cpp b/src/VBox/VMM/VMMAll/DBGFAllTracer.cpp index 4b004819e24..b9279f4675c 100644 --- a/src/VBox/VMM/VMMAll/DBGFAllTracer.cpp +++ b/src/VBox/VMM/VMMAll/DBGFAllTracer.cpp @@ -189,7 +189,6 @@ DECLHIDDEN(int) dbgfTracerR3EvtPostSingle(PVMCC pVM, PDBGFTRACERINSCC pThisCC, D /** * Copies the given MMIO value into the event descriptor based on the given size. * - * @returns nothing. * @param pEvtMmio Pointer to the MMIO event descriptor to fill. * @param pvVal The value to copy. * @param cbVal Size of the value in bytes. @@ -219,7 +218,6 @@ static void dbgfTracerEvtMmioCopyVal(PDBGFTRACEREVTMMIO pEvtMmio, const void *pv /** * Copies the given I/O port value into the event descriptor based on the given size. * - * @returns nothing. * @param pEvtIoPort Pointer to the I/O port read/write event descriptor to fill. * @param pvVal The value to copy. * @param cbVal Size of the value in bytes. diff --git a/src/VBox/VMM/VMMAll/HMAll.cpp b/src/VBox/VMM/VMMAll/HMAll.cpp index 387bedae57b..f4f17f6898b 100644 --- a/src/VBox/VMM/VMMAll/HMAll.cpp +++ b/src/VBox/VMM/VMMAll/HMAll.cpp @@ -388,7 +388,6 @@ VMMDECL(bool) HMCanExecuteGuest(PVMCC pVM, PVMCPUCC pVCpu, PCCPUMCTX pCtx) /** * Queues a guest page for invalidation. * - * @returns VBox status code. * @param pVCpu The cross context virtual CPU structure. * @param GCVirt Page to invalidate. */ diff --git a/src/VBox/VMM/VMMAll/IEMAll.cpp b/src/VBox/VMM/VMMAll/IEMAll.cpp index 035c36a68b1..62413a937e1 100644 --- a/src/VBox/VMM/VMMAll/IEMAll.cpp +++ b/src/VBox/VMM/VMMAll/IEMAll.cpp @@ -566,7 +566,6 @@ static VBOXSTRICTRC iemInitDecoderAndPrefetchOpcodes(PVMCPUCC pVCpu, bool fBypas * * This is called internally as well as by PGM when moving GC mappings. * - * @returns * @param pVCpu The cross context virtual CPU structure of the calling * thread. */ @@ -6775,7 +6774,6 @@ VBOXSTRICTRC iemMemCommitAndUnmapPostponeTroubleToR3(PVMCPUCC pVCpu, void *pvMem * * The caller shall only call this after checking cActiveMappings. * - * @returns Strict VBox status code to pass up. * @param pVCpu The cross context virtual CPU structure of the calling thread. */ void iemMemRollback(PVMCPUCC pVCpu) RT_NOEXCEPT diff --git a/src/VBox/VMM/VMMAll/PGMAll.cpp b/src/VBox/VMM/VMMAll/PGMAll.cpp index c5b2fa10fe1..978abc0bdb9 100644 --- a/src/VBox/VMM/VMMAll/PGMAll.cpp +++ b/src/VBox/VMM/VMMAll/PGMAll.cpp @@ -3857,7 +3857,6 @@ int pgmLock(PVMCC pVM, bool fVoid) /** * Release the PGM lock. * - * @returns VBox status code * @param pVM The cross context VM structure. */ void pgmUnlock(PVMCC pVM) diff --git a/src/VBox/VMM/VMMAll/PGMAllHandler.cpp b/src/VBox/VMM/VMMAll/PGMAllHandler.cpp index 749b8c3060f..73bec70cb6d 100644 --- a/src/VBox/VMM/VMMAll/PGMAllHandler.cpp +++ b/src/VBox/VMM/VMMAll/PGMAllHandler.cpp @@ -986,8 +986,6 @@ void pgmHandlerPhysicalResetAliasedPage(PVMCC pVM, PPGMPAGE pPage, RTGCPHYS GCPh /** * Resets ram range flags. * - * @returns VBox status code. - * @retval VINF_SUCCESS when shadow PTs was successfully updated. * @param pVM The cross context VM structure. * @param pCur The physical handler. * diff --git a/src/VBox/VMM/VMMAll/PGMAllPhys.cpp b/src/VBox/VMM/VMMAll/PGMAllPhys.cpp index 76e74ebad44..85a193b66bc 100644 --- a/src/VBox/VMM/VMMAll/PGMAllPhys.cpp +++ b/src/VBox/VMM/VMMAll/PGMAllPhys.cpp @@ -1210,8 +1210,6 @@ int pgmPhysRecheckLargePage(PVMCC pVM, RTGCPHYS GCPhys, PPGMPAGE pLargePage) /** * Deal with a write monitored page. * - * @returns VBox strict status code. - * * @param pVM The cross context VM structure. * @param pPage The physical page tracking structure. * @param GCPhys The guest physical address of the page. diff --git a/src/VBox/VMM/VMMR0/CPUMR0.cpp b/src/VBox/VMM/VMMR0/CPUMR0.cpp index 83581062f39..98bdff74cbf 100644 --- a/src/VBox/VMM/VMMR0/CPUMR0.cpp +++ b/src/VBox/VMM/VMMR0/CPUMR0.cpp @@ -772,7 +772,6 @@ VMMR0_INT_DECL(void) CPUMR0LoadGuestDebugState(PVMCPUCC pVCpu, bool fDr6) /** * Lazily sync in the hypervisor debug state * - * @returns VBox status code. * @param pVCpu The cross context virtual CPU structure of the calling EMT. * @param fDr6 Whether to include DR6 or not. * @thread EMT(pVCpu) diff --git a/src/VBox/VMM/VMMR0/DBGFR0Bp.cpp b/src/VBox/VMM/VMMR0/DBGFR0Bp.cpp index bc10af3644e..90ceff6b624 100644 --- a/src/VBox/VMM/VMMR0/DBGFR0Bp.cpp +++ b/src/VBox/VMM/VMMR0/DBGFR0Bp.cpp @@ -56,7 +56,6 @@ /** * Used by DBGFR0InitPerVM() to initialize the breakpoint manager. * - * @returns nothing. * @param pGVM The global (ring-0) VM structure. */ DECLHIDDEN(void) dbgfR0BpInit(PGVM pGVM) diff --git a/src/VBox/VMM/VMMR0/HMSVMR0.cpp b/src/VBox/VMM/VMMR0/HMSVMR0.cpp index 4825f6f9858..f0415e62035 100644 --- a/src/VBox/VMM/VMMR0/HMSVMR0.cpp +++ b/src/VBox/VMM/VMMR0/HMSVMR0.cpp @@ -1733,7 +1733,6 @@ static int hmR0SvmExportGuestControlRegs(PVMCPUCC pVCpu, PSVMVMCB pVmcb) /** * Exports the guest (or nested-guest) segment registers into the VMCB. * - * @returns VBox status code. * @param pVCpu The cross context virtual CPU structure. * @param pVmcb Pointer to the VM control block. * @@ -5606,7 +5605,6 @@ static void hmR0SvmPreRunGuestDebugStateApply(PSVMTRANSIENT pSvmTransient, PSVMR * Restores VMCB fields that were changed by hmR0SvmPreRunGuestDebugStateApply * for re-entry next time around. * - * @returns Strict VBox status code (i.e. informational status codes too). * @param pSvmTransient The SVM-transient structure. * @param pDbgState The debug state. */ diff --git a/src/VBox/VMM/VMMR0/HMVMXR0.cpp b/src/VBox/VMM/VMMR0/HMVMXR0.cpp index 751ad8aeb30..51d31abc6cb 100644 --- a/src/VBox/VMM/VMMR0/HMVMXR0.cpp +++ b/src/VBox/VMM/VMMR0/HMVMXR0.cpp @@ -939,7 +939,6 @@ static int hmR0VmxAllocVmcsInfo(PVMCPUCC pVCpu, PVMXVMCSINFO pVmcsInfo, bool fIs /** * Free all VT-x structures for the VM. * - * @returns IPRT status code. * @param pVM The cross context VM structure. */ static void hmR0VmxStructsFree(PVMCC pVM) @@ -1603,7 +1602,6 @@ static void hmR0VmxCheckAutoLoadStoreMsrs(PVMCPUCC pVCpu, PCVMXVMCSINFO pVmcsInf /** * Flushes the TLB using EPT. * - * @returns VBox status code. * @param pVCpu The cross context virtual CPU structure of the calling * EMT. Can be NULL depending on @a enmTlbFlush. * @param pVmcsInfo The VMCS info. object. Can be NULL depending on @a @@ -1640,7 +1638,6 @@ static void hmR0VmxFlushEpt(PVMCPUCC pVCpu, PCVMXVMCSINFO pVmcsInfo, VMXTLBFLUSH /** * Flushes the TLB using VPID. * - * @returns VBox status code. * @param pVCpu The cross context virtual CPU structure of the calling * EMT. Can be NULL depending on @a enmTlbFlush. * @param enmTlbFlush Type of flush. @@ -4392,7 +4389,6 @@ static void hmR0VmxReportWorldSwitchError(PVMCPUCC pVCpu, int rcVMRun, PVMXTRANS * If offsetting is not possible, cause VM-exits on RDTSC(P)s. Also sets up the * VMX-preemption timer. * - * @returns VBox status code. * @param pVCpu The cross context virtual CPU structure. * @param pVmxTransient The VMX-transient structure. * @param idCurrentCpu The current CPU number. diff --git a/src/VBox/VMM/VMMR0/PGMR0.cpp b/src/VBox/VMM/VMMR0/PGMR0.cpp index 6e228fa57d1..d9c477f86a0 100644 --- a/src/VBox/VMM/VMMR0/PGMR0.cpp +++ b/src/VBox/VMM/VMMR0/PGMR0.cpp @@ -165,7 +165,6 @@ VMMR0_INT_DECL(int) PGMR0InitVM(PGVM pGVM) /** * Called at the end of the ring-0 initialization to seal access handler types. * - * @returns VBox status code. * @param pGVM Pointer to the global VM structure. */ VMMR0_INT_DECL(void) PGMR0DoneInitVM(PGVM pGVM) diff --git a/src/VBox/VMM/VMMR3/CFGM.cpp b/src/VBox/VMM/VMMR3/CFGM.cpp index 0afb2a29997..9b2c98ddffb 100644 --- a/src/VBox/VMM/VMMR3/CFGM.cpp +++ b/src/VBox/VMM/VMMR3/CFGM.cpp @@ -120,7 +120,6 @@ static void *cfgmR3MemAlloc(PVM pVM, MMTAG enmTag, size_t cb) /** * Free wrapper. * - * @returns Pointer to the allocated memory, NULL on failure. * @param pVM The cross context VM structure, if the tree * is associated with one. * @param pv The memory block to free. @@ -154,7 +153,6 @@ static char *cfgmR3StrAlloc(PVM pVM, MMTAG enmTag, size_t cbString) /** * String free wrapper. * - * @returns Pointer to the allocated memory, NULL on failure. * @param pVM The cross context VM structure, if the tree * is associated with one. * @param pszString The memory block to free. diff --git a/src/VBox/VMM/VMMR3/CPUM-armv8.cpp b/src/VBox/VMM/VMMR3/CPUM-armv8.cpp index 5d0d654ce86..a3f94b054c2 100644 --- a/src/VBox/VMM/VMMR3/CPUM-armv8.cpp +++ b/src/VBox/VMM/VMMR3/CPUM-armv8.cpp @@ -306,7 +306,6 @@ VMMR3DECL(void) CPUMR3ResetCpu(PVM pVM, PVMCPU pVCpu) /** * Resets the CPU. * - * @returns VINF_SUCCESS. * @param pVM The cross context VM structure. */ VMMR3DECL(void) CPUMR3Reset(PVM pVM) @@ -631,7 +630,6 @@ VMMR3DECL(void) CPUMR3LogCpuIdAndMsrFeatures(PVM pVM) /** * Marks the guest debug state as active. * - * @returns nothing. * @param pVCpu The cross context virtual CPU structure. * * @note This is used solely by NEM (hence the name) to set the correct flags here @@ -648,7 +646,6 @@ VMMR3_INT_DECL(void) CPUMR3NemActivateGuestDebugState(PVMCPUCC pVCpu) /** * Marks the hyper debug state as active. * - * @returns nothing. * @param pVCpu The cross context virtual CPU structure. * * @note This is used solely by NEM (hence the name) to set the correct flags here diff --git a/src/VBox/VMM/VMMR3/CPUM.cpp b/src/VBox/VMM/VMMR3/CPUM.cpp index 0c973d2e958..64a7fd92849 100644 --- a/src/VBox/VMM/VMMR3/CPUM.cpp +++ b/src/VBox/VMM/VMMR3/CPUM.cpp @@ -2497,7 +2497,6 @@ VMMR3DECL(void) CPUMR3ResetCpu(PVM pVM, PVMCPU pVCpu) /** * Resets the CPU. * - * @returns VINF_SUCCESS. * @param pVM The cross context VM structure. */ VMMR3DECL(void) CPUMR3Reset(PVM pVM) @@ -4601,7 +4600,6 @@ VMMR3DECL(void) CPUMR3LogCpuIdAndMsrFeatures(PVM pVM) /** * Marks the guest debug state as active. * - * @returns nothing. * @param pVCpu The cross context virtual CPU structure. * * @note This is used solely by NEM (hence the name) to set the correct flags here @@ -4618,7 +4616,6 @@ VMMR3_INT_DECL(void) CPUMR3NemActivateGuestDebugState(PVMCPUCC pVCpu) /** * Marks the hyper debug state as active. * - * @returns nothing. * @param pVCpu The cross context virtual CPU structure. * * @note This is used solely by NEM (hence the name) to set the correct flags here diff --git a/src/VBox/VMM/VMMR3/DBGF.cpp b/src/VBox/VMM/VMMR3/DBGF.cpp index cb60bdf1473..85b60124051 100644 --- a/src/VBox/VMM/VMMR3/DBGF.cpp +++ b/src/VBox/VMM/VMMR3/DBGF.cpp @@ -228,7 +228,6 @@ VMMR3_INT_DECL(int) DBGFR3Term(PVM pVM) /** * This is for tstCFGM and others to avoid trigger leak detection. * - * @returns VBox status code. * @param pUVM The user mode VM structure. */ VMMR3DECL(void) DBGFR3TermUVM(PUVM pUVM) diff --git a/src/VBox/VMM/VMMR3/DBGFR3Bp.cpp b/src/VBox/VMM/VMMR3/DBGFR3Bp.cpp index 6c8d208aa20..25b4a4de923 100644 --- a/src/VBox/VMM/VMMR3/DBGFR3Bp.cpp +++ b/src/VBox/VMM/VMMR3/DBGFR3Bp.cpp @@ -781,7 +781,6 @@ static int dbgfR3BpAlloc(PUVM pUVM, DBGFBPOWNER hOwner, void *pvUser, DBGFBPTYPE /** * Frees the given breakpoint handle. * - * @returns nothing. * @param pUVM The user mode VM handle. * @param hBp The breakpoint handle to free. * @param pBp The internal breakpoint state pointer. @@ -977,7 +976,6 @@ static int dbgfR3BpL2TblEntryAlloc(PUVM pUVM, uint32_t *pidxL2Tbl, PDBGFBPL2ENTR /** * Frees the given breakpoint handle. * - * @returns nothing. * @param pUVM The user mode VM handle. * @param idxL2Tbl The L2 table index to free. * @param pL2TblEntry The L2 table entry pointer to free. @@ -1004,7 +1002,6 @@ static void dbgfR3BpL2TblEntryFree(PUVM pUVM, uint32_t idxL2Tbl, PDBGFBPL2ENTRY /** * Sets the enabled flag of the given breakpoint to the given value. * - * @returns nothing. * @param pBp The breakpoint to set the state. * @param fEnabled Enabled status. */ diff --git a/src/VBox/VMM/VMMR3/DBGFR3Flow.cpp b/src/VBox/VMM/VMMR3/DBGFR3Flow.cpp index f218eb2ab09..af1c8d79c3e 100644 --- a/src/VBox/VMM/VMMR3/DBGFR3Flow.cpp +++ b/src/VBox/VMM/VMMR3/DBGFR3Flow.cpp @@ -342,7 +342,6 @@ dbgfR3FlowBranchTblCreate(PDBGFFLOWINT pThis, PDBGFADDRESS pAddrStart, uint8_t i /** * Destroys a control flow graph. * - * @returns nothing. * @param pThis The control flow graph to destroy. */ static void dbgfR3FlowDestroy(PDBGFFLOWINT pThis) @@ -375,7 +374,6 @@ static void dbgfR3FlowDestroy(PDBGFFLOWINT pThis) /** * Destroys a basic block. * - * @returns nothing. * @param pFlowBb The basic block to destroy. * @param fMayDestroyFlow Flag whether the control flow graph container * should be destroyed when there is nothing referencing it. @@ -399,7 +397,6 @@ static void dbgfR3FlowBbDestroy(PDBGFFLOWBBINT pFlowBb, bool fMayDestroyFlow) /** * Destroys a given branch table. * - * @returns nothing. * @param pFlowBranchTbl The flow branch table to destroy. */ static void dbgfR3FlowBranchTblDestroy(PDBGFFLOWBRANCHTBLINT pFlowBranchTbl) @@ -431,7 +428,6 @@ static uint32_t dbgfR3FlowBbReleaseInt(PDBGFFLOWBBINT pFlowBb, bool fMayDestroyF /** * Links the given basic block into the control flow graph. * - * @returns nothing. * @param pThis The control flow graph to link into. * @param pFlowBb The basic block to link. */ @@ -445,7 +441,6 @@ DECLINLINE(void) dbgfR3FlowLink(PDBGFFLOWINT pThis, PDBGFFLOWBBINT pFlowBb) /** * Links the given branch table into the control flow graph. * - * @returns nothing. * @param pThis The control flow graph to link into. * @param pBranchTbl The branch table to link. */ @@ -498,7 +493,6 @@ DECLINLINE(PDBGFFLOWBRANCHTBLINT) dbgfR3FlowBranchTblFindByAddr(PDBGFFLOWINT pTh /** * Sets the given error status for the basic block. * - * @returns nothing. * @param pFlowBb The basic block causing the error. * @param rcError The error to set. * @param pszFmt Format string of the error description. @@ -2133,7 +2127,6 @@ VMMR3DECL(int) DBGFR3FlowItCreate(DBGFFLOW hFlow, DBGFFLOWITORDER enmOrder, PDBG /** * Destroys a given control flow graph iterator. * - * @returns nothing. * @param hFlowIt The control flow graph iterator handle. */ VMMR3DECL(void) DBGFR3FlowItDestroy(DBGFFLOWIT hFlowIt) @@ -2271,7 +2264,6 @@ VMMR3DECL(int) DBGFR3FlowBranchTblItCreate(DBGFFLOW hFlow, DBGFFLOWITORDER enmOr /** * Destroys a given control flow graph branch table iterator. * - * @returns nothing. * @param hFlowBranchTblIt The control flow graph branch table iterator handle. */ VMMR3DECL(void) DBGFR3FlowBranchTblItDestroy(DBGFFLOWBRANCHTBLIT hFlowBranchTblIt) diff --git a/src/VBox/VMM/VMMR3/DBGFR3FlowTrace.cpp b/src/VBox/VMM/VMMR3/DBGFR3FlowTrace.cpp index 17c1864b3ff..a8102ef336a 100644 --- a/src/VBox/VMM/VMMR3/DBGFR3FlowTrace.cpp +++ b/src/VBox/VMM/VMMR3/DBGFR3FlowTrace.cpp @@ -281,7 +281,6 @@ static PDBGFFLOWTRACERECORDINT dbgfR3FlowTraceRecordCreate(PDBGFFLOWTRACEMODPROB /** * Destroys the given record. * - * @returns nothing. * @param pRecord The record to destroy. */ static void dbgfR3FlowTraceRecordDestroy(PDBGFFLOWTRACERECORDINT pRecord) @@ -317,7 +316,6 @@ static PDBGFFLOWTRACEREPORTINT dbgfR3FlowTraceReportCreate(PUVM pUVM, uint32_t c /** * Destroys the given report releasing all references hold to the containing records. * - * @returns nothing. * @param pReport The report to destroy. */ static void dbgfR3FlowTraceReportDestroy(PDBGFFLOWTRACEREPORTINT pReport) @@ -410,7 +408,6 @@ static int dbgfR3FlowTraceModProbeResolveIndirectAddr(PUVM pUVM, VMCPUID idCpu, /** * Destroys the given flow trace module freeing all allocated resources. * - * @returns nothing. * @param pThis The flow trace module instance data. */ static void dbgfR3FlowTraceModDestroy(PDBGFFLOWTRACEMODINT pThis) @@ -964,7 +961,6 @@ static PDBGFFLOWTRACEMODPROBELOC dbgfR3TraceModGetProbeLocAtAddr(PDBGFFLOWTRACEM /** * Cleans up any allocated resources for each entry in the given probe for the given range. * - * @returns nothing. * @param pProbe The probe instance. * @param idxStart Start index to clean up. * @param cEntries How many entries to clean up. @@ -1013,7 +1009,6 @@ static void dbgfR3ProbeEntryCleanup(PDBGFFLOWTRACEPROBEINT pProbe, uint32_t idxS /** * Destroys the given flow trace probe freeing all allocated resources. * - * @returns nothing. * @param pProbe The flow trace probe instance data. */ static void dbgfR3FlowTraceProbeDestroy(PDBGFFLOWTRACEPROBEINT pProbe) @@ -1150,7 +1145,6 @@ static int dbgfR3ProbeEntryDup(PUVM pUVM, PDBGFFLOWTRACEPROBEENTRY pDst, PCDBGFF /** * Recalculates the size occupied by the data of this probe for each invocation. * - * @returns nothing. * @param pProbe The probe instance. */ static void dbgfR3ProbeRecalcSize(PDBGFFLOWTRACEPROBEINT pProbe) diff --git a/src/VBox/VMM/VMMR3/DBGFR3SampleReport.cpp b/src/VBox/VMM/VMMR3/DBGFR3SampleReport.cpp index db15c87f8b7..31da3b52d19 100644 --- a/src/VBox/VMM/VMMR3/DBGFR3SampleReport.cpp +++ b/src/VBox/VMM/VMMR3/DBGFR3SampleReport.cpp @@ -262,7 +262,6 @@ static void dbgfR3SampleReportInfoHlpDelete(PDBGFSAMPLEREPORTINFOHLP pHlp) /** * Frees the given frame and all its descendants. * - * @returns nothing. * @param pFrame The frame to free. */ static void dbgfR3SampleReportFrameFree(PDBGFSAMPLEFRAME pFrame) @@ -278,7 +277,6 @@ static void dbgfR3SampleReportFrameFree(PDBGFSAMPLEFRAME pFrame) /** * Destroys the given sample report freeing all allocated resources. * - * @returns nothing. * @param pThis The sample report instance data. */ static void dbgfR3SampleReportDestroy(PDBGFSAMPLEREPORTINT pThis) @@ -363,7 +361,6 @@ static DECLCALLBACK(int) dbgfR3SampleReportFrameSortCmp(void const *pvElement1, /** * Dumps a single given frame to the release log. * - * @returns nothing. * @param pHlp The debug info helper used for printing. * @param pUVM The usermode VM handle. * @param pFrame The frame to dump. @@ -410,7 +407,6 @@ static void dbgfR3SampleReportDumpFrame(PCDBGFINFOHLP pHlp, PUVM pUVM, PCDBGFSAM * Worker for dbgfR3SampleReportTakeSample(), doing the work in an EMT rendezvous point on * each VCPU. * - * @returns nothing. * @param pThis Pointer to the sample report instance. */ static DECLCALLBACK(void) dbgfR3SampleReportSample(PDBGFSAMPLEREPORTINT pThis) diff --git a/src/VBox/VMM/VMMR3/DBGFR3Tracer.cpp b/src/VBox/VMM/VMMR3/DBGFR3Tracer.cpp index 9dccb95cc26..fb69f4fd1d2 100644 --- a/src/VBox/VMM/VMMR3/DBGFR3Tracer.cpp +++ b/src/VBox/VMM/VMMR3/DBGFR3Tracer.cpp @@ -1045,7 +1045,6 @@ DECLHIDDEN(int) dbgfR3TracerInit(PVM pVM) /** * Terminates any configured tracer for the given VM instance. * - * @returns nothing. * @param pVM The cross context VM structure. */ DECLHIDDEN(void) dbgfR3TracerTerm(PVM pVM) diff --git a/src/VBox/VMM/VMMR3/DBGFR3Type.cpp b/src/VBox/VMM/VMMR3/DBGFR3Type.cpp index 2e196ae85b7..3c8c25648c9 100644 --- a/src/VBox/VMM/VMMR3/DBGFR3Type.cpp +++ b/src/VBox/VMM/VMMR3/DBGFR3Type.cpp @@ -1226,7 +1226,6 @@ VMMR3DECL(int) DBGFR3TypeQueryValByType(PUVM pUVM, PCDBGFADDRESS pAddress, const * Frees all acquired resources of a value previously obtained with * DBGFR3TypeQueryValByType(). * - * @returns nothing. * @param pVal The value to free. */ VMMR3DECL(void) DBGFR3TypeValFree(PDBGFTYPEVAL pVal) diff --git a/src/VBox/VMM/VMMR3/GCM.cpp b/src/VBox/VMM/VMMR3/GCM.cpp index 2fbf971305f..e2077d1eee5 100644 --- a/src/VBox/VMM/VMMR3/GCM.cpp +++ b/src/VBox/VMM/VMMR3/GCM.cpp @@ -249,7 +249,6 @@ VMMR3_INT_DECL(void) GCMR3Relocate(PVM pVM, RTGCINTPTR offDelta) * * Do whatever fixer-specific resetting that needs to be done. * - * @returns VBox status code. * @param pVM The cross context VM structure. */ VMMR3_INT_DECL(void) GCMR3Reset(PVM pVM) diff --git a/src/VBox/VMM/VMMR3/GIM.cpp b/src/VBox/VMM/VMMR3/GIM.cpp index 622d1e8e786..145765ba212 100644 --- a/src/VBox/VMM/VMMR3/GIM.cpp +++ b/src/VBox/VMM/VMMR3/GIM.cpp @@ -417,7 +417,6 @@ VMMR3_INT_DECL(void) GIMR3Relocate(PVM pVM, RTGCINTPTR offDelta) * For the GIM component this means unmapping and unregistering MMIO2 regions * and other provider-specific resets. * - * @returns VBox status code. * @param pVM The cross context VM structure. */ VMMR3_INT_DECL(void) GIMR3Reset(PVM pVM) diff --git a/src/VBox/VMM/VMMR3/GMM.cpp b/src/VBox/VMM/VMMR3/GMM.cpp index bf2105bccf3..a92c70e6e41 100644 --- a/src/VBox/VMM/VMMR3/GMM.cpp +++ b/src/VBox/VMM/VMMR3/GMM.cpp @@ -174,7 +174,6 @@ GMMR3DECL(int) GMMR3FreePagesPrepare(PVM pVM, PGMMFREEPAGESREQ *ppReq, uint32_t /** * Re-prepares a GMMR0FreePages request. * - * @returns VINF_SUCCESS or VERR_NO_TMP_MEMORY. * @param pVM The cross context VM structure. * @param pReq A request buffer previously returned by * GMMR3FreePagesPrepare(). diff --git a/src/VBox/VMM/VMMR3/MM.cpp b/src/VBox/VMM/VMMR3/MM.cpp index a2e5c0d8659..863464e495a 100644 --- a/src/VBox/VMM/VMMR3/MM.cpp +++ b/src/VBox/VMM/VMMR3/MM.cpp @@ -535,7 +535,6 @@ VMMR3DECL(int) MMR3Term(PVM pVM) * Termination means cleaning up and freeing all resources, * the VM it self is at this point powered off or suspended. * - * @returns VBox status code. * @param pUVM Pointer to the user mode VM structure. */ VMMR3DECL(void) MMR3TermUVM(PUVM pUVM) diff --git a/src/VBox/VMM/VMMR3/NEMR3Native-darwin-armv8.cpp b/src/VBox/VMM/VMMR3/NEMR3Native-darwin-armv8.cpp index 24b61201ede..11d4e00ebc8 100644 --- a/src/VBox/VMM/VMMR3/NEMR3Native-darwin-armv8.cpp +++ b/src/VBox/VMM/VMMR3/NEMR3Native-darwin-armv8.cpp @@ -805,7 +805,6 @@ DECLINLINE(size_t) nemR3DarwinGetByteCountFromSas(uint8_t uSas) /** * Sets the given general purpose register to the given value. * - * @returns nothing. * @param pVCpu The cross context virtual CPU structure of the * calling EMT. * @param uReg The register index. diff --git a/src/VBox/VMM/VMMR3/NEMR3Native-darwin.cpp b/src/VBox/VMM/VMMR3/NEMR3Native-darwin.cpp index a4922ef081b..b3f8dd13e73 100644 --- a/src/VBox/VMM/VMMR3/NEMR3Native-darwin.cpp +++ b/src/VBox/VMM/VMMR3/NEMR3Native-darwin.cpp @@ -3389,7 +3389,6 @@ void nemR3NativeResetCpu(PVMCPU pVCpu, bool fInitIpi) /** * Dumps the VMCS in response to a faild hv_vcpu_run{_until}() call. * - * @returns nothing. * @param pVCpu The cross context virtual CPU structure. */ static void nemR3DarwinVmcsDump(PVMCPU pVCpu) diff --git a/src/VBox/VMM/VMMR3/PDMAsyncCompletion.cpp b/src/VBox/VMM/VMMR3/PDMAsyncCompletion.cpp index 20fb3740bca..e88067324da 100644 --- a/src/VBox/VMM/VMMR3/PDMAsyncCompletion.cpp +++ b/src/VBox/VMM/VMMR3/PDMAsyncCompletion.cpp @@ -786,7 +786,6 @@ bool pdmacEpIsTransferAllowed(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint32_t cb /** * Called by the endpoint if a task has finished. * - * @returns nothing * @param pTask Pointer to the finished task. * @param rc Status code of the completed request. * @param fCallCompletionHandler Flag whether the completion handler should be called to @@ -940,7 +939,6 @@ int pdmR3AsyncCompletionEpClassInit(PVM pVM, PCPDMASYNCCOMPLETIONEPCLASSOPS pEpC /** * Worker terminating all endpoint classes. * - * @returns nothing * @param pEndpointClass Pointer to the endpoint class to terminate. * * @remarks This method ensures that any still open endpoint is closed. @@ -977,7 +975,6 @@ static void pdmR3AsyncCompletionEpClassTerminate(PPDMASYNCCOMPLETIONEPCLASS pEnd /** * Records the size of the request in the statistics. * - * @returns nothing. * @param pEndpoint The endpoint to register the request size for. * @param cbReq Size of the request. */ @@ -1020,7 +1017,6 @@ static void pdmR3AsyncCompletionStatisticsRecordSize(PPDMASYNCCOMPLETIONENDPOINT /** * Records the required processing time of a request. * - * @returns nothing. * @param pEndpoint The endpoint. * @param cNsRun The request time in nanoseconds. */ @@ -1233,7 +1229,6 @@ static int pdmR3AsyncCompletionStatisticsRegister(PPDMASYNCCOMPLETIONENDPOINT pE /** * Deregisters advanced statistics for one endpoint. * - * @returns nothing. * @param pEndpoint The endpoint to deregister the advanced statistics for. */ static void pdmR3AsyncCompletionStatisticsDeregister(PPDMASYNCCOMPLETIONENDPOINT pEndpoint) @@ -1286,7 +1281,6 @@ int pdmR3AsyncCompletionTerm(PVM pVM) /** * Resume worker for the async completion manager. * - * @returns nothing. * @param pVM The cross context VM structure. */ void pdmR3AsyncCompletionResume(PVM pVM) @@ -1373,7 +1367,6 @@ static PPDMASYNCCOMPLETIONTASK pdmR3AsyncCompletionGetTask(PPDMASYNCCOMPLETIONEN /** * Puts a task in one of the caches. * - * @returns nothing. * @param pEndpoint The endpoint the task belongs to. * @param pTask The task to cache. */ @@ -1511,7 +1504,6 @@ VMMR3DECL(int) PDMR3AsyncCompletionEpCreateForFile(PPPDMASYNCCOMPLETIONENDPOINT /** * Closes a endpoint waiting for any pending tasks to finish. * - * @returns nothing. * @param pEndpoint Handle of the endpoint. */ VMMR3DECL(void) PDMR3AsyncCompletionEpClose(PPDMASYNCCOMPLETIONENDPOINT pEndpoint) diff --git a/src/VBox/VMM/VMMR3/PDMAsyncCompletionFile.cpp b/src/VBox/VMM/VMMR3/PDMAsyncCompletionFile.cpp index f26da9a9e45..8f3e9ad8ccd 100644 --- a/src/VBox/VMM/VMMR3/PDMAsyncCompletionFile.cpp +++ b/src/VBox/VMM/VMMR3/PDMAsyncCompletionFile.cpp @@ -106,7 +106,6 @@ static const DBGCCMD g_aCmds[] = /** * Frees a task. * - * @returns nothing. * @param pEndpoint Pointer to the endpoint the segment was for. * @param pTask The task to free. */ @@ -516,7 +515,6 @@ int pdmacFileAioMgrCreate(PPDMASYNCCOMPLETIONEPCLASSFILE pEpClass, PPPDMACEPFILE /** * Destroys a async I/O manager. * - * @returns nothing. * @param pEpClassFile Pointer to globals for the file endpoint class. * @param pAioMgr The async I/O manager to destroy. */ diff --git a/src/VBox/VMM/VMMR3/PDMAsyncCompletionFileNormal.cpp b/src/VBox/VMM/VMMR3/PDMAsyncCompletionFileNormal.cpp index 7e336bc2bc4..5d9d1520038 100644 --- a/src/VBox/VMM/VMMR3/PDMAsyncCompletionFileNormal.cpp +++ b/src/VBox/VMM/VMMR3/PDMAsyncCompletionFileNormal.cpp @@ -260,7 +260,6 @@ static bool pdmacFileAioMgrNormalIsBalancePossible(PPDMACEPFILEMGR pAioMgr) * Creates a new I/O manager and spreads the I/O load of the endpoints * between the given I/O manager and the new one. * - * @returns nothing. * @param pAioMgr The I/O manager with high I/O load. */ static void pdmacFileAioMgrNormalBalanceLoad(PPDMACEPFILEMGR pAioMgr) @@ -542,7 +541,6 @@ static RTFILEAIOREQ pdmacFileAioMgrNormalRequestAlloc(PPDMACEPFILEMGR pAioMgr) /** * Frees a async I/O request handle. * - * @returns nothing. * @param pAioMgr The I/O manager. * @param hReq The I/O request handle to free. */ diff --git a/src/VBox/VMM/VMMR3/PDMBlkCache.cpp b/src/VBox/VMM/VMMR3/PDMBlkCache.cpp index b501b71a874..79993f94b07 100644 --- a/src/VBox/VMM/VMMR3/PDMBlkCache.cpp +++ b/src/VBox/VMM/VMMR3/PDMBlkCache.cpp @@ -97,7 +97,6 @@ static bool pdmBlkCacheAddDirtyEntry(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEENTRY p /** * Add message to the VM trace buffer. * - * @returns nothing. * @param pBlkCache The block cache. * @param pszFmt The format string. * @param ... Additional parameters for the string formatter. @@ -117,7 +116,6 @@ DECLINLINE(void) pdmBlkCacheR3TraceMsgF(PPDMBLKCACHE pBlkCache, const char *pszF /** * Decrement the reference counter of the given cache entry. * - * @returns nothing. * @param pEntry The entry to release. */ DECLINLINE(void) pdmBlkCacheEntryRelease(PPDMBLKCACHEENTRY pEntry) @@ -129,7 +127,6 @@ DECLINLINE(void) pdmBlkCacheEntryRelease(PPDMBLKCACHEENTRY pEntry) /** * Increment the reference counter of the given cache entry. * - * @returns nothing. * @param pEntry The entry to reference. */ DECLINLINE(void) pdmBlkCacheEntryRef(PPDMBLKCACHEENTRY pEntry) @@ -195,7 +192,6 @@ DECLINLINE(void) pdmBlkCacheListSub(PPDMBLKLRULIST pList, uint32_t cbAmount) /** * Checks consistency of a LRU list. * - * @returns nothing * @param pList The LRU list to check. * @param pNotInList Element which is not allowed to occur in the list. */ @@ -229,7 +225,6 @@ static void pdmBlkCacheCheckList(PPDMBLKLRULIST pList, PPDMBLKCACHEENTRY pNotInL /** * Unlinks a cache entry from the LRU list it is assigned to. * - * @returns nothing. * @param pEntry The entry to unlink. */ static void pdmBlkCacheEntryRemoveFromList(PPDMBLKCACHEENTRY pEntry) @@ -284,7 +279,6 @@ static void pdmBlkCacheEntryRemoveFromList(PPDMBLKCACHEENTRY pEntry) * Adds a cache entry to the given LRU list unlinking it from the currently * assigned list if needed. * - * @returns nothing. * @param pList List to the add entry to. * @param pEntry Entry to add. */ @@ -320,7 +314,6 @@ static void pdmBlkCacheEntryAddToList(PPDMBLKLRULIST pList, PPDMBLKCACHEENTRY pE /** * Destroys a LRU list freeing all entries. * - * @returns nothing * @param pList Pointer to the LRU list to destroy. * * @note The caller must own the critical section of the cache. @@ -621,8 +614,8 @@ static int pdmBlkCacheEntryReadFromMedium(PPDMBLKCACHEENTRY pEntry) /** * Initiates a write I/O task for the given entry. * - * @returns nothing. - * @param pEntry The entry to read the data from. + * @returns VBox status code. + * @param pEntry The entry to read the data from. */ static int pdmBlkCacheEntryWriteToMedium(PPDMBLKCACHEENTRY pEntry) { @@ -685,7 +678,6 @@ static int pdmBlkCacheRequestPassthrough(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEREQ /** * Commit a single dirty entry to the endpoint * - * @returns nothing * @param pEntry The entry to commit. */ static void pdmBlkCacheEntryCommit(PPDMBLKCACHEENTRY pEntry) @@ -700,7 +692,6 @@ static void pdmBlkCacheEntryCommit(PPDMBLKCACHEENTRY pEntry) /** * Commit all dirty entries for a single endpoint. * - * @returns nothing. * @param pBlkCache The endpoint cache to commit. */ static void pdmBlkCacheCommit(PPDMBLKCACHE pBlkCache) @@ -757,7 +748,6 @@ static void pdmBlkCacheCommit(PPDMBLKCACHE pBlkCache) /** * Commit all dirty entries in the cache. * - * @returns nothing. * @param pCache The global cache instance. */ static void pdmBlkCacheCommitDirtyEntries(PPDMBLKCACHEGLOBAL pCache) @@ -1611,7 +1601,6 @@ static PPDMBLKCACHEENTRY pdmBlkCacheGetCacheEntryByOffset(PPDMBLKCACHE pBlkCache /** * Return the best fit cache entries for the given offset. * - * @returns nothing. * @param pBlkCache The endpoint cache. * @param off The offset. * @param ppEntryAbove Where to store the pointer to the best fit entry above @@ -1727,12 +1716,10 @@ DECLINLINE(bool) pdmBlkCacheEntryFlagIsSetClearAcquireLock(PPDMBLKCACHE pBlkCach * Adds a segment to the waiting list for a cache entry * which is currently in progress. * - * @returns nothing. * @param pEntry The cache entry to add the segment to. * @param pWaiter The waiter entry to add. */ -DECLINLINE(void) pdmBlkCacheEntryAddWaiter(PPDMBLKCACHEENTRY pEntry, - PPDMBLKCACHEWAITER pWaiter) +DECLINLINE(void) pdmBlkCacheEntryAddWaiter(PPDMBLKCACHEENTRY pEntry, PPDMBLKCACHEWAITER pWaiter) { pWaiter->pNext = NULL; diff --git a/src/VBox/VMM/VMMR3/PDMNetShaper.cpp b/src/VBox/VMM/VMMR3/PDMNetShaper.cpp index 7c01015996b..d1326f3fe3c 100644 --- a/src/VBox/VMM/VMMR3/PDMNetShaper.cpp +++ b/src/VBox/VMM/VMMR3/PDMNetShaper.cpp @@ -399,7 +399,6 @@ static DECLCALLBACK(void) pdmR3NsUnchokeTimer(PVM pVM, TMTIMERHANDLE hTimer, voi /** * Terminate the network shaper, groups, lock and everything. * - * @returns VBox error code. * @param pVM The cross context VM structure. */ void pdmR3NetShaperTerm(PVM pVM) diff --git a/src/VBox/VMM/VMMR3/PDMQueue.cpp b/src/VBox/VMM/VMMR3/PDMQueue.cpp index ac0bb1bc81e..87acc363966 100644 --- a/src/VBox/VMM/VMMR3/PDMQueue.cpp +++ b/src/VBox/VMM/VMMR3/PDMQueue.cpp @@ -861,7 +861,6 @@ static DECLCALLBACK(void) pdmR3QueueTimer(PVM pVM, TMTIMERHANDLE hTimer, void *p /** * Terminate the queues, freeing any resources still allocated. * - * @returns nothing. * @param pVM The cross-context VM structure. */ DECLHIDDEN(void) pdmR3QueueTerm(PVM pVM) diff --git a/src/VBox/VMM/VMMR3/PGMPhys.cpp b/src/VBox/VMM/VMMR3/PGMPhys.cpp index bfa9cac6817..04b5888ea1f 100644 --- a/src/VBox/VMM/VMMR3/PGMPhys.cpp +++ b/src/VBox/VMM/VMMR3/PGMPhys.cpp @@ -5210,7 +5210,6 @@ static DECLCALLBACK(VBOXSTRICTRC) pgmR3PhysChangeMemBalloonRendezvous(PVM pVM, P /** * Frees a range of ram pages, replacing them with ZERO pages; helper for PGMR3PhysFreeRamPages * - * @returns VBox status code. * @param pVM The cross context VM structure. * @param fInflate Inflate or deflate memory balloon * @param cPages Number of pages to free @@ -5684,7 +5683,6 @@ static DECLCALLBACK(VBOXSTRICTRC) pgmR3PhysUnmapChunkRendezvous(PVM pVM, PVMCPU /** * Unmap a chunk to free up virtual address space (request packet handler for pgmR3PhysChunkMap) * - * @returns VBox status code. * @param pVM The cross context VM structure. */ static DECLCALLBACK(void) pgmR3PhysUnmapChunk(PVM pVM) diff --git a/src/VBox/VMM/VMMR3/TM.cpp b/src/VBox/VMM/VMMR3/TM.cpp index 26e19ad9c1f..a18b38a5ebe 100644 --- a/src/VBox/VMM/VMMR3/TM.cpp +++ b/src/VBox/VMM/VMMR3/TM.cpp @@ -3571,8 +3571,8 @@ VMMR3DECL(int) TMR3GetCpuLoadPercents(PUVM pUVM, VMCPUID idCpu, uint64_t *pcMsIn #ifndef VBOX_WITHOUT_NS_ACCOUNTING /** - * Helper for tmR3CpuLoadTimer. - * @returns + * Helper for tmR3CpuLoadTimer. + * * @param pState The state to update. * @param cNsTotal Total time. * @param cNsExecuting Time executing. diff --git a/src/VBox/VMM/include/DBGFInline.h b/src/VBox/VMM/include/DBGFInline.h index 65207773be7..6904f7bb25f 100644 --- a/src/VBox/VMM/include/DBGFInline.h +++ b/src/VBox/VMM/include/DBGFInline.h @@ -35,7 +35,6 @@ /** * Initializes the given L2 table entry with the given values. * - * @returns nothing. * @param pL2Entry The L2 entry to intialize. * @param hBp The breakpoint handle. * @param GCPtr The GC pointer used as the key (only the upper 6 bytes are used). @@ -61,7 +60,6 @@ DECLINLINE(void) dbgfBpL2TblEntryInit(PDBGFBPL2ENTRY pL2Entry, DBGFBP hBp, RTGCP /** * Updates the given L2 table entry with the new pointers. * - * @returns nothing. * @param pL2Entry The L2 entry to update. * @param idxL2Left The new left L2 table index. * @param idxL2Right The new right L2 table index. @@ -82,7 +80,6 @@ DECLINLINE(void) dbgfBpL2TblEntryUpdate(PDBGFBPL2ENTRY pL2Entry, uint32_t idxL2L /** * Updates the given L2 table entry with the left pointer. * - * @returns nothing. * @param pL2Entry The L2 entry to update. * @param idxL2Left The new left L2 table index. * @param iDepth The new depth of the tree. @@ -102,7 +99,6 @@ DECLINLINE(void) dbgfBpL2TblEntryUpdateLeft(PDBGFBPL2ENTRY pL2Entry, uint32_t id /** * Updates the given L2 table entry with the right pointer. * - * @returns nothing. * @param pL2Entry The L2 entry to update. * @param idxL2Right The new right L2 table index. * @param iDepth The new depth of the tree. diff --git a/src/VBox/VMM/include/IEMInternal-armv8.h b/src/VBox/VMM/include/IEMInternal-armv8.h index 7164f0d70fc..ff883f3df0f 100644 --- a/src/VBox/VMM/include/IEMInternal-armv8.h +++ b/src/VBox/VMM/include/IEMInternal-armv8.h @@ -741,7 +741,6 @@ typedef struct IEM /** Hint to IEMAllInstructionPython.py that this macro should be skipped. */ #define IEMOPHINT_SKIP_PYTHON RT_BIT_32(31) -/** @} */ /** @def IEM_DECL_IMPL_TYPE * For typedef'ing an instruction implementation function. diff --git a/src/VBox/VMM/testcase/tstPDMAsyncCompletionStress.cpp b/src/VBox/VMM/testcase/tstPDMAsyncCompletionStress.cpp index b8f041191d8..ebd72f2272d 100644 --- a/src/VBox/VMM/testcase/tstPDMAsyncCompletionStress.cpp +++ b/src/VBox/VMM/testcase/tstPDMAsyncCompletionStress.cpp @@ -531,7 +531,6 @@ static int tstPDMACStressTestFileOpen(PVM pVM, PPDMACTESTFILE pTestFile, unsigne /** * Closes a test file. * - * @returns nothing. * @param pTestFile Pointer to the test file. */ static void tstPDMACStressTestFileClose(PPDMACTESTFILE pTestFile) diff --git a/src/VBox/ValidationKit/utils/serial/SerialTest.cpp b/src/VBox/ValidationKit/utils/serial/SerialTest.cpp index 64ea4869dd0..87a53546a03 100644 --- a/src/VBox/ValidationKit/utils/serial/SerialTest.cpp +++ b/src/VBox/ValidationKit/utils/serial/SerialTest.cpp @@ -235,7 +235,6 @@ static void serialTestFailed(RTTEST hTest, const char *pszFmt, ...) /** * Initializes a TX buffer. * - * @returns nothing. * @param pSerBuf The serial buffer to initialize. * @param cbTx Maximum number of bytes to transmit. */ @@ -252,7 +251,6 @@ static void serialTestTxBufInit(PSERIALTESTTXRXBUFCNT pSerBuf, size_t cbTx) /** * Initializes a RX buffer. * - * @returns nothing. * @param pSerBuf The serial buffer to initialize. * @param cbRx Maximum number of bytes to receive. */ @@ -269,7 +267,6 @@ static void serialTestRxBufInit(PSERIALTESTTXRXBUFCNT pSerBuf, size_t cbRx) /** * Prepares the given TX buffer with data for sending it out. * - * @returns nothing. * @param pSerBuf The TX buffer pointer. */ static void serialTestTxBufPrepare(PSERIALTESTTXRXBUFCNT pSerBuf) diff --git a/src/VBox/ValidationKit/utils/storage/IoPerf.cpp b/src/VBox/ValidationKit/utils/storage/IoPerf.cpp index a430579eab5..fb56d43cd28 100644 --- a/src/VBox/ValidationKit/utils/storage/IoPerf.cpp +++ b/src/VBox/ValidationKit/utils/storage/IoPerf.cpp @@ -523,7 +523,6 @@ static void *ioPerfJobTestGetWriteBufForOffset(PIOPERFJOB pJob, uint64_t off) /** * Initialize the given request for submission. * - * @returns nothing. * @param pJob The job data for the current worker. * @param pIoReq The request to initialize. */ @@ -639,7 +638,6 @@ static int ioPerfJobTestInit(PIOPERFJOB pJob) /** * Frees allocated resources specific for the current test. * - * @returns nothing. * @param pJob The job data for the current worker. */ static void ioPerfJobTestFinish(PIOPERFJOB pJob) @@ -808,7 +806,6 @@ static int ioPerfJobTestIoLoop(PIOPERFJOB pJob) * Calculates the statistic values for the given job after a * test finished. * - * @returns nothing. * @param pJob The job data. */ static void ioPerfJobStats(PIOPERFJOB pJob) diff --git a/src/VBox/ValidationKit/utils/usb/UsbTest.cpp b/src/VBox/ValidationKit/utils/usb/UsbTest.cpp index 77fde78518e..6a173adf3b2 100644 --- a/src/VBox/ValidationKit/utils/usb/UsbTest.cpp +++ b/src/VBox/ValidationKit/utils/usb/UsbTest.cpp @@ -477,7 +477,6 @@ static int usbTestIoctl(int iDevFd, int iInterface, PUSBTESTPARAMS pParams) /** * Test execution worker. * - * @returns nothing. * @param pszDevice The device to use for testing. */ static void usbTestExec(const char *pszDevice) diff --git a/src/VBox/ValidationKit/utils/usb/UsbTestService.cpp b/src/VBox/ValidationKit/utils/usb/UsbTestService.cpp index 36d55ad94d8..370bafb1c3b 100644 --- a/src/VBox/ValidationKit/utils/usb/UsbTestService.cpp +++ b/src/VBox/ValidationKit/utils/usb/UsbTestService.cpp @@ -1069,7 +1069,6 @@ static int utsClientReqProcess(PUTSCLIENT pClient) /** * Destroys a client instance. * - * @returns nothing. * @param pClient The UTS client structure. */ static void utsClientDestroy(PUTSCLIENT pClient) diff --git a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadget.cpp b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadget.cpp index 709540c5920..8da7084565a 100644 --- a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadget.cpp +++ b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadget.cpp @@ -88,7 +88,6 @@ static const PCUTSGADGETCLASSIF g_apUtsGadgetClass[] = /** * Destroys a gadget instance. * - * @returns nothing. * @param pThis The gadget instance. */ static void utsGadgetDestroy(PUTSGADGETINT pThis) diff --git a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetClassTest.cpp b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetClassTest.cpp index 7f10b66bc1c..b1fbad573c0 100644 --- a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetClassTest.cpp +++ b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetClassTest.cpp @@ -243,7 +243,6 @@ static int utsGadgetClassTestUnlinkFuncFromCfg(PUTSGADGETCLASSINT pClass, const /** * Cleans up any leftover configurations from the gadget class. * - * @returns nothing. * @param pClass The gadget class instance data. */ static void utsGadgetClassTestCleanup(PUTSGADGETCLASSINT pClass) diff --git a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetHost.cpp b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetHost.cpp index 36de53369d4..4ade74cac7d 100644 --- a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetHost.cpp +++ b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetHost.cpp @@ -87,7 +87,6 @@ static const PCUTSGADGETHOSTIF g_apUtsGadgetHostIf[] = /** * Destroys a gadget host instance. * - * @returns nothing. * @param pThis The gadget host instance. */ static void utsGadgetHostDestroy(PUTSGADGETHOSTINT pThis) diff --git a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetHostInternal.h b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetHostInternal.h index 989c2cee993..fedd32f14eb 100644 --- a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetHostInternal.h +++ b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetHostInternal.h @@ -76,7 +76,6 @@ typedef struct UTSGADGETHOSTIF /** * Terminates the gadget host interface. * - * @returns nothing. * @param pIf The interface specific instance data. */ DECLR3CALLBACKMEMBER(void, pfnTerm, (PUTSGADGETHOSTTYPEINT pIf)); diff --git a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetInternal.h b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetInternal.h index a1a5f4ae7c7..c742a996e2d 100644 --- a/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetInternal.h +++ b/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetInternal.h @@ -76,7 +76,6 @@ typedef struct UTSGADGETCLASSIF /** * Terminates the gadget class instance. * - * @returns nothing. * @param pClass The interface specific instance data. */ DECLR3CALLBACKMEMBER(void, pfnTerm, (PUTSGADGETCLASSINT pClass)); diff --git a/src/VBox/ValidationKit/utils/usb/UsbTestServiceProtocol.cpp b/src/VBox/ValidationKit/utils/usb/UsbTestServiceProtocol.cpp index 121159d4a43..25cddf4d6ef 100644 --- a/src/VBox/ValidationKit/utils/usb/UsbTestServiceProtocol.cpp +++ b/src/VBox/ValidationKit/utils/usb/UsbTestServiceProtocol.cpp @@ -49,7 +49,6 @@ /** * Converts a UTS packet header from host to network byte order. * - * @returns nothing. * @param pPktHdr The packet header to convert. */ DECLINLINE(void) utsProtocolPktHdrH2N(PUTSPKTHDR pPktHdr) @@ -62,7 +61,6 @@ DECLINLINE(void) utsProtocolPktHdrH2N(PUTSPKTHDR pPktHdr) /** * Converts a UTS packet header from network to host byte order. * - * @returns nothing. * @param pPktHdr The packet header to convert. */ DECLINLINE(void) utsProtocolPktHdrN2H(PUTSPKTHDR pPktHdr) @@ -75,7 +73,6 @@ DECLINLINE(void) utsProtocolPktHdrN2H(PUTSPKTHDR pPktHdr) /** * Converts a UTS status header from host to network byte order. * - * @returns nothing. * @param pPktHdr The packet header to convert. */ DECLINLINE(void) utsProtocolStsHdrH2N(PUTSPKTSTS pPktHdr) @@ -89,7 +86,6 @@ DECLINLINE(void) utsProtocolStsHdrH2N(PUTSPKTSTS pPktHdr) /** * Converts a UTS status header from network to host byte order. * - * @returns nothing. * @param pPktHdr The packet header to convert. */ DECLINLINE(void) utsProtocolStsHdrN2H(PUTSPKTSTS pPktHdr) diff --git a/src/VBox/ValidationKit/utils/usb/UsbTestServiceProtocol.h b/src/VBox/ValidationKit/utils/usb/UsbTestServiceProtocol.h index a9b6d294cf8..bc408070dbc 100644 --- a/src/VBox/ValidationKit/utils/usb/UsbTestServiceProtocol.h +++ b/src/VBox/ValidationKit/utils/usb/UsbTestServiceProtocol.h @@ -343,7 +343,6 @@ DECLINLINE(bool) utsIsSameOpcode(PCUTSPKTHDR pPktHdr, const char *pszOpcode2) /** * Converts a UTS request packet from host to network byte ordering. * - * @returns nothing. * @param pPktHdr The packet to convert. */ DECLHIDDEN(void) utsProtocolReqH2N(PUTSPKTHDR pPktHdr); @@ -351,7 +350,6 @@ DECLHIDDEN(void) utsProtocolReqH2N(PUTSPKTHDR pPktHdr); /** * Converts a UTS request packet from network to host byte ordering. * - * @returns nothing. * @param pPktHdr The packet to convert. */ DECLHIDDEN(void) utsProtocolReqN2H(PUTSPKTHDR pPktHdr); @@ -359,7 +357,6 @@ DECLHIDDEN(void) utsProtocolReqN2H(PUTSPKTHDR pPktHdr); /** * Converts a UTS reply packet from host to network byte ordering. * - * @returns nothing. * @param pPktHdr The packet to convert. */ DECLHIDDEN(void) utsProtocolRepH2N(PUTSPKTHDR pPktHdr); @@ -367,7 +364,6 @@ DECLHIDDEN(void) utsProtocolRepH2N(PUTSPKTHDR pPktHdr); /** * Converts a UTS reply packet from network to host byte ordering. * - * @returns nothing. * @param pPktHdr The packet to convert. */ DECLHIDDEN(void) utsProtocolRepN2H(PUTSPKTHDR pPktHdr); -- cgit v1.2.1