diff options
Diffstat (limited to 'include')
33 files changed, 8 insertions, 87 deletions
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: * <pre> - * <param name="arg" ... dir="in" safearray="yes"/> + * <param name="arg" ... dir="in" safearray="yes"/> * ... - * <attribute name="arg" ... safearray="yes"/> + * <attribute name="arg" ... safearray="yes"/> * </pre> * * 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: * <pre> - * <param name="arg" ... dir="out" safearray="yes"/> - * <param name="arg" ... dir="return" safearray="yes"/> + * <param name="arg" ... dir="out" safearray="yes"/> + * <param name="arg" ... dir="return" safearray="yes"/> * ... - * <attribute name="arg" ... safearray="yes"/> + * <attribute name="arg" ... safearray="yes"/> * </pre> * * 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); |