diff options
| author | vboxsync <vboxsync@cfe28804-0f27-0410-a406-dd0f0b0b656f> | 2023-05-11 21:37:59 +0000 |
|---|---|---|
| committer | vboxsync <vboxsync@cfe28804-0f27-0410-a406-dd0f0b0b656f> | 2023-05-11 21:37:59 +0000 |
| commit | 485c4d3dd5e978987010fa329cfd9917ccbf9b5d (patch) | |
| tree | 5333c57322140dbdae4a4acfab5781b0d97d3b8f | |
| parent | 38495bc34974946f445e9d4539b132a0b998550b (diff) | |
| download | VirtualBox-svn-485c4d3dd5e978987010fa329cfd9917ccbf9b5d.tar.gz | |
IPRT: Make doxygen 1.9.6 happy. Mostly removing duplicate docs (iprt is documented in the header files). bugref:10442
git-svn-id: https://www.virtualbox.org/svn/vbox/trunk@99758 cfe28804-0f27-0410-a406-dd0f0b0b656f
37 files changed, 20 insertions, 2914 deletions
diff --git a/src/VBox/Runtime/Doxyfile b/src/VBox/Runtime/Doxyfile index 5a0d39746a3..be855aede35 100644 --- a/src/VBox/Runtime/Doxyfile +++ b/src/VBox/Runtime/Doxyfile @@ -247,7 +247,7 @@ ALIASES += udf260{2}="<a href=\"http://www.osta.org/specs/pdf/udf260.pdf#page=\2 # Generic ECMA spec reference - 1=spec-number 2=section, 3=page ALIASES += ecma{3}="<a href=\"https://www.ecma-international.org/publications/files/ECMA-ST/Ecma-\1.pdf#page=\3\">ECMA-\1:\2</a>" # ECMA-167 spec reference - 1=part 2=section, 3=page -ALIASES += ecma167{3}=\ecma{167,Part\1/\2,\3} +ALIASES += "ecma167{3}=\ecma{167,Part\1/\2,\3}" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" @@ -1666,7 +1666,7 @@ COMPACT_LATEX = NO # The default value is: a4. # This tag requires that the tag GENERATE_LATEX is set to YES. -PAPER_TYPE = a4wide +PAPER_TYPE = a4 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names # that should be included in the LaTeX output. The package can be specified just @@ -2139,6 +2139,18 @@ PREDEFINED += \ DECL_CHECK_RETURN_NOT_R3(type)=type \ RTCALL= +# context hacks. +PREDEFINED += RCPTRTYPE(RCType)=RCType +PREDEFINED += R3PTRTYPE(R3Type)=R3Type +PREDEFINED += R0PTRTYPE(R0Type)=R0Type +PREDEFINED += HCPTRTYPE(HCType)=HCType +PREDEFINED += R3R0PTRTYPE(R3R0Type)=R3R0Type +PREDEFINED += \ + "CTX_SUFF(var)=var##R3" \ + "CTX_SUFF_Z(var)=var##RZ" \ + "CTX_MID(first,last)=firstr##R3##last" \ + "CTX_MID_Z(first,last)=firstr##RZ##last" \ + # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The # macro definition that is found in the sources will be used. Use the PREDEFINED @@ -2153,10 +2165,6 @@ EXPAND_AS_DEFINED = ARCH_BITS \ R0_ARCH_BITS \ GCTYPE \ GCPTRTYPE \ - HCPTRTYPE \ - R0PTRTYPE \ - R3PTRTYPE \ - R3R0PTRTYPE \ DECLASMTYPE \ RTR3DECL \ RTR0DECL \ diff --git a/src/VBox/Runtime/common/checksum/crc64.cpp b/src/VBox/Runtime/common/checksum/crc64.cpp index d1f3fe9adbe..9d1418a33a9 100644 --- a/src/VBox/Runtime/common/checksum/crc64.cpp +++ b/src/VBox/Runtime/common/checksum/crc64.cpp @@ -160,13 +160,6 @@ static const uint64_t g_au64CRC64[] = }; -/** - * Calculate CRC64 for a memory block. - * - * @returns CRC64 for the memory block. - * @param pv Pointer to the memory block. - * @param cb Size of the memory block in bytes. - */ RTDECL(uint64_t) RTCrc64(const void *pv, size_t cb) { const uint8_t *pu8 = (const uint8_t *)pv; @@ -178,11 +171,6 @@ RTDECL(uint64_t) RTCrc64(const void *pv, size_t cb) RT_EXPORT_SYMBOL(RTCrc64); -/** - * Start a multiblock CRC64 calculation. - * - * @returns Start CRC64. - */ RTDECL(uint64_t) RTCrc64Start(void) { return 0ULL; @@ -190,14 +178,6 @@ RTDECL(uint64_t) RTCrc64Start(void) RT_EXPORT_SYMBOL(RTCrc64Start); -/** - * Processes a multiblock of a CRC64 calculation. - * - * @returns Intermediate CRC64 value. - * @param uCRC64 Current CRC64 intermediate value. - * @param pv The data block to process. - * @param cb The size of the data block in bytes. - */ RTDECL(uint64_t) RTCrc64Process(uint64_t uCRC64, const void *pv, size_t cb) { const uint8_t *pu8 = (const uint8_t *)pv; @@ -208,12 +188,6 @@ RTDECL(uint64_t) RTCrc64Process(uint64_t uCRC64, const void *pv, size_t cb) RT_EXPORT_SYMBOL(RTCrc64Process); -/** - * Complete a multiblock CRC64 calculation. - * - * @returns CRC64 value. - * @param uCRC64 Current CRC64 intermediate value. - */ RTDECL(uint64_t) RTCrc64Finish(uint64_t uCRC64) { return uCRC64; diff --git a/src/VBox/Runtime/common/checksum/manifest2.cpp b/src/VBox/Runtime/common/checksum/manifest2.cpp index d08598f40fe..32b858feccb 100644 --- a/src/VBox/Runtime/common/checksum/manifest2.cpp +++ b/src/VBox/Runtime/common/checksum/manifest2.cpp @@ -191,13 +191,6 @@ typedef struct RTMANIFESTQUERYATTRARGS typedef RTMANIFESTQUERYATTRARGS *PRTMANIFESTQUERYATTRARGS; -/** - * Creates an empty manifest. - * - * @returns IPRT status code. - * @param fFlags Flags, MBZ. - * @param phManifest Where to return the handle to the manifest. - */ RTDECL(int) RTManifestCreate(uint32_t fFlags, PRTMANIFEST phManifest) { AssertReturn(!fFlags, VERR_INVALID_PARAMETER); @@ -222,12 +215,7 @@ RTDECL(int) RTManifestCreate(uint32_t fFlags, PRTMANIFEST phManifest) return VINF_SUCCESS; } -/** - * Retains a reference to the manifest handle. - * - * @returns The new reference count, UINT32_MAX if the handle is invalid. - * @param hManifest The handle to retain. - */ + RTDECL(uint32_t) RTManifestRetain(RTMANIFEST hManifest) { RTMANIFESTINT *pThis = hManifest; @@ -267,14 +255,6 @@ static DECLCALLBACK(int) rtManifestDestroyEntry(PRTSTRSPACECORE pStr, void *pvUs } -/** - * Releases a reference to the manifest handle. - * - * @returns The new reference count, 0 if free. UINT32_MAX is returned if the - * handle is invalid. - * @param hManifest The handle to release. - * NIL is quietly ignored (returns 0). - */ RTDECL(uint32_t) RTManifestRelease(RTMANIFEST hManifest) { RTMANIFESTINT *pThis = hManifest; @@ -297,13 +277,6 @@ RTDECL(uint32_t) RTManifestRelease(RTMANIFEST hManifest) } -/** - * Creates a duplicate of the specified manifest. - * - * @returns IPRT status code - * @param hManifestSrc The manifest to clone. - * @param phManifestDst Where to store the handle to the duplicate. - */ RTDECL(int) RTManifestDup(RTMANIFEST hManifestSrc, PRTMANIFEST phManifestDst) { RTMANIFESTINT *pThis = hManifestSrc; @@ -739,17 +712,6 @@ static int rtManifestSetAttrWorker(PRTMANIFESTENTRY pEntry, const char *pszAttr, } -/** - * Sets a manifest attribute. - * - * @returns IPRT status code. - * @param hManifest The manifest handle. - * @param pszAttr The attribute name. If this already exists, - * its value will be replaced. - * @param pszValue The value string. - * @param fType The attribute type, pass - * RTMANIFEST_ATTR_UNKNOWN if not known. - */ RTDECL(int) RTManifestSetAttr(RTMANIFEST hManifest, const char *pszAttr, const char *pszValue, uint32_t fType) { RTMANIFESTINT *pThis = hManifest; @@ -783,15 +745,6 @@ static int rtManifestUnsetAttrWorker(PRTMANIFESTENTRY pEntry, const char *pszAtt } -/** - * Unsets (removes) a manifest attribute if it exists. - * - * @returns IPRT status code. - * @retval VWRN_NOT_FOUND if not found. - * - * @param hManifest The manifest handle. - * @param pszAttr The attribute name. - */ RTDECL(int) RTManifestUnsetAttr(RTMANIFEST hManifest, const char *pszAttr) { RTMANIFESTINT *pThis = hManifest; @@ -1040,21 +993,6 @@ static int rtManifestGetEntry(RTMANIFESTINT *pThis, const char *pszEntry, bool f } -/** - * Sets an attribute of a manifest entry. - * - * @returns IPRT status code. - * @param hManifest The manifest handle. - * @param pszEntry The entry name. This will automatically be - * added if there was no previous call to - * RTManifestEntryAdd for this name. See - * RTManifestEntryAdd for the entry name rules. - * @param pszAttr The attribute name. If this already exists, - * its value will be replaced. - * @param pszValue The value string. - * @param fType The attribute type, pass - * RTMANIFEST_ATTR_UNKNOWN if not known. - */ RTDECL(int) RTManifestEntrySetAttr(RTMANIFEST hManifest, const char *pszEntry, const char *pszAttr, const char *pszValue, uint32_t fType) { @@ -1106,16 +1044,6 @@ RTDECL(int) RTManifestEntrySetAttr(RTMANIFEST hManifest, const char *pszEntry, c } -/** - * Unsets (removes) an attribute of a manifest entry if they both exist. - * - * @returns IPRT status code. - * @retval VWRN_NOT_FOUND if not found. - * - * @param hManifest The manifest handle. - * @param pszEntry The entry name. - * @param pszAttr The attribute name. - */ RTDECL(int) RTManifestEntryUnsetAttr(RTMANIFEST hManifest, const char *pszEntry, const char *pszAttr) { RTMANIFESTINT *pThis = hManifest; @@ -1166,27 +1094,6 @@ RTDECL(int) RTManifestEntryQueryAttr(RTMANIFEST hManifest, const char *pszEntry, } -/** - * Adds a new entry to a manifest. - * - * The entry name rules: - * - The entry name can contain any character defined by unicode, except - * control characters, ':', '(' and ')'. The exceptions are mainly there - * because of uncertainty around how various formats handles these. - * - It is considered case sensitive. - * - Forward (unix) and backward (dos) slashes are considered path - * separators and converted to forward slashes. - * - * @returns IPRT status code. - * @retval VWRN_ALREADY_EXISTS if the entry already exists. - * - * @param hManifest The manifest handle. - * @param pszEntry The entry name (UTF-8). - * - * @remarks Some manifest formats will not be able to store an entry without - * any attributes. So, this is just here in case it comes in handy - * when dealing with formats which can. - */ RTDECL(int) RTManifestEntryAdd(RTMANIFEST hManifest, const char *pszEntry) { RTMANIFESTINT *pThis = hManifest; @@ -1238,13 +1145,6 @@ RTDECL(int) RTManifestEntryAdd(RTMANIFEST hManifest, const char *pszEntry) } -/** - * Removes an entry. - * - * @returns IPRT status code. - * @param hManifest The manifest handle. - * @param pszEntry The entry name. - */ RTDECL(int) RTManifestEntryRemove(RTMANIFEST hManifest, const char *pszEntry) { RTMANIFESTINT *pThis = hManifest; diff --git a/src/VBox/Runtime/common/checksum/manifest3.cpp b/src/VBox/Runtime/common/checksum/manifest3.cpp index 3fd1c636781..cebde3656ca 100644 --- a/src/VBox/Runtime/common/checksum/manifest3.cpp +++ b/src/VBox/Runtime/common/checksum/manifest3.cpp @@ -532,23 +532,6 @@ static RTVFSIOSTREAMOPS g_rtManifestPassthruIosOps = -/** - * Add an entry for an I/O stream using a passthru stream. - * - * The passthru I/O stream will hash all the data read from or written to the - * stream and automatically add an entry to the manifest with the desired - * attributes when it is released. Alternatively one can call - * RTManifestPtIosAddEntryNow() to have more control over exactly when this - * action is performed and which status it yields. - * - * @returns IPRT status code. - * @param hManifest The manifest to add the entry to. - * @param hVfsIos The I/O stream to pass thru to/from. - * @param pszEntry The entry name. - * @param fAttrs The attributes to create for this stream. - * @param fReadOrWrite Whether it's a read or write I/O stream. - * @param phVfsIosPassthru Where to return the new handle. - */ RTDECL(int) RTManifestEntryAddPassthruIoStream(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, const char *pszEntry, uint32_t fAttrs, bool fReadOrWrite, PRTVFSIOSTREAM phVfsIosPassthru) { @@ -601,13 +584,6 @@ RTDECL(int) RTManifestEntryAddPassthruIoStream(RTMANIFEST hManifest, RTVFSIOSTRE } -/** - * Adds the entry to the manifest right now. - * - * @returns IPRT status code. - * @param hVfsPtIos The manifest passthru I/O stream returned by - * RTManifestEntryAddPassthruIoStream(). - */ RTDECL(int) RTManifestPtIosAddEntryNow(RTVFSIOSTREAM hVfsPtIos) { PRTMANIFESTPTIOS pThis = (PRTMANIFESTPTIOS)RTVfsIoStreamToPrivate(hVfsPtIos, &g_rtManifestPassthruIosOps); @@ -620,12 +596,6 @@ RTDECL(int) RTManifestPtIosAddEntryNow(RTVFSIOSTREAM hVfsPtIos) } -/** - * Checks if the give I/O stream is a manifest passthru instance or not. - * - * @returns true if it's a manifest passthru I/O stream, false if not. - * @param hVfsPtIos Possible the manifest passthru I/O stream handle. - */ RTDECL(bool) RTManifestPtIosIsInstanceOf(RTVFSIOSTREAM hVfsPtIos) { if (hVfsPtIos != NIL_RTVFSIOSTREAM) @@ -638,19 +608,6 @@ RTDECL(bool) RTManifestPtIosIsInstanceOf(RTVFSIOSTREAM hVfsPtIos) } -/** - * Adds an entry for a file with the specified set of attributes. - * - * @returns IPRT status code. - * - * @param hManifest The manifest handle. - * @param hVfsIos The I/O stream handle of the entry. This will - * be processed to its end on successful return. - * (Must be positioned at the start to get - * the expected results.) - * @param pszEntry The entry name. - * @param fAttrs The attributes to create for this stream. - */ RTDECL(int) RTManifestEntryAddIoStream(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, const char *pszEntry, uint32_t fAttrs) { /* diff --git a/src/VBox/Runtime/common/dbg/dbgas.cpp b/src/VBox/Runtime/common/dbg/dbgas.cpp index 3706f986fbb..af8dd9180fc 100644 --- a/src/VBox/Runtime/common/dbg/dbgas.cpp +++ b/src/VBox/Runtime/common/dbg/dbgas.cpp @@ -184,16 +184,6 @@ static void rtDbgAsModuleUnlinkMod(PRTDBGASINT pDbgAs, PRTDBGASMOD pMod); static void rtDbgAsModuleUnlinkByMap(PRTDBGASINT pDbgAs, PRTDBGASMAP pMap); -/** - * Creates an empty address space. - * - * @returns IPRT status code. - * - * @param phDbgAs Where to store the address space handle on success. - * @param FirstAddr The first address in the address space. - * @param LastAddr The last address in the address space. - * @param pszName The name of the address space. - */ RTDECL(int) RTDbgAsCreate(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastAddr, const char *pszName) { /* @@ -237,17 +227,6 @@ RTDECL(int) RTDbgAsCreate(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastA RT_EXPORT_SYMBOL(RTDbgAsCreate); -/** - * Variant of RTDbgAsCreate that takes a name format string. - * - * @returns IPRT status code. - * - * @param phDbgAs Where to store the address space handle on success. - * @param FirstAddr The first address in the address space. - * @param LastAddr The last address in the address space. - * @param pszNameFmt The name format of the address space. - * @param va Format arguments. - */ RTDECL(int) RTDbgAsCreateV(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastAddr, const char *pszNameFmt, va_list va) { AssertPtrReturn(pszNameFmt, VERR_INVALID_POINTER); @@ -265,17 +244,6 @@ RTDECL(int) RTDbgAsCreateV(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR Last RT_EXPORT_SYMBOL(RTDbgAsCreateV); -/** - * Variant of RTDbgAsCreate that takes a name format string. - * - * @returns IPRT status code. - * - * @param phDbgAs Where to store the address space handle on success. - * @param FirstAddr The first address in the address space. - * @param LastAddr The last address in the address space. - * @param pszNameFmt The name format of the address space. - * @param ... Format arguments. - */ RTDECL(int) RTDbgAsCreateF(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastAddr, const char *pszNameFmt, ...) { va_list va; @@ -360,15 +328,6 @@ static void rtDbgAsDestroy(PRTDBGASINT pDbgAs) } -/** - * Retains another reference to the address space. - * - * @returns New reference count, UINT32_MAX on invalid handle (asserted). - * - * @param hDbgAs The address space handle. - * - * @remarks Will not take any locks. - */ RTDECL(uint32_t) RTDbgAsRetain(RTDBGAS hDbgAs) { PRTDBGASINT pDbgAs = hDbgAs; @@ -378,21 +337,6 @@ RTDECL(uint32_t) RTDbgAsRetain(RTDBGAS hDbgAs) RT_EXPORT_SYMBOL(RTDbgAsRetain); -/** - * Release a reference to the address space. - * - * When the reference count reaches zero, the address space is destroyed. - * That means unlinking all the modules it currently contains, potentially - * causing some or all of them to be destroyed as they are managed by - * reference counting. - * - * @returns New reference count, UINT32_MAX on invalid handle (asserted). - * - * @param hDbgAs The address space handle. The NIL handle is quietly - * ignored and 0 is returned. - * - * @remarks Will not take any locks. - */ RTDECL(uint32_t) RTDbgAsRelease(RTDBGAS hDbgAs) { if (hDbgAs == NIL_RTDBGAS) @@ -428,16 +372,6 @@ RTDECL(int) RTDbgAsUnlockExcl(RTDBGAS hDbgAs) RT_EXPORT_SYMBOL(RTDbgAsUnlockExcl); -/** - * Gets the name of an address space. - * - * @returns read only address space name. - * NULL if hDbgAs is invalid. - * - * @param hDbgAs The address space handle. - * - * @remarks Will not take any locks. - */ RTDECL(const char *) RTDbgAsName(RTDBGAS hDbgAs) { PRTDBGASINT pDbgAs = hDbgAs; @@ -447,16 +381,6 @@ RTDECL(const char *) RTDbgAsName(RTDBGAS hDbgAs) RT_EXPORT_SYMBOL(RTDbgAsName); -/** - * Gets the first address in an address space. - * - * @returns The address. - * 0 if hDbgAs is invalid. - * - * @param hDbgAs The address space handle. - * - * @remarks Will not take any locks. - */ RTDECL(RTUINTPTR) RTDbgAsFirstAddr(RTDBGAS hDbgAs) { PRTDBGASINT pDbgAs = hDbgAs; @@ -466,16 +390,6 @@ RTDECL(RTUINTPTR) RTDbgAsFirstAddr(RTDBGAS hDbgAs) RT_EXPORT_SYMBOL(RTDbgAsFirstAddr); -/** - * Gets the last address in an address space. - * - * @returns The address. - * 0 if hDbgAs is invalid. - * - * @param hDbgAs The address space handle. - * - * @remarks Will not take any locks. - */ RTDECL(RTUINTPTR) RTDbgAsLastAddr(RTDBGAS hDbgAs) { PRTDBGASINT pDbgAs = hDbgAs; @@ -484,18 +398,7 @@ RTDECL(RTUINTPTR) RTDbgAsLastAddr(RTDBGAS hDbgAs) } RT_EXPORT_SYMBOL(RTDbgAsLastAddr); -/** - * Gets the number of modules in the address space. - * - * This can be used together with RTDbgAsModuleByIndex - * to enumerate the modules. - * - * @returns The number of modules. - * - * @param hDbgAs The address space handle. - * - * @remarks Will not take any locks. - */ + RTDECL(uint32_t) RTDbgAsModuleCount(RTDBGAS hDbgAs) { PRTDBGASINT pDbgAs = hDbgAs; @@ -649,21 +552,6 @@ int rtDbgAsModuleLinkCommon(PRTDBGASINT pDbgAs, RTDBGMOD hDbgMod, RTDBGSEGIDX iS } -/** - * Links a module into the address space at the give address. - * - * The size of the mapping is determined using RTDbgModImageSize(). - * - * @returns IPRT status code. - * @retval VERR_OUT_OF_RANGE if the specified address will put the module - * outside the address space. - * @retval VERR_ADDRESS_CONFLICT if the mapping clashes with existing mappings. - * - * @param hDbgAs The address space handle. - * @param hDbgMod The module handle of the module to be linked in. - * @param ImageAddr The address to link the module at. - * @param fFlags See RTDBGASLINK_FLAGS_*. - */ RTDECL(int) RTDbgAsModuleLink(RTDBGAS hDbgAs, RTDBGMOD hDbgMod, RTUINTPTR ImageAddr, uint32_t fFlags) { /* @@ -696,23 +584,6 @@ RTDECL(int) RTDbgAsModuleLink(RTDBGAS hDbgAs, RTDBGMOD hDbgMod, RTUINTPTR ImageA RT_EXPORT_SYMBOL(RTDbgAsModuleLink); -/** - * Links a segment into the address space at the give address. - * - * The size of the mapping is determined using RTDbgModSegmentSize(). - * - * @returns IPRT status code. - * @retval VERR_OUT_OF_RANGE if the specified address will put the module - * outside the address space. - * @retval VERR_ADDRESS_CONFLICT if the mapping clashes with existing mappings. - * - * @param hDbgAs The address space handle. - * @param hDbgMod The module handle. - * @param iSeg The segment number (0-based) of the segment to be - * linked in. - * @param SegAddr The address to link the segment at. - * @param fFlags See RTDBGASLINK_FLAGS_*. - */ RTDECL(int) RTDbgAsModuleLinkSeg(RTDBGAS hDbgAs, RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR SegAddr, uint32_t fFlags) { /* @@ -873,15 +744,6 @@ static void rtDbgAsModuleUnlinkByMap(PRTDBGASINT pDbgAs, PRTDBGASMAP pMap) } -/** - * Unlinks all the mappings of a module from the address space. - * - * @returns IPRT status code. - * @retval VERR_NOT_FOUND if the module wasn't found. - * - * @param hDbgAs The address space handle. - * @param hDbgMod The module handle of the module to be unlinked. - */ RTDECL(int) RTDbgAsModuleUnlink(RTDBGAS hDbgAs, RTDBGMOD hDbgMod) { /* @@ -913,15 +775,6 @@ RTDECL(int) RTDbgAsModuleUnlink(RTDBGAS hDbgAs, RTDBGMOD hDbgMod) RT_EXPORT_SYMBOL(RTDbgAsModuleUnlink); -/** - * Unlinks the mapping at the specified address. - * - * @returns IPRT status code. - * @retval VERR_NOT_FOUND if no module or segment is mapped at that address. - * - * @param hDbgAs The address space handle. - * @param Addr The address within the mapping to be unlinked. - */ RTDECL(int) RTDbgAsModuleUnlinkByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr) { /* @@ -949,20 +802,6 @@ RTDECL(int) RTDbgAsModuleUnlinkByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr) RT_EXPORT_SYMBOL(RTDbgAsModuleUnlinkByAddr); -/** - * Get a the handle of a module in the address space by is index. - * - * @returns A retained handle to the specified module. The caller must release - * the returned reference. - * NIL_RTDBGMOD if invalid index or handle. - * - * @param hDbgAs The address space handle. - * @param iModule The index of the module to get. - * - * @remarks The module indexes may change after calls to RTDbgAsModuleLink, - * RTDbgAsModuleLinkSeg, RTDbgAsModuleUnlink and - * RTDbgAsModuleUnlinkByAddr. - */ RTDECL(RTDBGMOD) RTDbgAsModuleByIndex(RTDBGAS hDbgAs, uint32_t iModule) { /* @@ -990,22 +829,6 @@ RTDECL(RTDBGMOD) RTDbgAsModuleByIndex(RTDBGAS hDbgAs, uint32_t iModule) RT_EXPORT_SYMBOL(RTDbgAsModuleByIndex); -/** - * Queries mapping module information by handle. - * - * @returns IPRT status code. - * @retval VERR_NOT_FOUND if no mapping was found at the specified address. - * - * @param hDbgAs The address space handle. - * @param Addr Address within the mapping of the module or segment. - * @param phMod Where to the return the retained module handle. - * Optional. - * @param pAddr Where to return the base address of the mapping. - * Optional. - * @param piSeg Where to return the segment index. This is set to - * NIL if the entire module is mapped as a single - * mapping. Optional. - */ RTDECL(int) RTDbgAsModuleByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTDBGMOD phMod, PRTUINTPTR pAddr, PRTDBGSEGIDX piSeg) { /* @@ -1042,20 +865,6 @@ RTDECL(int) RTDbgAsModuleByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTDBGMOD phMod, RT_EXPORT_SYMBOL(RTDbgAsModuleByAddr); -/** - * Queries mapping module information by name. - * - * @returns IPRT status code. - * @retval VERR_NOT_FOUND if no mapping was found at the specified address. - * @retval VERR_OUT_OF_RANGE if the name index was out of range. - * - * @param hDbgAs The address space handle. - * @param pszName The module name. - * @param iName There can be more than one module by the same name - * in an address space. This argument indicates which - * is meant. (0 based) - * @param phMod Where to the return the retained module handle. - */ RTDECL(int) RTDbgAsModuleByName(RTDBGAS hDbgAs, const char *pszName, uint32_t iName, PRTDBGMOD phMod) { /* @@ -1097,26 +906,6 @@ RTDECL(int) RTDbgAsModuleByName(RTDBGAS hDbgAs, const char *pszName, uint32_t iN RT_EXPORT_SYMBOL(RTDbgAsModuleByName); -/** - * Queries mapping information for a module given by index. - * - * @returns IRPT status code. - * @retval VERR_INVALID_HANDLE if hDbgAs is invalid. - * @retval VERR_OUT_OF_RANGE if the name index was out of range. - * @retval VINF_BUFFER_OVERFLOW if the array is too small and the returned - * information is incomplete. - * - * @param hDbgAs The address space handle. - * @param iModule The index of the module to get. - * @param paMappings Where to return the mapping information. The buffer - * size is given by *pcMappings. - * @param pcMappings IN: Size of the paMappings array. OUT: The number of - * entries returned. - * @param fFlags Flags for reserved for future use. MBZ. - * - * @remarks See remarks for RTDbgAsModuleByIndex regarding the volatility of the - * iModule parameter. - */ RTDECL(int) RTDbgAsModuleQueryMapByIndex(RTDBGAS hDbgAs, uint32_t iModule, PRTDBGASMAPINFO paMappings, uint32_t *pcMappings, uint32_t fFlags) { /* @@ -1272,24 +1061,6 @@ DECLINLINE(void) rtDbgAsAdjustLineAddress(PRTDBGLINE pLine, RTDBGMOD hDbgMod, RT } -/** - * Adds a symbol to a module in the address space. - * - * @returns IPRT status code. See RTDbgModSymbolAdd for more specific ones. - * @retval VERR_INVALID_HANDLE if hDbgAs is invalid. - * @retval VERR_NOT_FOUND if no module was found at the specified address. - * @retval VERR_NOT_SUPPORTED if the module interpret doesn't support adding - * custom symbols. - * - * @param hDbgAs The address space handle. - * @param pszSymbol The symbol name. - * @param Addr The address of the symbol. - * @param cb The size of the symbol. - * @param fFlags Symbol flags, RTDBGSYMBOLADD_F_XXX. - * @param piOrdinal Where to return the symbol ordinal on success. If - * the interpreter doesn't do ordinals, this will be set to - * UINT32_MAX. Optional - */ RTDECL(int) RTDbgAsSymbolAdd(RTDBGAS hDbgAs, const char *pszSymbol, RTUINTPTR Addr, RTUINTPTR cb, uint32_t fFlags, uint32_t *piOrdinal) { /* @@ -1345,22 +1116,6 @@ static PRTDBGMOD rtDbgAsSnapshotModuleTable(PRTDBGASINT pDbgAs, uint32_t *pcModu } -/** - * Query a symbol by address. - * - * @returns IPRT status code. See RTDbgModSymbolAddr for more specific ones. - * @retval VERR_INVALID_HANDLE if hDbgAs is invalid. - * @retval VERR_NOT_FOUND if the address couldn't be mapped to a module. - * @retval VERR_INVALID_PARAMETER if incorrect flags. - * - * @param hDbgAs The address space handle. - * @param Addr The address which closest symbol is requested. - * @param fFlags Symbol search flags, see RTDBGSYMADDR_FLAGS_XXX. - * @param poffDisp Where to return the distance between the symbol and - * address. Optional. - * @param pSymbol Where to return the symbol info. - * @param phMod Where to return the module handle. Optional. - */ RTDECL(int) RTDbgAsSymbolByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr, uint32_t fFlags, PRTINTPTR poffDisp, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod) { @@ -1438,23 +1193,6 @@ RTDECL(int) RTDbgAsSymbolByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr, uint32_t fFlags, RT_EXPORT_SYMBOL(RTDbgAsSymbolByAddr); -/** - * Query a symbol by address. - * - * @returns IPRT status code. See RTDbgModSymbolAddrA for more specific ones. - * @retval VERR_INVALID_HANDLE if hDbgAs is invalid. - * @retval VERR_NOT_FOUND if the address couldn't be mapped to a module. - * @retval VERR_INVALID_PARAMETER if incorrect flags. - * - * @param hDbgAs The address space handle. - * @param Addr The address which closest symbol is requested. - * @param fFlags Symbol search flags, see RTDBGSYMADDR_FLAGS_XXX. - * @param poffDisp Where to return the distance between the symbol - * and address. Optional. - * @param ppSymInfo Where to return the pointer to the allocated symbol - * info. Always set. Free with RTDbgSymbolFree. - * @param phMod Where to return the module handle. Optional. - */ RTDECL(int) RTDbgAsSymbolByAddrA(RTDBGAS hDbgAs, RTUINTPTR Addr, uint32_t fFlags, PRTINTPTR poffDisp, PRTDBGSYMBOL *ppSymInfo, PRTDBGMOD phMod) { @@ -1557,20 +1295,6 @@ static bool rtDbgAsFindMappingAndAdjustSymbolValue(PRTDBGASINT pDbgAs, RTDBGMOD } -/** - * Query a symbol by name. - * - * @returns IPRT status code. - * @retval VERR_SYMBOL_NOT_FOUND if not found. - * - * @param hDbgAs The address space handle. - * @param pszSymbol The symbol name. It is possible to limit the scope - * of the search by prefixing the symbol with a module - * name pattern followed by a bang (!) character. - * RTStrSimplePatternNMatch is used for the matching. - * @param pSymbol Where to return the symbol info. - * @param phMod Where to return the module handle. Optional. - */ RTDECL(int) RTDbgAsSymbolByName(RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod) { /* @@ -1633,18 +1357,6 @@ RTDECL(int) RTDbgAsSymbolByName(RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSYM RT_EXPORT_SYMBOL(RTDbgAsSymbolByName); -/** - * Query a symbol by name, allocating the returned symbol structure. - * - * @returns IPRT status code. - * @retval VERR_SYMBOL_NOT_FOUND if not found. - * - * @param hDbgAs The address space handle. - * @param pszSymbol The symbol name. See RTDbgAsSymbolByName for more. - * @param ppSymbol Where to return the pointer to the allocated - * symbol info. Always set. Free with RTDbgSymbolFree. - * @param phMod Where to return the module handle. Optional. - */ RTDECL(int) RTDbgAsSymbolByNameA(RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSYMBOL *ppSymbol, PRTDBGMOD phMod) { /* @@ -1708,23 +1420,6 @@ RTDECL(int) RTDbgAsSymbolByNameA(RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSY RT_EXPORT_SYMBOL(RTDbgAsSymbolByNameA); -/** - * Adds a line number to a module in the address space. - * - * @returns IPRT status code. See RTDbgModSymbolAdd for more specific ones. - * @retval VERR_INVALID_HANDLE if hDbgAs is invalid. - * @retval VERR_NOT_FOUND if no module was found at the specified address. - * @retval VERR_NOT_SUPPORTED if the module interpret doesn't support adding - * custom symbols. - * - * @param hDbgAs The address space handle. - * @param pszFile The file name. - * @param uLineNo The line number. - * @param Addr The address of the symbol. - * @param piOrdinal Where to return the line number ordinal on success. - * If the interpreter doesn't do ordinals, this will be - * set to UINT32_MAX. Optional. - */ RTDECL(int) RTDbgAsLineAdd(RTDBGAS hDbgAs, const char *pszFile, uint32_t uLineNo, RTUINTPTR Addr, uint32_t *piOrdinal) { /* diff --git a/src/VBox/Runtime/common/ldr/ldrEx.cpp b/src/VBox/Runtime/common/ldr/ldrEx.cpp index 71526488d05..bd083f3ae9a 100644 --- a/src/VBox/Runtime/common/ldr/ldrEx.cpp +++ b/src/VBox/Runtime/common/ldr/ldrEx.cpp @@ -226,20 +226,6 @@ RTDECL(size_t) RTLdrSize(RTLDRMOD hLdrMod) RT_EXPORT_SYMBOL(RTLdrSize); -/** - * Loads the image into a buffer provided by the user and applies fixups - * for the given base address. - * - * @returns iprt status code. - * @param hLdrMod The load module handle. - * @param pvBits Where to put the bits. - * Must be as large as RTLdrSize() suggests. - * @param BaseAddress The base address. - * @param pfnGetImport Callback function for resolving imports one by one. - * If this is NULL, imports will not be resolved. - * @param pvUser User argument for the callback. - * @remark Not supported for RTLdrLoad() images. - */ RTDECL(int) RTLdrGetBits(RTLDRMOD hLdrMod, void *pvBits, RTLDRADDR BaseAddress, PFNRTLDRIMPORT pfnGetImport, void *pvUser) { LogFlow(("RTLdrGetBits: hLdrMod=%RTldrm pvBits=%p BaseAddress=%RTptr pfnGetImport=%p pvUser=%p\n", @@ -264,20 +250,6 @@ RTDECL(int) RTLdrGetBits(RTLDRMOD hLdrMod, void *pvBits, RTLDRADDR BaseAddress, RT_EXPORT_SYMBOL(RTLdrGetBits); -/** - * Relocates bits after getting them. - * Useful for code which moves around a bit. - * - * @returns iprt status code. - * @param hLdrMod The loader module handle. - * @param pvBits Where the image bits are. - * Must have been passed to RTLdrGetBits(). - * @param NewBaseAddress The new base address. - * @param OldBaseAddress The old base address. - * @param pfnGetImport Callback function for resolving imports one by one. - * @param pvUser User argument for the callback. - * @remark Not supported for RTLdrLoad() images. - */ RTDECL(int) RTLdrRelocate(RTLDRMOD hLdrMod, void *pvBits, RTLDRADDR NewBaseAddress, RTLDRADDR OldBaseAddress, PFNRTLDRIMPORT pfnGetImport, void *pvUser) { @@ -380,19 +352,6 @@ RTDECL(int) RTLdrQueryForwarderInfo(RTLDRMOD hLdrMod, const void *pvBits, uint32 RT_EXPORT_SYMBOL(RTLdrQueryForwarderInfo); -/** - * Enumerates all symbols in a module. - * - * @returns iprt status code. - * @param hLdrMod The loader module handle. - * @param fFlags Flags indicating what to return and such. - * @param pvBits Optional pointer to the loaded image. - * Set this to NULL if no RTLdrGetBits() processed image bits are available. - * @param BaseAddress Image load address. - * @param pfnCallback Callback function. - * @param pvUser User argument for the callback. - * @remark Not supported for RTLdrLoad() images. - */ RTDECL(int) RTLdrEnumSymbols(RTLDRMOD hLdrMod, unsigned fFlags, const void *pvBits, RTLDRADDR BaseAddress, PFNRTLDRENUMSYMS pfnCallback, void *pvUser) { @@ -791,12 +750,6 @@ DECLHIDDEN(int) rtLdrReadAt(RTLDRMOD hLdrMod, void *pvBuf, uint32_t iDbgInfo, RT } -/** - * Translates a RTLDRARCH value to a string. - * - * @returns Name corresponding to @a enmArch - * @param enmArch The value to name. - */ RTDECL(const char *) RTLdrArchName(RTLDRARCH enmArch) { switch (enmArch) diff --git a/src/VBox/Runtime/common/ldr/ldrNative.cpp b/src/VBox/Runtime/common/ldr/ldrNative.cpp index 68a4b3b4d8e..373c47fc01d 100644 --- a/src/VBox/Runtime/common/ldr/ldrNative.cpp +++ b/src/VBox/Runtime/common/ldr/ldrNative.cpp @@ -101,22 +101,6 @@ static const RTLDROPS g_rtldrNativeOps = -/** - * Loads a dynamic load library (/shared object) image file using native - * OS facilities. - * - * The filename will be appended the default DLL/SO extension of - * the platform if it have been omitted. This means that it's not - * possible to load DLLs/SOs with no extension using this interface, - * but that's not a bad tradeoff. - * - * If no path is specified in the filename, the OS will usually search it's library - * path to find the image file. - * - * @returns iprt status code. - * @param pszFilename Image filename. - * @param phLdrMod Where to store the handle to the loaded module. - */ RTDECL(int) RTLdrLoad(const char *pszFilename, PRTLDRMOD phLdrMod) { return RTLdrLoadEx(pszFilename, phLdrMod, RTLDRLOAD_FLAGS_LOCAL, NULL); @@ -250,16 +234,6 @@ RTDECL(void *) RTLdrGetSystemSymbolEx(const char *pszFilename, const char *pszSy } -/** - * Loads a dynamic load library (/shared object) image file residing in the - * RTPathAppPrivateArch() directory. - * - * Suffix is not required. - * - * @returns iprt status code. - * @param pszFilename Image filename. No path. - * @param phLdrMod Where to store the handle to the loaded module. - */ RTDECL(int) RTLdrLoadAppPriv(const char *pszFilename, PRTLDRMOD phLdrMod) { LogFlow(("RTLdrLoadAppPriv: pszFilename=%p:{%s} phLdrMod=%p\n", pszFilename, pszFilename, phLdrMod)); @@ -316,11 +290,6 @@ RTDECL(int) RTLdrLoadAppPriv(const char *pszFilename, PRTLDRMOD phLdrMod) RT_EXPORT_SYMBOL(RTLdrLoadAppPriv); -/** - * Gets the default file suffix for DLL/SO/DYLIB/whatever. - * - * @returns The stuff (readonly). - */ RTDECL(const char *) RTLdrGetSuff(void) { #if defined(RT_OS_OS2) || defined(RT_OS_WINDOWS) diff --git a/src/VBox/Runtime/common/log/log.cpp b/src/VBox/Runtime/common/log/log.cpp index 3221646577d..03fec9f0e65 100644 --- a/src/VBox/Runtime/common/log/log.cpp +++ b/src/VBox/Runtime/common/log/log.cpp @@ -608,12 +608,6 @@ RTDECL(PRTLOGGER) RTLogGetDefaultInstanceEx(uint32_t fFlagsAndGroup) RT_EXPORT_SYMBOL(RTLogGetDefaultInstanceEx); -/** - * Sets the default logger instance. - * - * @returns iprt status code. - * @param pLogger The new default logger instance. - */ RTDECL(PRTLOGGER) RTLogSetDefaultInstance(PRTLOGGER pLogger) { #if defined(IN_RING3) && (defined(IN_RT_STATIC) || defined(IPRT_NO_CRT)) @@ -734,12 +728,6 @@ RTDECL(PRTLOGGER) RTLogRelGetDefaultInstanceEx(uint32_t fFlagsAndGroup) RT_EXPORT_SYMBOL(RTLogRelGetDefaultInstanceEx); -/** - * Sets the default logger instance. - * - * @returns iprt status code. - * @param pLogger The new default release logger instance. - */ RTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger) { #if defined(IN_RING3) && (defined(IN_RT_STATIC) || defined(IPRT_NO_CRT)) @@ -756,17 +744,6 @@ RTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger) RT_EXPORT_SYMBOL(RTLogRelSetDefaultInstance); -/** - * - * This is the 2nd half of what RTLogGetDefaultInstanceEx() and - * RTLogRelGetDefaultInstanceEx() does. - * - * @returns If the group has the specified flags enabled @a pLogger will be - * returned returned. Otherwise NULL is returned. - * @param pLogger The logger. NULL is NULL. - * @param fFlagsAndGroup The flags in the lower 16 bits, the group number in - * the high 16 bits. - */ RTDECL(PRTLOGGER) RTLogCheckGroupFlags(PRTLOGGER pLogger, uint32_t fFlagsAndGroup) { PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger; @@ -1554,14 +1531,6 @@ RTDECL(int) RTLogCreate(PRTLOGGER *ppLogger, uint64_t fFlags, const char *pszGro RT_EXPORT_SYMBOL(RTLogCreate); -/** - * Destroys a logger instance. - * - * The instance is flushed and all output destinations closed (where applicable). - * - * @returns iprt status code. - * @param pLogger The logger instance which close destroyed. NULL is fine. - */ RTDECL(int) RTLogDestroy(PRTLOGGER pLogger) { int rc; @@ -1642,14 +1611,6 @@ RTDECL(int) RTLogDestroy(PRTLOGGER pLogger) RT_EXPORT_SYMBOL(RTLogDestroy); -/** - * Sets the custom prefix callback. - * - * @returns IPRT status code. - * @param pLogger The logger instance. - * @param pfnCallback The callback. - * @param pvUser The user argument for the callback. - * */ RTDECL(int) RTLogSetCustomPrefixCallback(PRTLOGGER pLogger, PFNRTLOGPREFIX pfnCallback, void *pvUser) { int rc; @@ -1672,17 +1633,6 @@ RTDECL(int) RTLogSetCustomPrefixCallback(PRTLOGGER pLogger, PFNRTLOGPREFIX pfnCa RT_EXPORT_SYMBOL(RTLogSetCustomPrefixCallback); -/** - * Sets the custom flush callback. - * - * This can be handy for special loggers like the per-EMT ones in ring-0, - * but also for implementing a log viewer in the debugger GUI. - * - * @returns IPRT status code. - * @retval VWRN_ALREADY_EXISTS if it was set to a different flusher. - * @param pLogger The logger instance. - * @param pfnFlush The flush callback. - */ RTDECL(int) RTLogSetFlushCallback(PRTLOGGER pLogger, PFNRTLOGFLUSH pfnFlush) { int rc; @@ -1782,15 +1732,6 @@ static bool rtlogIsGroupMatching(const char *pszGrp, const char **ppachMask, siz } -/** - * Updates the group settings for the logger instance using the specified - * specification string. - * - * @returns iprt status code. - * Failures can safely be ignored. - * @param pLogger Logger instance. - * @param pszValue Value to parse. - */ RTDECL(int) RTLogGroupSettings(PRTLOGGER pLogger, const char *pszValue) { PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger; @@ -2031,15 +1972,6 @@ static int rtLogGetGroupSettingsAddOne(const char *pszName, uint32_t fGroup, cha } -/** - * Get the current log group settings as a string. - * - * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW. - * @param pLogger Logger instance (NULL for default logger). - * @param pszBuf The output buffer. - * @param cchBuf The size of the output buffer. Must be greater - * than zero. - */ RTDECL(int) RTLogQueryGroupSettings(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf) { bool fNotFirst = false; @@ -2090,15 +2022,6 @@ RTDECL(int) RTLogQueryGroupSettings(PRTLOGGER pLogger, char *pszBuf, size_t cchB RT_EXPORT_SYMBOL(RTLogQueryGroupSettings); -/** - * Updates the flags for the logger instance using the specified - * specification string. - * - * @returns iprt status code. - * Failures can safely be ignored. - * @param pLogger Logger instance (NULL for default logger). - * @param pszValue Value to parse. - */ RTDECL(int) RTLogFlags(PRTLOGGER pLogger, const char *pszValue) { int rc = VINF_SUCCESS; @@ -2177,16 +2100,6 @@ RTDECL(int) RTLogFlags(PRTLOGGER pLogger, const char *pszValue) RT_EXPORT_SYMBOL(RTLogFlags); -/** - * Changes the buffering setting of the specified logger. - * - * This can be used for optimizing longish logging sequences. - * - * @returns The old state. - * @param pLogger The logger instance (NULL is an alias for the - * default logger). - * @param fBuffered The new state. - */ RTDECL(bool) RTLogSetBuffering(PRTLOGGER pLogger, bool fBuffered) { int rc; @@ -2274,12 +2187,6 @@ RT_EXPORT_SYMBOL(RTLogSetR0ProgramStart); #endif /* IN_RING0 */ -/** - * Gets the current flag settings for the given logger. - * - * @returns Logger flags, UINT64_MAX if no logger. - * @param pLogger Logger instance (NULL for default logger). - */ RTDECL(uint64_t) RTLogGetFlags(PRTLOGGER pLogger) { PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger; @@ -2290,16 +2197,6 @@ RTDECL(uint64_t) RTLogGetFlags(PRTLOGGER pLogger) RT_EXPORT_SYMBOL(RTLogGetFlags); -/** - * Modifies the flag settings for the given logger. - * - * @returns IPRT status code. Returns VINF_SUCCESS if VINF_LOG_NO_LOGGER and @a - * pLogger is NULL. - * @param pLogger Logger instance (NULL for default logger). - * @param fSet Mask of flags to set (OR). - * @param fClear Mask of flags to clear (NAND). This is allowed to - * include invalid flags - e.g. UINT64_MAX is okay. - */ RTDECL(int) RTLogChangeFlags(PRTLOGGER pLogger, uint64_t fSet, uint64_t fClear) { int rc; @@ -2322,15 +2219,6 @@ RTDECL(int) RTLogChangeFlags(PRTLOGGER pLogger, uint64_t fSet, uint64_t fClear) RT_EXPORT_SYMBOL(RTLogChangeFlags); -/** - * Get the current log flags as a string. - * - * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW. - * @param pLogger Logger instance (NULL for default logger). - * @param pszBuf The output buffer. - * @param cchBuf The size of the output buffer. Must be greater - * than zero. - */ RTDECL(int) RTLogQueryFlags(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf) { bool fNotFirst = false; @@ -2418,13 +2306,6 @@ static size_t rtLogDestFindValueLength(const char *pszValue) } -/** - * Updates the logger destination using the specified string. - * - * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW. - * @param pLogger Logger instance (NULL for default logger). - * @param pszValue The value to parse. - */ RTDECL(int) RTLogDestinations(PRTLOGGER pLogger, char const *pszValue) { PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger; @@ -2615,13 +2496,6 @@ RTDECL(int) RTLogDestinations(PRTLOGGER pLogger, char const *pszValue) RT_EXPORT_SYMBOL(RTLogDestinations); -/** - * Clear the file delay flag if set, opening the destination and flushing. - * - * @returns IPRT status code. - * @param pLogger Logger instance (NULL for default logger). - * @param pErrInfo Where to return extended error info. Optional. - */ RTDECL(int) RTLogClearFileDelayFlag(PRTLOGGER pLogger, PRTERRINFO pErrInfo) { PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger; @@ -2654,18 +2528,6 @@ RTDECL(int) RTLogClearFileDelayFlag(PRTLOGGER pLogger, PRTERRINFO pErrInfo) RT_EXPORT_SYMBOL(RTLogClearFileDelayFlag); -/** - * Modifies the log destinations settings for the given logger. - * - * This is only suitable for simple destination settings that doesn't take - * additional arguments, like RTLOGDEST_FILE. - * - * @returns IPRT status code. Returns VINF_LOG_NO_LOGGER if VINF_LOG_NO_LOGGER - * and @a pLogger is NULL. - * @param pLogger Logger instance (NULL for default logger). - * @param fSet Mask of destinations to set (OR). - * @param fClear Mask of destinations to clear (NAND). - */ RTDECL(int) RTLogChangeDestinations(PRTLOGGER pLogger, uint32_t fSet, uint32_t fClear) { int rc; @@ -2691,12 +2553,6 @@ RTDECL(int) RTLogChangeDestinations(PRTLOGGER pLogger, uint32_t fSet, uint32_t f RT_EXPORT_SYMBOL(RTLogChangeDestinations); -/** - * Gets the current destinations flags for the given logger. - * - * @returns Logger destination flags, UINT32_MAX if no logger. - * @param pLogger Logger instance (NULL for default logger). - */ RTDECL(uint32_t) RTLogGetDestinations(PRTLOGGER pLogger) { PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger; @@ -2711,15 +2567,6 @@ RTDECL(uint32_t) RTLogGetDestinations(PRTLOGGER pLogger) RT_EXPORT_SYMBOL(RTLogGetDestinations); -/** - * Get the current log destinations as a string. - * - * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW. - * @param pLogger Logger instance (NULL for default logger). - * @param pszBuf The output buffer. - * @param cchBuf The size of the output buffer. Must be greater - * than 0. - */ RTDECL(int) RTLogQueryDestinations(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf) { PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger; @@ -3068,20 +2915,6 @@ static int rtR3LogOpenFileDestination(PRTLOGGERINTERNAL pLoggerInt, PRTERRINFO p * Bulk Reconfig & Logging for ring-0 EMT loggers. * *********************************************************************************************************************************/ -/** - * Performs a bulk update of logger flags and group flags. - * - * This is for instanced used for copying settings from ring-3 to ring-0 - * loggers. - * - * @returns IPRT status code. - * @param pLogger The logger instance (NULL for default logger). - * @param fFlags The new logger flags. - * @param uGroupCrc32 The CRC32 of the group name strings. - * @param cGroups Number of groups. - * @param pafGroups Array of group flags. - * @sa RTLogQueryBulk - */ RTDECL(int) RTLogBulkUpdate(PRTLOGGER pLogger, uint64_t fFlags, uint32_t uGroupCrc32, uint32_t cGroups, uint32_t const *pafGroups) { int rc; @@ -3111,23 +2944,6 @@ RTDECL(int) RTLogBulkUpdate(PRTLOGGER pLogger, uint64_t fFlags, uint32_t uGroupC RT_EXPORT_SYMBOL(RTLogBulkUpdate); -/** - * Queries data for a bulk update of logger flags and group flags. - * - * This is for instanced used for copying settings from ring-3 to ring-0 - * loggers. - * - * @returns IPRT status code. - * @retval VERR_BUFFER_OVERFLOW if pafGroups is too small, @a pcGroups will be - * set to the actual number of groups. - * @param pLogger The logger instance (NULL for default logger). - * @param pfFlags Where to return the logger flags. - * @param puGroupCrc32 Where to return the CRC32 of the group names. - * @param pcGroups Input: Size of the @a pafGroups allocation. - * Output: Actual number of groups returned. - * @param pafGroups Where to return the flags for each group. - * @sa RTLogBulkUpdate - */ RTDECL(int) RTLogQueryBulk(PRTLOGGER pLogger, uint64_t *pfFlags, uint32_t *puGroupCrc32, uint32_t *pcGroups, uint32_t *pafGroups) { PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger; @@ -3155,20 +2971,6 @@ RTDECL(int) RTLogQueryBulk(PRTLOGGER pLogger, uint64_t *pfFlags, uint32_t *puGro RT_EXPORT_SYMBOL(RTLogQueryBulk); -/** - * Write/copy bulk log data from another logger. - * - * This is used for transferring stuff from the ring-0 loggers and into the - * ring-3 one. The text goes in as-is w/o any processing (i.e. prefixing or - * newline fun). - * - * @returns IRPT status code. - * @param pLogger The logger instance (NULL for default logger). - * @param pszBefore Text to log before the bulk text. Optional. - * @param pch Pointer to the block of bulk log text to write. - * @param cch Size of the block of bulk log text to write. - * @param pszAfter Text to log after the bulk text. Optional. - */ RTDECL(int) RTLogBulkWrite(PRTLOGGER pLogger, const char *pszBefore, const char *pch, size_t cch, const char *pszAfter) { PRTLOGGERINTERNAL pLoggerInt = (PRTLOGGERINTERNAL)pLogger; @@ -3241,18 +3043,6 @@ RTDECL(int) RTLogBulkWrite(PRTLOGGER pLogger, const char *pszBefore, const char RT_EXPORT_SYMBOL(RTLogBulkWrite); -/** - * Write/copy bulk log data from a nested VM logger. - * - * This is used for - * - * @returns IRPT status code. - * @param pLogger The logger instance (NULL for default logger). - * @param pch Pointer to the block of bulk log text to write. - * @param cch Size of the block of bulk log text to write. - * @param pszInfix String to put after the line prefixes and the - * line content. - */ RTDECL(int) RTLogBulkNestedWrite(PRTLOGGER pLogger, const char *pch, size_t cch, const char *pszInfix) { if (cch > 0) @@ -3317,13 +3107,6 @@ RT_EXPORT_SYMBOL(RTLogBulkNestedWrite); * Flushing * *********************************************************************************************************************************/ -/** - * Flushes the specified logger. - * - * @param pLogger The logger instance to flush. - * If NULL the default instance is used. The default instance - * will not be initialized by this call. - */ RTDECL(int) RTLogFlush(PRTLOGGER pLogger) { if (!pLogger) @@ -4355,22 +4138,6 @@ static void rtlogLoggerExFLocked(PRTLOGGERINTERNAL pLoggerInt, unsigned fFlags, } -/** - * Write to a logger instance. - * - * This function will check whether the instance, group and flags makes up a - * logging kind which is currently enabled before writing anything to the log. - * - * @returns VINF_SUCCESS, VINF_LOG_NO_LOGGER, VINF_LOG_DISABLED, or IPRT error - * status. - * @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted. - * @param fFlags The logging flags. - * @param iGroup The group. - * The value ~0U is reserved for compatibility with RTLogLogger[V] and is - * only for internal usage! - * @param pszFormat Format string. - * @param args Format arguments. - */ RTDECL(int) RTLogLoggerExV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args) { int rc; @@ -4444,13 +4211,6 @@ RTDECL(int) RTLogLoggerExV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, RT_EXPORT_SYMBOL(RTLogLoggerExV); -/** - * Write to a logger instance. - * - * @param pLogger Pointer to logger instance. - * @param pszFormat Format string. - * @param args Format arguments. - */ RTDECL(void) RTLogLoggerV(PRTLOGGER pLogger, const char *pszFormat, va_list args) { RTLogLoggerExV(pLogger, 0, ~0U, pszFormat, args); @@ -4458,14 +4218,6 @@ RTDECL(void) RTLogLoggerV(PRTLOGGER pLogger, const char *pszFormat, va_list args RT_EXPORT_SYMBOL(RTLogLoggerV); -/** - * vprintf like function for writing to the default log. - * - * @param pszFormat Printf like format string. - * @param va Optional arguments as specified in pszFormat. - * - * @remark The API doesn't support formatting of floating point numbers at the moment. - */ RTDECL(void) RTLogPrintfV(const char *pszFormat, va_list va) { RTLogLoggerV(NULL, pszFormat, va); @@ -4473,14 +4225,6 @@ RTDECL(void) RTLogPrintfV(const char *pszFormat, va_list va) RT_EXPORT_SYMBOL(RTLogPrintfV); -/** - * Dumper vprintf-like function outputting to a logger. - * - * @param pvUser Pointer to the logger instance to use, NULL for - * default instance. - * @param pszFormat Format string. - * @param va Format arguments. - */ RTDECL(void) RTLogDumpPrintfV(void *pvUser, const char *pszFormat, va_list va) { RTLogLoggerV((PRTLOGGER)pvUser, pszFormat, va); diff --git a/src/VBox/Runtime/common/misc/inifile.cpp b/src/VBox/Runtime/common/misc/inifile.cpp index d4357966b59..ab50697ec9c 100644 --- a/src/VBox/Runtime/common/misc/inifile.cpp +++ b/src/VBox/Runtime/common/misc/inifile.cpp @@ -314,15 +314,6 @@ static int rtIniFileLoad(PRTINIFILEINT pThis) } -/** - * Creates a INI-file instance from a VFS file handle. - * - * @returns IPRT status code - * @param phIniFile Where to return the INI-file handle. - * @param hVfsFile The VFS file handle (not consumed, additional - * reference is retained). - * @param fFlags Flags, RTINIFILE_F_XXX. - */ RTDECL(int) RTIniFileCreateFromVfsFile(PRTINIFILE phIniFile, RTVFSFILE hVfsFile, uint32_t fFlags) { /* @@ -360,12 +351,6 @@ RTDECL(int) RTIniFileCreateFromVfsFile(PRTINIFILE phIniFile, RTVFSFILE hVfsFile, } -/** - * Retains a reference to an INI-file instance. - * - * @returns New reference count, UINT32_MAX on failure. - * @param hIniFile The INI-file handle. - */ RTDECL(uint32_t) RTIniFileRetain(RTINIFILE hIniFile) { PRTINIFILEINT pThis = hIniFile; @@ -379,13 +364,6 @@ RTDECL(uint32_t) RTIniFileRetain(RTINIFILE hIniFile) } -/** - * Releases a reference to an INI-file instance, destroying it if the count - * reaches zero. - * - * @returns New reference count, UINT32_MAX on failure. - * @param hIniFile The INI-file handle. NIL is ignored. - */ RTDECL(uint32_t) RTIniFileRelease(RTINIFILE hIniFile) { if (hIniFile == NIL_RTINIFILE) @@ -525,26 +503,6 @@ static int rtIniFileQueryValueInSection(PRTINIFILEINT pThis, PRTINIFILESECTION p } -/** - * Queries a value in a section. - * - * The first matching value is returned. The matching is by default case - * insensitive. - * - * @returns IPRT status code. - * @retval VERR_NOT_FOUND if section or key not found. - * - * @param hIniFile The INI-file handle. - * @param pszSection The section name. Pass NULL to refer to the - * unsectioned key space at the top of the file. - * @param pszKey The key name. - * @param pszValue Where to return the value. - * @param cbValue Size of the buffer @a pszValue points to. - * @param pcbActual Where to return the actual value size excluding - * terminator on success. On VERR_BUFFER_OVERFLOW this - * will be set to the buffer size needed to hold the - * value, terminator included. Optional. - */ RTDECL(int) RTIniFileQueryValue(RTINIFILE hIniFile, const char *pszSection, const char *pszKey, char *pszValue, size_t cbValue, size_t *pcbActual) { @@ -731,32 +689,6 @@ static int rtIniFileQueryPairInSection(PRTINIFILEINT pThis, PRTINIFILESECTION pS } -/** - * Queries a key-value pair in a section by ordinal. - * - * @returns IPRT status code. - * @retval VERR_NOT_FOUND if the section wasn't found or if it contains no pair - * with the given ordinal value. - * - * @param hIniFile The INI-file handle. - * @param pszSection The section name. Pass NULL to refer to the - * unsectioned key space at the top of the file. - * @param idxPair The pair to fetch (counting from 0). - * - * @param pszKey Where to return the key name. - * @param cbKey Size of the buffer @a pszKey points to. - * @param pcbKeyActual Where to return the actual key size excluding - * terminator on success. On VERR_BUFFER_OVERFLOW this - * will be set to the buffer size needed to hold the - * value, terminator included. Optional. - * - * @param pszValue Where to return the value. - * @param cbValue Size of the buffer @a pszValue points to. - * @param pcbValueActual Where to return the actual value size excluding - * terminator on success. On VERR_BUFFER_OVERFLOW this - * will be set to the buffer size needed to hold the - * value, terminator included. Optional. - */ RTDECL(int) RTIniFileQueryPair(RTINIFILE hIniFile, const char *pszSection, uint32_t idxPair, char *pszKey, size_t cbKey, size_t *pcbKeyActual, char *pszValue, size_t cbValue, size_t *pcbValueActual) diff --git a/src/VBox/Runtime/common/misc/semspingpong.cpp b/src/VBox/Runtime/common/misc/semspingpong.cpp index a2cd8fd75c8..18cf5b25e61 100644 --- a/src/VBox/Runtime/common/misc/semspingpong.cpp +++ b/src/VBox/Runtime/common/misc/semspingpong.cpp @@ -70,12 +70,6 @@ } while (0) -/** - * Init a Ping-Pong construct. - * - * @returns iprt status code. - * @param pPP Pointer to the ping-pong structure which needs initialization. - */ RTDECL(int) RTSemPingPongInit(PRTPINGPONG pPP) { /* @@ -97,13 +91,6 @@ RTDECL(int) RTSemPingPongInit(PRTPINGPONG pPP) RT_EXPORT_SYMBOL(RTSemPingPongInit); -/** - * Destroys a Ping-Pong construct. - * - * @returns iprt status code. - * @param pPP Pointer to the ping-pong structure which is to be destroyed. - * (I.e. put into uninitialized state.) - */ RTDECL(int) RTSemPingPongDelete(PRTPINGPONG pPP) { /* @@ -128,13 +115,6 @@ RTDECL(int) RTSemPingPongDelete(PRTPINGPONG pPP) RT_EXPORT_SYMBOL(RTSemPingPongDelete); -/** - * Signals the pong thread in a ping-pong construct. (I.e. sends ping.) - * This is called by the ping thread. - * - * @returns iprt status code. - * @param pPP Pointer to the ping-pong structure to ping. - */ RTDECL(int) RTSemPing(PRTPINGPONG pPP) { /* @@ -161,13 +141,6 @@ RTDECL(int) RTSemPing(PRTPINGPONG pPP) RT_EXPORT_SYMBOL(RTSemPing); -/** - * Signals the ping thread in a ping-pong construct. (I.e. sends pong.) - * This is called by the pong thread. - * - * @returns iprt status code. - * @param pPP Pointer to the ping-pong structure to pong. - */ RTDECL(int) RTSemPong(PRTPINGPONG pPP) { /* @@ -194,14 +167,6 @@ RTDECL(int) RTSemPong(PRTPINGPONG pPP) RT_EXPORT_SYMBOL(RTSemPong); -/** - * Wait function for the ping thread. - * - * @returns iprt status code. - * Will not return VERR_INTERRUPTED. - * @param pPP Pointer to the ping-pong structure to wait on. - * @param cMillies Number of milliseconds to wait. - */ RTDECL(int) RTSemPingWait(PRTPINGPONG pPP, RTMSINTERVAL cMillies) { /* @@ -227,14 +192,6 @@ RTDECL(int) RTSemPingWait(PRTPINGPONG pPP, RTMSINTERVAL cMillies) RT_EXPORT_SYMBOL(RTSemPingWait); -/** - * Wait function for the pong thread. - * - * @returns iprt status code. - * Will not return VERR_INTERRUPTED. - * @param pPP Pointer to the ping-pong structure to wait on. - * @param cMillies Number of milliseconds to wait. - */ RTDECL(int) RTSemPongWait(PRTPINGPONG pPP, RTMSINTERVAL cMillies) { /* diff --git a/src/VBox/Runtime/common/misc/thread.cpp b/src/VBox/Runtime/common/misc/thread.cpp index 9cdfb144493..d0eb28595da 100644 --- a/src/VBox/Runtime/common/misc/thread.cpp +++ b/src/VBox/Runtime/common/misc/thread.cpp @@ -299,15 +299,7 @@ static int rtThreadAdopt(RTTHREADTYPE enmType, unsigned fFlags, uint32_t fIntFla return rc; } -/** - * Adopts a non-IPRT thread. - * - * @returns IPRT status code. - * @param enmType The thread type. - * @param fFlags The thread flags. RTTHREADFLAGS_WAITABLE is not currently allowed. - * @param pszName The thread name. Optional. - * @param pThread Where to store the thread handle. Optional. - */ + RTDECL(int) RTThreadAdopt(RTTHREADTYPE enmType, unsigned fFlags, const char *pszName, PRTTHREAD pThread) { int rc; @@ -351,12 +343,6 @@ RTDECL(int) RTThreadAdopt(RTTHREADTYPE enmType, unsigned fFlags, const char *psz RT_EXPORT_SYMBOL(RTThreadAdopt); -/** - * Get the thread handle of the current thread, automatically adopting alien - * threads. - * - * @returns Thread handle. - */ RTDECL(RTTHREAD) RTThreadSelfAutoAdopt(void) { RTTHREAD hSelf = RTThreadSelf(); @@ -775,20 +761,6 @@ DECL_HIDDEN_CALLBACK(int) rtThreadMain(PRTTHREADINT pThread, RTNATIVETHREAD Nati } -/** - * Create a new thread. - * - * @returns iprt status code. - * @param pThread Where to store the thread handle to the new thread. (optional) - * @param pfnThread The thread function. - * @param pvUser User argument. - * @param cbStack The size of the stack for the new thread. - * Use 0 for the default stack size. - * @param enmType The thread type. Used for deciding scheduling attributes - * of the thread. - * @param fFlags Flags of the RTTHREADFLAGS type (ORed together). - * @param pszName Thread name. - */ RTDECL(int) RTThreadCreate(PRTTHREAD pThread, PFNRTTHREAD pfnThread, void *pvUser, size_t cbStack, RTTHREADTYPE enmType, unsigned fFlags, const char *pszName) { @@ -843,21 +815,6 @@ RTDECL(int) RTThreadCreate(PRTTHREAD pThread, PFNRTTHREAD pfnThread, void *pvUse RT_EXPORT_SYMBOL(RTThreadCreate); -/** - * Create a new thread. - * - * Same as RTThreadCreate except the name is given in the RTStrPrintfV form. - * - * @returns iprt status code. - * @param pThread See RTThreadCreate. - * @param pfnThread See RTThreadCreate. - * @param pvUser See RTThreadCreate. - * @param cbStack See RTThreadCreate. - * @param enmType See RTThreadCreate. - * @param fFlags See RTThreadCreate. - * @param pszNameFmt Thread name format. - * @param va Format arguments. - */ RTDECL(int) RTThreadCreateV(PRTTHREAD pThread, PFNRTTHREAD pfnThread, void *pvUser, size_t cbStack, RTTHREADTYPE enmType, uint32_t fFlags, const char *pszNameFmt, va_list va) { @@ -868,21 +825,6 @@ RTDECL(int) RTThreadCreateV(PRTTHREAD pThread, PFNRTTHREAD pfnThread, void *pvUs RT_EXPORT_SYMBOL(RTThreadCreateV); -/** - * Create a new thread. - * - * Same as RTThreadCreate except the name is given in the RTStrPrintf form. - * - * @returns iprt status code. - * @param pThread See RTThreadCreate. - * @param pfnThread See RTThreadCreate. - * @param pvUser See RTThreadCreate. - * @param cbStack See RTThreadCreate. - * @param enmType See RTThreadCreate. - * @param fFlags See RTThreadCreate. - * @param pszNameFmt Thread name format. - * @param ... Format arguments. - */ RTDECL(int) RTThreadCreateF(PRTTHREAD pThread, PFNRTTHREAD pfnThread, void *pvUser, size_t cbStack, RTTHREADTYPE enmType, uint32_t fFlags, const char *pszNameFmt, ...) { @@ -896,12 +838,6 @@ RTDECL(int) RTThreadCreateF(PRTTHREAD pThread, PFNRTTHREAD pfnThread, void *pvUs RT_EXPORT_SYMBOL(RTThreadCreateF); -/** - * Gets the native thread id of a IPRT thread. - * - * @returns The native thread id. - * @param Thread The IPRT thread. - */ RTDECL(RTNATIVETHREAD) RTThreadGetNative(RTTHREAD Thread) { PRTTHREADINT pThread = rtThreadGet(Thread); @@ -916,13 +852,6 @@ RTDECL(RTNATIVETHREAD) RTThreadGetNative(RTTHREAD Thread) RT_EXPORT_SYMBOL(RTThreadGetNative); -/** - * Gets the IPRT thread of a native thread. - * - * @returns The IPRT thread handle - * @returns NIL_RTTHREAD if not a thread known to IPRT. - * @param NativeThread The native thread handle/id. - */ RTDECL(RTTHREAD) RTThreadFromNative(RTNATIVETHREAD NativeThread) { PRTTHREADINT pThread = rtThreadGetByNative(NativeThread); @@ -933,12 +862,6 @@ RTDECL(RTTHREAD) RTThreadFromNative(RTNATIVETHREAD NativeThread) RT_EXPORT_SYMBOL(RTThreadFromNative); -/** - * Gets the name of the current thread thread. - * - * @returns Pointer to readonly name string. - * @returns NULL on failure. - */ RTDECL(const char *) RTThreadSelfName(void) { RTTHREAD Thread = RTThreadSelf(); @@ -957,13 +880,6 @@ RTDECL(const char *) RTThreadSelfName(void) RT_EXPORT_SYMBOL(RTThreadSelfName); -/** - * Gets the name of a thread. - * - * @returns Pointer to readonly name string. - * @returns NULL on failure. - * @param Thread Thread handle of the thread to query the name of. - */ RTDECL(const char *) RTThreadGetName(RTTHREAD Thread) { PRTTHREADINT pThread; @@ -981,13 +897,6 @@ RTDECL(const char *) RTThreadGetName(RTTHREAD Thread) RT_EXPORT_SYMBOL(RTThreadGetName); -/** - * Sets the name of a thread. - * - * @returns iprt status code. - * @param Thread Thread handle of the thread to query the name of. - * @param pszName The thread name. - */ RTDECL(int) RTThreadSetName(RTTHREAD Thread, const char *pszName) { /* @@ -1015,18 +924,6 @@ RTDECL(int) RTThreadSetName(RTTHREAD Thread, const char *pszName) RT_EXPORT_SYMBOL(RTThreadSetName); -/** - * Checks if the specified thread is the main thread. - * - * @returns true if it is, false if it isn't. - * - * @param hThread The thread handle. - * - * @remarks This function may not return the correct value when rtR3Init was - * called on a thread of the than the main one. This could for - * instance happen when the DLL/DYLIB/SO containing IPRT is dynamically - * loaded at run time by a different thread. - */ RTDECL(bool) RTThreadIsMain(RTTHREAD hThread) { if (hThread != NIL_RTTHREAD) @@ -1085,11 +982,6 @@ RTDECL(bool) RTThreadIsInitialized(void) RT_EXPORT_SYMBOL(RTThreadIsInitialized); -/** - * Signal the user event. - * - * @returns iprt status code. - */ RTDECL(int) RTThreadUserSignal(RTTHREAD Thread) { int rc; @@ -1106,14 +998,6 @@ RTDECL(int) RTThreadUserSignal(RTTHREAD Thread) RT_EXPORT_SYMBOL(RTThreadUserSignal); -/** - * Wait for the user event, resume on interruption. - * - * @returns iprt status code. - * @param Thread The thread to wait for. - * @param cMillies The number of milliseconds to wait. Use RT_INDEFINITE_WAIT for - * an indefinite wait. - */ RTDECL(int) RTThreadUserWait(RTTHREAD Thread, RTMSINTERVAL cMillies) { int rc; @@ -1130,14 +1014,6 @@ RTDECL(int) RTThreadUserWait(RTTHREAD Thread, RTMSINTERVAL cMillies) RT_EXPORT_SYMBOL(RTThreadUserWait); -/** - * Wait for the user event, return on interruption. - * - * @returns iprt status code. - * @param Thread The thread to wait for. - * @param cMillies The number of milliseconds to wait. Use RT_INDEFINITE_WAIT for - * an indefinite wait. - */ RTDECL(int) RTThreadUserWaitNoResume(RTTHREAD Thread, RTMSINTERVAL cMillies) { int rc; @@ -1154,12 +1030,6 @@ RTDECL(int) RTThreadUserWaitNoResume(RTTHREAD Thread, RTMSINTERVAL cMillies) RT_EXPORT_SYMBOL(RTThreadUserWaitNoResume); -/** - * Reset the user event. - * - * @returns iprt status code. - * @param Thread The thread to reset. - */ RTDECL(int) RTThreadUserReset(RTTHREAD Thread) { int rc; @@ -1251,16 +1121,6 @@ static int rtThreadWait(RTTHREAD Thread, RTMSINTERVAL cMillies, int *prc, bool f } -/** - * Wait for the thread to terminate, resume on interruption. - * - * @returns iprt status code. - * Will not return VERR_INTERRUPTED. - * @param Thread The thread to wait for. - * @param cMillies The number of milliseconds to wait. Use RT_INDEFINITE_WAIT for - * an indefinite wait. - * @param prc Where to store the return code of the thread. Optional. - */ RTDECL(int) RTThreadWait(RTTHREAD Thread, RTMSINTERVAL cMillies, int *prc) { int rc = rtThreadWait(Thread, cMillies, prc, true); @@ -1270,15 +1130,6 @@ RTDECL(int) RTThreadWait(RTTHREAD Thread, RTMSINTERVAL cMillies, int *prc) RT_EXPORT_SYMBOL(RTThreadWait); -/** - * Wait for the thread to terminate, return on interruption. - * - * @returns iprt status code. - * @param Thread The thread to wait for. - * @param cMillies The number of milliseconds to wait. Use RT_INDEFINITE_WAIT for - * an indefinite wait. - * @param prc Where to store the return code of the thread. Optional. - */ RTDECL(int) RTThreadWaitNoResume(RTTHREAD Thread, RTMSINTERVAL cMillies, int *prc) { return rtThreadWait(Thread, cMillies, prc, false); @@ -1286,13 +1137,6 @@ RTDECL(int) RTThreadWaitNoResume(RTTHREAD Thread, RTMSINTERVAL cMillies, int *pr RT_EXPORT_SYMBOL(RTThreadWaitNoResume); -/** - * Changes the type of the specified thread. - * - * @returns iprt status code. - * @param Thread The thread which type should be changed. - * @param enmType The new thread type. - */ RTDECL(int) RTThreadSetType(RTTHREAD Thread, RTTHREADTYPE enmType) { /* @@ -1335,13 +1179,6 @@ RTDECL(int) RTThreadSetType(RTTHREAD Thread, RTTHREADTYPE enmType) RT_EXPORT_SYMBOL(RTThreadSetType); -/** - * Gets the type of the specified thread. - * - * @returns The thread type. - * @returns RTTHREADTYPE_INVALID if the thread handle is invalid. - * @param Thread The thread in question. - */ RTDECL(RTTHREADTYPE) RTThreadGetType(RTTHREAD Thread) { RTTHREADTYPE enmType = RTTHREADTYPE_INVALID; @@ -1442,13 +1279,6 @@ DECLHIDDEN(int) rtThreadDoSetProcPriority(RTPROCPRIORITY enmPriority) } -/** - * Change the thread state to blocking. - * - * @param hThread The current thread. - * @param enmState The sleep state. - * @param fReallySleeping Really going to sleep now. - */ RTDECL(void) RTThreadBlocking(RTTHREAD hThread, RTTHREADSTATE enmState, bool fReallySleeping) { Assert(RTTHREAD_IS_SLEEPING(enmState)); @@ -1464,15 +1294,6 @@ RTDECL(void) RTThreadBlocking(RTTHREAD hThread, RTTHREADSTATE enmState, bool fRe RT_EXPORT_SYMBOL(RTThreadBlocking); -/** - * Unblocks a thread. - * - * This function is paired with rtThreadBlocking. - * - * @param hThread The current thread. - * @param enmCurState The current state, used to check for nested blocking. - * The new state will be running. - */ RTDECL(void) RTThreadUnblocked(RTTHREAD hThread, RTTHREADSTATE enmCurState) { PRTTHREADINT pThread = hThread; @@ -1501,12 +1322,6 @@ RTDECL(void) RTThreadUnblocked(RTTHREAD hThread, RTTHREADSTATE enmCurState) RT_EXPORT_SYMBOL(RTThreadUnblocked); -/** - * Get the current thread state. - * - * @returns The thread state. - * @param hThread The thread. - */ RTDECL(RTTHREADSTATE) RTThreadGetState(RTTHREAD hThread) { RTTHREADSTATE enmState = RTTHREADSTATE_INVALID; diff --git a/src/VBox/Runtime/common/path/RTPathAbsDup.cpp b/src/VBox/Runtime/common/path/RTPathAbsDup.cpp index eb3dcbeea17..040cb329053 100644 --- a/src/VBox/Runtime/common/path/RTPathAbsDup.cpp +++ b/src/VBox/Runtime/common/path/RTPathAbsDup.cpp @@ -42,13 +42,6 @@ #include <iprt/path.h> -/** - * Same as RTPathAbs only the result is RTStrDup()'ed. - * - * @returns Pointer to real path. Use RTStrFree() to free this string. - * @returns NULL if RTPathAbs() or RTStrDup() fails. - * @param pszPath The path to resolve. - */ RTDECL(char *) RTPathAbsDup(const char *pszPath) { return RTPathAbsExDup(NULL, pszPath, RTPATH_STR_F_STYLE_HOST); diff --git a/src/VBox/Runtime/common/path/RTPathParentLength.cpp b/src/VBox/Runtime/common/path/RTPathParentLength.cpp index 43263da261b..82acadd9a54 100644 --- a/src/VBox/Runtime/common/path/RTPathParentLength.cpp +++ b/src/VBox/Runtime/common/path/RTPathParentLength.cpp @@ -84,18 +84,6 @@ RTDECL(size_t) RTPathParentLengthEx(const char *pszPath, uint32_t fFlags) } - - -/** - * Determins the length of the path specifying the parent directory, including - * trailing path separator (if present). - * - * @returns Parent directory part of the path, 0 if no parent. - * @param pszPath The path to examine. - * - * @note Currently ignores UNC and may therefore return the server or - * double-slash prefix as parent. - */ RTDECL(size_t) RTPathParentLength(const char *pszPath) { #if RTPATH_STYLE == RTPATH_STR_F_STYLE_DOS diff --git a/src/VBox/Runtime/common/path/RTPathParseSimple.cpp b/src/VBox/Runtime/common/path/RTPathParseSimple.cpp index 91627abf125..0dd35996669 100644 --- a/src/VBox/Runtime/common/path/RTPathParseSimple.cpp +++ b/src/VBox/Runtime/common/path/RTPathParseSimple.cpp @@ -45,24 +45,6 @@ #include <iprt/ctype.h> -/** - * Parses a path. - * - * It figures the length of the directory component, the offset of - * the file name and the location of the suffix dot. - * - * @returns The path length. - * - * @param pszPath Path to find filename in. - * @param pcchDir Where to put the length of the directory component. If - * no directory, this will be 0. Optional. - * @param poffName Where to store the filename offset. - * If empty string or if it's ending with a slash this - * will be set to -1. Optional. - * @param poffSuff Where to store the suffix offset (the last dot). - * If empty string or if it's ending with a slash this - * will be set to -1. Optional. - */ RTDECL(size_t) RTPathParseSimple(const char *pszPath, size_t *pcchDir, ssize_t *poffName, ssize_t *poffSuff) { /* diff --git a/src/VBox/Runtime/common/path/RTPathRealDup.cpp b/src/VBox/Runtime/common/path/RTPathRealDup.cpp index 0fd53d0f1a4..7f9ed6537a0 100644 --- a/src/VBox/Runtime/common/path/RTPathRealDup.cpp +++ b/src/VBox/Runtime/common/path/RTPathRealDup.cpp @@ -46,13 +46,6 @@ -/** - * Same as RTPathReal only the result is RTStrDup()'ed. - * - * @returns Pointer to real path. Use RTStrFree() to free this string. - * @returns NULL if RTPathReal() or RTStrDup() fails. - * @param pszPath - */ RTDECL(char *) RTPathRealDup(const char *pszPath) { char szPath[RTPATH_MAX]; diff --git a/src/VBox/Runtime/common/path/comparepaths.cpp b/src/VBox/Runtime/common/path/comparepaths.cpp index 04c038e94ca..96c0a48feac 100644 --- a/src/VBox/Runtime/common/path/comparepaths.cpp +++ b/src/VBox/Runtime/common/path/comparepaths.cpp @@ -113,54 +113,12 @@ static int rtPathCompare(const char *pszPath1, const char *pszPath2, bool fLimit } -/** - * Compares two paths. - * - * The comparison takes platform-dependent details into account, - * such as: - * <ul> - * <li>On DOS-like platforms, both separator chars (|\| and |/|) are considered - * to be equal. - * <li>On platforms with case-insensitive file systems, mismatching characters - * are uppercased and compared again. - * </ul> - * - * @returns @< 0 if the first path less than the second path. - * @returns 0 if the first path identical to the second path. - * @returns @> 0 if the first path greater than the second path. - * - * @param pszPath1 Path to compare (must be an absolute path). - * @param pszPath2 Path to compare (must be an absolute path). - * - * @remarks File system details are currently ignored. This means that you won't - * get case-insensitive compares on unix systems when a path goes into a - * case-insensitive filesystem like FAT, HPFS, HFS, NTFS, JFS, or - * similar. For NT, OS/2 and similar you'll won't get case-sensitive - * compares on a case-sensitive file system. - */ RTDECL(int) RTPathCompare(const char *pszPath1, const char *pszPath2) { return rtPathCompare(pszPath1, pszPath2, false /* full path lengths */); } -/** - * Checks if a path starts with the given parent path. - * - * This means that either the path and the parent path matches completely, or - * that the path is to some file or directory residing in the tree given by the - * parent directory. - * - * The path comparison takes platform-dependent details into account, - * see RTPathCompare() for details. - * - * @returns |true| when \a pszPath starts with \a pszParentPath (or when they - * are identical), or |false| otherwise. - * - * @param pszPath Path to check, must be an absolute path. - * @param pszParentPath Parent path, must be an absolute path. - * No trailing directory slash! - */ RTDECL(bool) RTPathStartsWith(const char *pszPath, const char *pszParentPath) { if (pszPath == pszParentPath) diff --git a/src/VBox/Runtime/common/rand/rand.cpp b/src/VBox/Runtime/common/rand/rand.cpp index 7f24c686808..670df176e8b 100644 --- a/src/VBox/Runtime/common/rand/rand.cpp +++ b/src/VBox/Runtime/common/rand/rand.cpp @@ -93,7 +93,6 @@ static DECLCALLBACK(int) rtRandInitOnce(void *pvUser) /** * Termination counterpart to rtRandInitOnce. * - * @returns IPRT status code. * @param pvUser Ignored. * @param fLazyCleanUpOk Set if we're terminating the process. */ diff --git a/src/VBox/Runtime/common/string/strformat.cpp b/src/VBox/Runtime/common/string/strformat.cpp index 099d40f2af3..443705fe92d 100644 --- a/src/VBox/Runtime/common/string/strformat.cpp +++ b/src/VBox/Runtime/common/string/strformat.cpp @@ -151,17 +151,6 @@ static unsigned rtStrFormatStrNLenUni(PCRTUNICP pusz, unsigned cchMax) } -/** - * Formats an integer number according to the parameters. - * - * @returns Length of the number. - * @param psz Pointer to output string. - * @param u64Value Value. - * @param uiBase Number representation base. - * @param cchWidth Width - * @param cchPrecision Precision. - * @param fFlags Flags (NTFS_*). - */ RTDECL(int) RTStrFormatNumber(char *psz, uint64_t u64Value, unsigned int uiBase, signed int cchWidth, signed int cchPrecision, unsigned int fFlags) { @@ -359,21 +348,6 @@ RTDECL(int) RTStrFormatNumber(char *psz, uint64_t u64Value, unsigned int uiBase, RT_EXPORT_SYMBOL(RTStrFormatNumber); -/** - * Partial implementation of a printf like formatter. - * It doesn't do everything correct, and there is no floating point support. - * However, it supports custom formats by the means of a format callback. - * - * @returns number of bytes formatted. - * @param pfnOutput Output worker. - * Called in two ways. Normally with a string an it's length. - * For termination, it's called with NULL for string, 0 for length. - * @param pvArgOutput Argument to the output worker. - * @param pfnFormat Custom format worker. - * @param pvArgFormat Argument to the format worker. - * @param pszFormat Format string. - * @param InArgs Argument list. - */ RTDECL(size_t) RTStrFormatV(PFNRTSTROUTPUT pfnOutput, void *pvArgOutput, PFNSTRFORMAT pfnFormat, void *pvArgFormat, const char *pszFormat, va_list InArgs) { diff --git a/src/VBox/Runtime/common/string/strspace.cpp b/src/VBox/Runtime/common/string/strspace.cpp index 7184b9388b8..4f710bedc4a 100644 --- a/src/VBox/Runtime/common/string/strspace.cpp +++ b/src/VBox/Runtime/common/string/strspace.cpp @@ -84,14 +84,6 @@ -/** - * Inserts a string into a unique string space. - * - * @returns true on success. - * @returns false if the string collided with an existing string. - * @param pStrSpace The space to insert it into. - * @param pStr The string node. - */ RTDECL(bool) RTStrSpaceInsert(PRTSTRSPACE pStrSpace, PRTSTRSPACECORE pStr) { pStr->Key = sdbm(pStr->pszString, &pStr->cchString); @@ -111,14 +103,6 @@ RTDECL(bool) RTStrSpaceInsert(PRTSTRSPACE pStrSpace, PRTSTRSPACECORE pStr) RT_EXPORT_SYMBOL(RTStrSpaceInsert); -/** - * Removes a string from a unique string space. - * - * @returns Pointer to the removed string node. - * @returns NULL if the string was not found in the string space. - * @param pStrSpace The space to insert it into. - * @param pszString The string to remove. - */ RTDECL(PRTSTRSPACECORE) RTStrSpaceRemove(PRTSTRSPACE pStrSpace, const char *pszString) { size_t cchString; @@ -160,14 +144,6 @@ RTDECL(PRTSTRSPACECORE) RTStrSpaceRemove(PRTSTRSPACE pStrSpace, const char *pszS RT_EXPORT_SYMBOL(RTStrSpaceRemove); -/** - * Gets a string from a unique string space. - * - * @returns Pointer to the string node. - * @returns NULL if the string was not found in the string space. - * @param pStrSpace The space to insert it into. - * @param pszString The string to get. - */ RTDECL(PRTSTRSPACECORE) RTStrSpaceGet(PRTSTRSPACE pStrSpace, const char *pszString) { size_t cchString; @@ -186,17 +162,6 @@ RTDECL(PRTSTRSPACECORE) RTStrSpaceGet(PRTSTRSPACE pStrSpace, const char *pszStri RT_EXPORT_SYMBOL(RTStrSpaceGet); -/** - * Gets a string from a unique string space. - * - * @returns Pointer to the string node. - * @returns NULL if the string was not found in the string space. - * @param pStrSpace The space to insert it into. - * @param pszString The string to get. - * @param cchMax The max string length to evaluate. Passing - * RTSTR_MAX is ok and makes it behave just like - * RTStrSpaceGet. - */ RTDECL(PRTSTRSPACECORE) RTStrSpaceGetN(PRTSTRSPACE pStrSpace, const char *pszString, size_t cchMax) { size_t cchString; @@ -215,17 +180,6 @@ RTDECL(PRTSTRSPACECORE) RTStrSpaceGetN(PRTSTRSPACE pStrSpace, const char *pszStr RT_EXPORT_SYMBOL(RTStrSpaceGetN); -/** - * Enumerates the string space. - * The caller supplies a callback which will be called for each of - * the string nodes. - * - * @returns 0 or what ever non-zero return value pfnCallback returned - * when aborting the destruction. - * @param pStrSpace The space to insert it into. - * @param pfnCallback The callback. - * @param pvUser The user argument. - */ RTDECL(int) RTStrSpaceEnumerate(PRTSTRSPACE pStrSpace, PFNRTSTRSPACECALLBACK pfnCallback, void *pvUser) { return KAVL_FN(DoWithAll)(pStrSpace, true, pfnCallback, pvUser); @@ -233,17 +187,6 @@ RTDECL(int) RTStrSpaceEnumerate(PRTSTRSPACE pStrSpace, PFNRTSTRSPACECALLBACK pfn RT_EXPORT_SYMBOL(RTStrSpaceEnumerate); -/** - * Destroys the string space. - * The caller supplies a callback which will be called for each of - * the string nodes in for freeing their memory and other resources. - * - * @returns 0 or what ever non-zero return value pfnCallback returned - * when aborting the destruction. - * @param pStrSpace The space to insert it into. - * @param pfnCallback The callback. - * @param pvUser The user argument. - */ RTDECL(int) RTStrSpaceDestroy(PRTSTRSPACE pStrSpace, PFNRTSTRSPACECALLBACK pfnCallback, void *pvUser) { return KAVL_FN(Destroy)(pStrSpace, pfnCallback, pvUser); diff --git a/src/VBox/Runtime/common/string/strtonum.cpp b/src/VBox/Runtime/common/string/strtonum.cpp index e45f3c3beeb..5a5c39fa78d 100644 --- a/src/VBox/Runtime/common/string/strtonum.cpp +++ b/src/VBox/Runtime/common/string/strtonum.cpp @@ -118,28 +118,6 @@ int main() */ -/** - * Converts a string representation of a number to a 64-bit unsigned number. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_NEGATIVE_UNSIGNED - * @retval VWRN_TRAILING_CHARS - * @retval VWRN_TRAILING_SPACES - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param ppszNext Where to store the pointer to the first char - * following the number. (Optional) - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pu64 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToUInt64Ex(const char *pszValue, char **ppszNext, unsigned uBaseAndMaxLen, uint64_t *pu64) { const char *psz = pszValue; @@ -264,27 +242,6 @@ RTDECL(int) RTStrToUInt64Ex(const char *pszValue, char **ppszNext, unsigned uBas RT_EXPORT_SYMBOL(RTStrToUInt64Ex); -/** - * Converts a string representation of a number to a 64-bit unsigned number, - * making sure the full string is converted. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_NEGATIVE_UNSIGNED - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * @retval VERR_TRAILING_SPACES - * @retval VERR_TRAILING_CHARS - * - * @param pszValue Pointer to the string value. - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pu64 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToUInt64Full(const char *pszValue, unsigned uBaseAndMaxLen, uint64_t *pu64) { char *psz; @@ -313,14 +270,6 @@ RTDECL(int) RTStrToUInt64Full(const char *pszValue, unsigned uBaseAndMaxLen, uin RT_EXPORT_SYMBOL(RTStrToUInt64Full); -/** - * Converts a string representation of a number to a 64-bit unsigned number. - * The base is guessed. - * - * @returns 64-bit unsigned number on success. - * @returns 0 on failure. - * @param pszValue Pointer to the string value. - */ RTDECL(uint64_t) RTStrToUInt64(const char *pszValue) { uint64_t u64; @@ -332,28 +281,6 @@ RTDECL(uint64_t) RTStrToUInt64(const char *pszValue) RT_EXPORT_SYMBOL(RTStrToUInt64); -/** - * Converts a string representation of a number to a 32-bit unsigned number. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_NEGATIVE_UNSIGNED - * @retval VWRN_TRAILING_CHARS - * @retval VWRN_TRAILING_SPACES - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param ppszNext Where to store the pointer to the first char - * following the number. (Optional) - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pu32 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToUInt32Ex(const char *pszValue, char **ppszNext, unsigned uBaseAndMaxLen, uint32_t *pu32) { uint64_t u64; @@ -370,27 +297,6 @@ RTDECL(int) RTStrToUInt32Ex(const char *pszValue, char **ppszNext, unsigned uBas RT_EXPORT_SYMBOL(RTStrToUInt32Ex); -/** - * Converts a string representation of a number to a 32-bit unsigned number, - * making sure the full string is converted. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_NEGATIVE_UNSIGNED - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * @retval VERR_TRAILING_SPACES - * @retval VERR_TRAILING_CHARS - * - * @param pszValue Pointer to the string value. - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pu32 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToUInt32Full(const char *pszValue, unsigned uBaseAndMaxLen, uint32_t *pu32) { uint64_t u64; @@ -407,14 +313,6 @@ RTDECL(int) RTStrToUInt32Full(const char *pszValue, unsigned uBaseAndMaxLen, uin RT_EXPORT_SYMBOL(RTStrToUInt32Full); -/** - * Converts a string representation of a number to a 64-bit unsigned number. - * The base is guessed. - * - * @returns 32-bit unsigned number on success. - * @returns 0 on failure. - * @param pszValue Pointer to the string value. - */ RTDECL(uint32_t) RTStrToUInt32(const char *pszValue) { uint32_t u32; @@ -426,28 +324,6 @@ RTDECL(uint32_t) RTStrToUInt32(const char *pszValue) RT_EXPORT_SYMBOL(RTStrToUInt32); -/** - * Converts a string representation of a number to a 16-bit unsigned number. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_NEGATIVE_UNSIGNED - * @retval VWRN_TRAILING_CHARS - * @retval VWRN_TRAILING_SPACES - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param ppszNext Where to store the pointer to the first char - * following the number. (Optional) - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pu16 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToUInt16Ex(const char *pszValue, char **ppszNext, unsigned uBaseAndMaxLen, uint16_t *pu16) { uint64_t u64; @@ -464,27 +340,6 @@ RTDECL(int) RTStrToUInt16Ex(const char *pszValue, char **ppszNext, unsigned uBas RT_EXPORT_SYMBOL(RTStrToUInt16Ex); -/** - * Converts a string representation of a number to a 16-bit unsigned number, - * making sure the full string is converted. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_NEGATIVE_UNSIGNED - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * @retval VERR_TRAILING_SPACES - * @retval VERR_TRAILING_CHARS - * - * @param pszValue Pointer to the string value. - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pu16 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToUInt16Full(const char *pszValue, unsigned uBaseAndMaxLen, uint16_t *pu16) { uint64_t u64; @@ -501,14 +356,6 @@ RTDECL(int) RTStrToUInt16Full(const char *pszValue, unsigned uBaseAndMaxLen, uin RT_EXPORT_SYMBOL(RTStrToUInt16Full); -/** - * Converts a string representation of a number to a 16-bit unsigned number. - * The base is guessed. - * - * @returns 16-bit unsigned number on success. - * @returns 0 on failure. - * @param pszValue Pointer to the string value. - */ RTDECL(uint16_t) RTStrToUInt16(const char *pszValue) { uint16_t u16; @@ -520,28 +367,6 @@ RTDECL(uint16_t) RTStrToUInt16(const char *pszValue) RT_EXPORT_SYMBOL(RTStrToUInt16); -/** - * Converts a string representation of a number to a 8-bit unsigned number. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_NEGATIVE_UNSIGNED - * @retval VWRN_TRAILING_CHARS - * @retval VWRN_TRAILING_SPACES - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param ppszNext Where to store the pointer to the first char - * following the number. (Optional) - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pu8 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToUInt8Ex(const char *pszValue, char **ppszNext, unsigned uBaseAndMaxLen, uint8_t *pu8) { uint64_t u64; @@ -558,27 +383,6 @@ RTDECL(int) RTStrToUInt8Ex(const char *pszValue, char **ppszNext, unsigned uBase RT_EXPORT_SYMBOL(RTStrToUInt8Ex); -/** - * Converts a string representation of a number to a 8-bit unsigned number, - * making sure the full string is converted. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_NEGATIVE_UNSIGNED - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * @retval VERR_TRAILING_SPACES - * @retval VERR_TRAILING_CHARS - * - * @param pszValue Pointer to the string value. - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pu8 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToUInt8Full(const char *pszValue, unsigned uBaseAndMaxLen, uint8_t *pu8) { uint64_t u64; @@ -595,14 +399,6 @@ RTDECL(int) RTStrToUInt8Full(const char *pszValue, unsigned uBaseAndMaxLen, uint RT_EXPORT_SYMBOL(RTStrToUInt8Full); -/** - * Converts a string representation of a number to a 8-bit unsigned number. - * The base is guessed. - * - * @returns 8-bit unsigned number on success. - * @returns 0 on failure. - * @param pszValue Pointer to the string value. - */ RTDECL(uint8_t) RTStrToUInt8(const char *pszValue) { uint8_t u8; @@ -614,32 +410,6 @@ RTDECL(uint8_t) RTStrToUInt8(const char *pszValue) RT_EXPORT_SYMBOL(RTStrToUInt8); - - - - - -/** - * Converts a string representation of a number to a 64-bit signed number. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_TRAILING_CHARS - * @retval VWRN_TRAILING_SPACES - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param ppszNext Where to store the pointer to the first char - * following the number. (Optional) - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pi64 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToInt64Ex(const char *pszValue, char **ppszNext, unsigned uBaseAndMaxLen, int64_t *pi64) { const char *psz = pszValue; @@ -772,26 +542,6 @@ RTDECL(int) RTStrToInt64Ex(const char *pszValue, char **ppszNext, unsigned uBase RT_EXPORT_SYMBOL(RTStrToInt64Ex); -/** - * Converts a string representation of a number to a 64-bit signed number, - * making sure the full string is converted. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VINF_SUCCESS - * @retval VERR_TRAILING_CHARS - * @retval VERR_TRAILING_SPACES - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pi64 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToInt64Full(const char *pszValue, unsigned uBaseAndMaxLen, int64_t *pi64) { char *psz; @@ -820,14 +570,6 @@ RTDECL(int) RTStrToInt64Full(const char *pszValue, unsigned uBaseAndMaxLen, int6 RT_EXPORT_SYMBOL(RTStrToInt64Full); -/** - * Converts a string representation of a number to a 64-bit signed number. - * The base is guessed. - * - * @returns 64-bit signed number on success. - * @returns 0 on failure. - * @param pszValue Pointer to the string value. - */ RTDECL(int64_t) RTStrToInt64(const char *pszValue) { int64_t i64; @@ -839,27 +581,6 @@ RTDECL(int64_t) RTStrToInt64(const char *pszValue) RT_EXPORT_SYMBOL(RTStrToInt64); -/** - * Converts a string representation of a number to a 32-bit signed number. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_TRAILING_CHARS - * @retval VWRN_TRAILING_SPACES - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param ppszNext Where to store the pointer to the first char - * following the number. (Optional) - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pi32 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToInt32Ex(const char *pszValue, char **ppszNext, unsigned uBaseAndMaxLen, int32_t *pi32) { int64_t i64; @@ -877,26 +598,6 @@ RTDECL(int) RTStrToInt32Ex(const char *pszValue, char **ppszNext, unsigned uBase RT_EXPORT_SYMBOL(RTStrToInt32Ex); -/** - * Converts a string representation of a number to a 32-bit signed number, - * making sure the full string is converted. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VINF_SUCCESS - * @retval VERR_TRAILING_CHARS - * @retval VERR_TRAILING_SPACES - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pi32 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToInt32Full(const char *pszValue, unsigned uBaseAndMaxLen, int32_t *pi32) { int64_t i64; @@ -914,14 +615,6 @@ RTDECL(int) RTStrToInt32Full(const char *pszValue, unsigned uBaseAndMaxLen, int3 RT_EXPORT_SYMBOL(RTStrToInt32Full); -/** - * Converts a string representation of a number to a 32-bit signed number. - * The base is guessed. - * - * @returns 32-bit signed number on success. - * @returns 0 on failure. - * @param pszValue Pointer to the string value. - */ RTDECL(int32_t) RTStrToInt32(const char *pszValue) { int32_t i32; @@ -933,28 +626,6 @@ RTDECL(int32_t) RTStrToInt32(const char *pszValue) RT_EXPORT_SYMBOL(RTStrToInt32); -/** - * Converts a string representation of a number to a 16-bit signed number. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_TRAILING_CHARS - * @retval VWRN_TRAILING_SPACES - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param ppszNext Where to store the pointer to the first char - * following the number. (Optional) - * @param pszValue Pointer to the string value. - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pi16 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToInt16Ex(const char *pszValue, char **ppszNext, unsigned uBaseAndMaxLen, int16_t *pi16) { int64_t i64; @@ -972,26 +643,6 @@ RTDECL(int) RTStrToInt16Ex(const char *pszValue, char **ppszNext, unsigned uBase RT_EXPORT_SYMBOL(RTStrToInt16Ex); -/** - * Converts a string representation of a number to a 16-bit signed number, - * making sure the full string is converted. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VINF_SUCCESS - * @retval VERR_TRAILING_CHARS - * @retval VERR_TRAILING_SPACES - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pi16 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToInt16Full(const char *pszValue, unsigned uBaseAndMaxLen, int16_t *pi16) { int64_t i64; @@ -1009,14 +660,6 @@ RTDECL(int) RTStrToInt16Full(const char *pszValue, unsigned uBaseAndMaxLen, int1 RT_EXPORT_SYMBOL(RTStrToInt16Full); -/** - * Converts a string representation of a number to a 16-bit signed number. - * The base is guessed. - * - * @returns 16-bit signed number on success. - * @returns 0 on failure. - * @param pszValue Pointer to the string value. - */ RTDECL(int16_t) RTStrToInt16(const char *pszValue) { int16_t i16; @@ -1028,27 +671,6 @@ RTDECL(int16_t) RTStrToInt16(const char *pszValue) RT_EXPORT_SYMBOL(RTStrToInt16); -/** - * Converts a string representation of a number to a 8-bit signed number. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VWRN_TRAILING_CHARS - * @retval VWRN_TRAILING_SPACES - * @retval VINF_SUCCESS - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param ppszNext Where to store the pointer to the first char - * following the number. (Optional) - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pi8 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToInt8Ex(const char *pszValue, char **ppszNext, unsigned uBaseAndMaxLen, int8_t *pi8) { int64_t i64; @@ -1066,26 +688,6 @@ RTDECL(int) RTStrToInt8Ex(const char *pszValue, char **ppszNext, unsigned uBaseA RT_EXPORT_SYMBOL(RTStrToInt8Ex); -/** - * Converts a string representation of a number to a 8-bit signed number, - * making sure the full string is converted. - * - * @returns iprt status code. - * Warnings are used to indicate conversion problems. - * @retval VWRN_NUMBER_TOO_BIG - * @retval VINF_SUCCESS - * @retval VERR_TRAILING_CHARS - * @retval VERR_TRAILING_SPACES - * @retval VERR_NO_DIGITS - * - * @param pszValue Pointer to the string value. - * @param uBaseAndMaxLen The low byte is the base of the representation, the - * upper 24 bits are the max length to parse. If the base - * is zero the function will look for known prefixes before - * defaulting to 10. A max length of zero means no length - * restriction. - * @param pi8 Where to store the converted number. (optional) - */ RTDECL(int) RTStrToInt8Full(const char *pszValue, unsigned uBaseAndMaxLen, int8_t *pi8) { int64_t i64; @@ -1103,14 +705,6 @@ RTDECL(int) RTStrToInt8Full(const char *pszValue, unsigned uBaseAndMaxLen, int8_ RT_EXPORT_SYMBOL(RTStrToInt8Full); -/** - * Converts a string representation of a number to a 8-bit signed number. - * The base is guessed. - * - * @returns 8-bit signed number on success. - * @returns 0 on failure. - * @param pszValue Pointer to the string value. - */ RTDECL(int8_t) RTStrToInt8(const char *pszValue) { int8_t i8; diff --git a/src/VBox/Runtime/common/string/utf-8-case.cpp b/src/VBox/Runtime/common/string/utf-8-case.cpp index 63aab664aea..7d91cf54c57 100644 --- a/src/VBox/Runtime/common/string/utf-8-case.cpp +++ b/src/VBox/Runtime/common/string/utf-8-case.cpp @@ -49,25 +49,6 @@ -/** - * Performs a case insensitive string compare between two UTF-8 strings. - * - * This is a simplified compare, as only the simplified lower/upper case folding - * specified by the unicode specs are used. It does not consider character pairs - * as they are used in some languages, just simple upper & lower case compares. - * - * The result is the difference between the mismatching codepoints after they - * both have been lower cased. - * - * If the string encoding is invalid the function will assert (strict builds) - * and use RTStrCmp for the remainder of the string. - * - * @returns < 0 if the first string less than the second string. - * @returns 0 if the first string identical to the second string. - * @returns > 0 if the first string greater than the second string. - * @param psz1 First UTF-8 string. Null is allowed. - * @param psz2 Second UTF-8 string. Null is allowed. - */ RTDECL(int) RTStrICmp(const char *psz1, const char *psz2) { if (psz1 == psz2) @@ -124,27 +105,6 @@ RTDECL(int) RTStrICmp(const char *psz1, const char *psz2) RT_EXPORT_SYMBOL(RTStrICmp); -/** - * Performs a case insensitive string compare between two UTF-8 strings, given a - * maximum string length. - * - * This is a simplified compare, as only the simplified lower/upper case folding - * specified by the unicode specs are used. It does not consider character pairs - * as they are used in some languages, just simple upper & lower case compares. - * - * The result is the difference between the mismatching codepoints after they - * both have been lower cased. - * - * If the string encoding is invalid the function will assert (strict builds) - * and use RTStrCmp for the remainder of the string. - * - * @returns < 0 if the first string less than the second string. - * @returns 0 if the first string identical to the second string. - * @returns > 0 if the first string greater than the second string. - * @param psz1 First UTF-8 string. Null is allowed. - * @param psz2 Second UTF-8 string. Null is allowed. - * @param cchMax Maximum string length - */ RTDECL(int) RTStrNICmp(const char *psz1, const char *psz2, size_t cchMax) { if (cchMax == 0) diff --git a/src/VBox/Runtime/common/time/time.cpp b/src/VBox/Runtime/common/time/time.cpp index 4607a3e36e3..445d595ee70 100644 --- a/src/VBox/Runtime/common/time/time.cpp +++ b/src/VBox/Runtime/common/time/time.cpp @@ -274,13 +274,6 @@ DECLINLINE(bool) rtTimeIsLeapYear(int32_t i32Year) } -/** - * Checks if a year is a leap year or not. - * - * @returns true if it's a leap year. - * @returns false if it's a common year. - * @param i32Year The year in question. - */ RTDECL(bool) RTTimeIsLeapYear(int32_t i32Year) { return rtTimeIsLeapYear(i32Year); @@ -288,13 +281,6 @@ RTDECL(bool) RTTimeIsLeapYear(int32_t i32Year) RT_EXPORT_SYMBOL(RTTimeIsLeapYear); -/** - * Explodes a time spec (UTC). - * - * @returns pTime. - * @param pTime Where to store the exploded time. - * @param pTimeSpec The time spec to exploded. - */ RTDECL(PRTTIME) RTTimeExplode(PRTTIME pTime, PCRTTIMESPEC pTimeSpec) { int64_t i64Div; @@ -400,20 +386,6 @@ RTDECL(PRTTIME) RTTimeExplode(PRTTIME pTime, PCRTTIMESPEC pTimeSpec) RT_EXPORT_SYMBOL(RTTimeExplode); -/** - * Implodes exploded time to a time spec (UTC). - * - * @returns pTime on success. - * @returns NULL if the pTime data is invalid. - * @param pTimeSpec Where to store the imploded UTC time. - * If pTime specifies a time which outside the range, maximum or - * minimum values will be returned. - * @param pTime Pointer to the exploded time to implode. - * The fields u8Month, u8WeekDay and u8MonthDay are not used, - * and all the other fields are expected to be within their - * bounds. Use RTTimeNormalize() or RTTimeLocalNormalize() to - * calculate u16YearDay and normalize the ranges of the fields. - */ RTDECL(PRTTIMESPEC) RTTimeImplode(PRTTIMESPEC pTimeSpec, PCRTTIME pTime) { int32_t i32Days; @@ -678,28 +650,6 @@ static PRTTIME rtTimeNormalizeInternal(PRTTIME pTime) } -/** - * Normalizes the fields of a time structure. - * - * It is possible to calculate year-day from month/day and vice - * versa. If you adjust any of these, make sure to zero the - * other so you make it clear which of the fields to use. If - * it's ambiguous, the year-day field is used (and you get - * assertions in debug builds). - * - * All the time fields and the year-day or month/day fields will - * be adjusted for overflows. (Since all fields are unsigned, there - * is no underflows.) It is possible to exploit this for simple - * date math, though the recommended way of doing that to implode - * the time into a timespec and do the math on that. - * - * @returns pTime on success. - * @returns NULL if the data is invalid. - * - * @param pTime The time structure to normalize. - * - * @remarks This function doesn't work with local time, only with UTC time. - */ RTDECL(PRTTIME) RTTimeNormalize(PRTTIME pTime) { /* @@ -718,28 +668,6 @@ RTDECL(PRTTIME) RTTimeNormalize(PRTTIME pTime) RT_EXPORT_SYMBOL(RTTimeNormalize); -/** - * Normalizes the fields of a time structure, assuming local time. - * - * It is possible to calculate year-day from month/day and vice - * versa. If you adjust any of these, make sure to zero the - * other so you make it clear which of the fields to use. If - * it's ambiguous, the year-day field is used (and you get - * assertions in debug builds). - * - * All the time fields and the year-day or month/day fields will - * be adjusted for overflows. (Since all fields are unsigned, there - * is no underflows.) It is possible to exploit this for simple - * date math, though the recommended way of doing that to implode - * the time into a timespec and do the math on that. - * - * @returns pTime on success. - * @returns NULL if the data is invalid. - * - * @param pTime The time structure to normalize. - * - * @remarks This function doesn't work with UTC time, only with local time. - */ RTDECL(PRTTIME) RTTimeLocalNormalize(PRTTIME pTime) { /* @@ -757,15 +685,6 @@ RTDECL(PRTTIME) RTTimeLocalNormalize(PRTTIME pTime) RT_EXPORT_SYMBOL(RTTimeLocalNormalize); -/** - * Converts a time spec to a ISO date string. - * - * @returns psz on success. - * @returns NULL on buffer underflow. - * @param pTime The time. Caller should've normalized this. - * @param psz Where to store the string. - * @param cb The size of the buffer. - */ RTDECL(char *) RTTimeToString(PCRTTIME pTime, char *psz, size_t cb) { size_t cch; @@ -809,16 +728,6 @@ RTDECL(char *) RTTimeToString(PCRTTIME pTime, char *psz, size_t cb) RT_EXPORT_SYMBOL(RTTimeToString); -/** - * Converts a time spec to a ISO date string, extended version. - * - * @returns Output string length on success (positive), VERR_BUFFER_OVERFLOW - * (negative) or VERR_OUT_OF_RANGE (negative) on failure. - * @param pTime The time. Caller should've normalized this. - * @param psz Where to store the string. - * @param cb The size of the buffer. - * @param cFractionDigits Number of digits in the fraction. Max is 9. - */ RTDECL(ssize_t) RTTimeToStringEx(PCRTTIME pTime, char *psz, size_t cb, unsigned cFractionDigits) { size_t cch; @@ -877,15 +786,6 @@ RTDECL(ssize_t) RTTimeToStringEx(PCRTTIME pTime, char *psz, size_t cb, unsigned RT_EXPORT_SYMBOL(RTTimeToStringEx); -/** - * Converts a time spec to a ISO date string. - * - * @returns psz on success. - * @returns NULL on buffer underflow. - * @param pTime The time spec. - * @param psz Where to store the string. - * @param cb The size of the buffer. - */ RTDECL(char *) RTTimeSpecToString(PCRTTIMESPEC pTime, char *psz, size_t cb) { RTTIME Time; @@ -895,17 +795,6 @@ RT_EXPORT_SYMBOL(RTTimeSpecToString); -/** - * Attempts to convert an ISO date string to a time structure. - * - * We're a little forgiving with zero padding, unspecified parts, and leading - * and trailing spaces. - * - * @retval pTime on success, - * @retval NULL on failure. - * @param pTime Where to store the time on success. - * @param pszString The ISO date string to convert. - */ RTDECL(PRTTIME) RTTimeFromString(PRTTIME pTime, const char *pszString) { /* Ignore leading spaces. */ @@ -1071,17 +960,6 @@ RTDECL(PRTTIME) RTTimeFromString(PRTTIME pTime, const char *pszString) RT_EXPORT_SYMBOL(RTTimeFromString); -/** - * Attempts to convert an ISO date string to a time structure. - * - * We're a little forgiving with zero padding, unspecified parts, and leading - * and trailing spaces. - * - * @retval pTime on success, - * @retval NULL on failure. - * @param pTime The time spec. - * @param pszString The ISO date string to convert. - */ RTDECL(PRTTIMESPEC) RTTimeSpecFromString(PRTTIMESPEC pTime, const char *pszString) { RTTIME Time; @@ -1092,15 +970,6 @@ RTDECL(PRTTIMESPEC) RTTimeSpecFromString(PRTTIMESPEC pTime, const char *pszStrin RT_EXPORT_SYMBOL(RTTimeSpecFromString); -/** - * Formats the given time on a RTC-2822 compliant format. - * - * @returns Output string length on success (positive), VERR_BUFFER_OVERFLOW - * (negative) on failure. - * @param pTime The time. Caller should've normalized this. - * @param psz Where to store the string. - * @param cb The size of the buffer. - */ RTDECL(ssize_t) RTTimeToRfc2822(PRTTIME pTime, char *psz, size_t cb, uint32_t fFlags) { Assert(pTime->u8Month > 0 && pTime->u8Month <= 12); @@ -1160,17 +1029,6 @@ RTDECL(ssize_t) RTTimeToRfc2822(PRTTIME pTime, char *psz, size_t cb, uint32_t fF RT_EXPORT_SYMBOL(RTTimeToRfc2822); -/** - * Attempts to convert an RFC-2822 date string to a time structure. - * - * We're a little forgiving with zero padding, unspecified parts, and leading - * and trailing spaces. - * - * @retval pTime on success, - * @retval NULL on failure. - * @param pTime Where to store the time on success. - * @param pszString The ISO date string to convert. - */ RTDECL(PRTTIME) RTTimeFromRfc2822(PRTTIME pTime, const char *pszString) { /* @@ -1551,13 +1409,6 @@ static PRTTIME rtTimeConvertToZulu(PRTTIME pTime) } -/** - * Converts a time structure to UTC, relying on UTC offset information if it contains local time. - * - * @returns pTime on success. - * @returns NULL if the data is invalid. - * @param pTime The time structure to convert. - */ RTDECL(PRTTIME) RTTimeConvertToZulu(PRTTIME pTime) { /* @@ -1571,19 +1422,6 @@ RTDECL(PRTTIME) RTTimeConvertToZulu(PRTTIME pTime) RT_EXPORT_SYMBOL(RTTimeConvertToZulu); -/** - * Compares two normalized time structures. - * - * @retval 0 if equal. - * @retval -1 if @a pLeft is earlier than @a pRight. - * @retval 1 if @a pRight is earlier than @a pLeft. - * - * @param pLeft The left side time. NULL is accepted. - * @param pRight The right side time. NULL is accepted. - * - * @note A NULL time is considered smaller than anything else. If both are - * NULL, they are considered equal. - */ RTDECL(int) RTTimeCompare(PCRTTIME pLeft, PCRTTIME pRight) { #ifdef RT_STRICT diff --git a/src/VBox/Runtime/r0drv/linux/the-linux-kernel.h b/src/VBox/Runtime/r0drv/linux/the-linux-kernel.h index 391d6b30171..ef9ba112fa1 100644 --- a/src/VBox/Runtime/r0drv/linux/the-linux-kernel.h +++ b/src/VBox/Runtime/r0drv/linux/the-linux-kernel.h @@ -471,7 +471,7 @@ DECLINLINE(unsigned long) msecs_to_jiffies(unsigned int cMillies) /** @def IPRT_LINUX_HAS_HRTIMER * Whether the kernel support high resolution timers (Linux kernel versions * 2.6.28 and later (hrtimer_add_expires_ns() & schedule_hrtimeout). */ -#if RTLNX_VER_MIN(2,6,28) +#if RTLNX_VER_MIN(2,6,28) || defined(DOXYGEN_RUNNING) # define IPRT_LINUX_HAS_HRTIMER #endif diff --git a/src/VBox/Runtime/r0drv/memobj-r0drv.cpp b/src/VBox/Runtime/r0drv/memobj-r0drv.cpp index f4706da09d0..3193a7c8a91 100644 --- a/src/VBox/Runtime/r0drv/memobj-r0drv.cpp +++ b/src/VBox/Runtime/r0drv/memobj-r0drv.cpp @@ -156,12 +156,6 @@ static int rtR0MemObjLink(PRTR0MEMOBJINTERNAL pParent, PRTR0MEMOBJINTERNAL pChil } -/** - * Checks if this is mapping or not. - * - * @returns true if it's a mapping, otherwise false. - * @param MemObj The ring-0 memory object handle. - */ RTR0DECL(bool) RTR0MemObjIsMapping(RTR0MEMOBJ MemObj) { /* Validate the object handle. */ @@ -177,13 +171,6 @@ RTR0DECL(bool) RTR0MemObjIsMapping(RTR0MEMOBJ MemObj) RT_EXPORT_SYMBOL(RTR0MemObjIsMapping); -/** - * Gets the address of a ring-0 memory object. - * - * @returns The address of the memory object. - * @returns NULL if the handle is invalid (asserts in strict builds) or if there isn't any mapping. - * @param MemObj The ring-0 memory object handle. - */ RTR0DECL(void *) RTR0MemObjAddress(RTR0MEMOBJ MemObj) { /* Validate the object handle. */ @@ -201,18 +188,6 @@ RTR0DECL(void *) RTR0MemObjAddress(RTR0MEMOBJ MemObj) RT_EXPORT_SYMBOL(RTR0MemObjAddress); -/** - * Gets the ring-3 address of a ring-0 memory object. - * - * This only applies to ring-0 memory object with ring-3 mappings of some kind, i.e. - * locked user memory, reserved user address space and user mappings. This API should - * not be used on any other objects. - * - * @returns The address of the memory object. - * @returns NIL_RTR3PTR if the handle is invalid or if it's not an object with a ring-3 mapping. - * Strict builds will assert in both cases. - * @param MemObj The ring-0 memory object handle. - */ RTR0DECL(RTR3PTR) RTR0MemObjAddressR3(RTR0MEMOBJ MemObj) { PRTR0MEMOBJINTERNAL pMem; @@ -240,18 +215,6 @@ RTR0DECL(RTR3PTR) RTR0MemObjAddressR3(RTR0MEMOBJ MemObj) RT_EXPORT_SYMBOL(RTR0MemObjAddressR3); -/** - * Gets the size of a ring-0 memory object. - * - * The returned value may differ from the one specified to the API creating the - * object because of alignment adjustments. The minimal alignment currently - * employed by any API is PAGE_SIZE, so the result can safely be shifted by - * PAGE_SHIFT to calculate a page count. - * - * @returns The object size. - * @returns 0 if the handle is invalid (asserts in strict builds) or if there isn't any mapping. - * @param MemObj The ring-0 memory object handle. - */ RTR0DECL(size_t) RTR0MemObjSize(RTR0MEMOBJ MemObj) { PRTR0MEMOBJINTERNAL pMem; @@ -271,16 +234,6 @@ RTR0DECL(size_t) RTR0MemObjSize(RTR0MEMOBJ MemObj) RT_EXPORT_SYMBOL(RTR0MemObjSize); -/** - * Get the physical address of an page in the memory object. - * - * @returns The physical address. - * @returns NIL_RTHCPHYS if the object doesn't contain fixed physical pages. - * @returns NIL_RTHCPHYS if the iPage is out of range. - * @returns NIL_RTHCPHYS if the object handle isn't valid. - * @param MemObj The ring-0 memory object handle. - * @param iPage The page number within the object. - */ /* Work around gcc bug 55940 */ #if defined(__GNUC__) && defined(RT_ARCH_X86) && (__GNUC__ * 100 + __GNUC_MINOR__) == 407 __attribute__((__optimize__ ("no-shrink-wrap"))) @@ -321,21 +274,6 @@ RTR0DECL(RTHCPHYS) RTR0MemObjGetPagePhysAddr(RTR0MEMOBJ MemObj, size_t iPage) RT_EXPORT_SYMBOL(RTR0MemObjGetPagePhysAddr); -/** - * Checks whether the allocation was zero initialized or not. - * - * This only works on allocations. It is not meaningful for mappings, reserved - * memory and entered physical address, and will return false for these. - * - * @returns true if the allocation was initialized to zero at allocation time, - * false if not or query not meaningful to the object type. - * @param hMemObj The ring-0 memory object to be freed. - * - * @remarks It can be expected that memory allocated in the same fashion will - * have the same initialization state. So, if this returns true for - * one allocation it will return true for all other similarly made - * allocations. - */ RTR0DECL(bool) RTR0MemObjWasZeroInitialized(RTR0MEMOBJ hMemObj) { PRTR0MEMOBJINTERNAL pMem; @@ -357,15 +295,6 @@ RTR0DECL(bool) RTR0MemObjWasZeroInitialized(RTR0MEMOBJ hMemObj) RT_EXPORT_SYMBOL(RTR0MemObjWasZeroInitialized); -/** - * Frees a ring-0 memory object. - * - * @returns IPRT status code. - * @retval VERR_INVALID_HANDLE if - * @param MemObj The ring-0 memory object to be freed. NIL is - * accepted. - * @param fFreeMappings Whether or not to free mappings of the object. - */ RTR0DECL(int) RTR0MemObjFree(RTR0MEMOBJ MemObj, bool fFreeMappings) { /* diff --git a/src/VBox/Runtime/r0drv/nt/alloc-r0drv-nt.cpp b/src/VBox/Runtime/r0drv/nt/alloc-r0drv-nt.cpp index e161bbf40e9..c5d5fcd9b9e 100644 --- a/src/VBox/Runtime/r0drv/nt/alloc-r0drv-nt.cpp +++ b/src/VBox/Runtime/r0drv/nt/alloc-r0drv-nt.cpp @@ -92,15 +92,6 @@ DECLHIDDEN(void) rtR0MemFree(PRTMEMHDR pHdr) } -/** - * Allocates physical contiguous memory (below 4GB). - * The allocation is page aligned and its contents is undefined. - * - * @returns Pointer to the memory block. This is page aligned. - * @param pPhys Where to store the physical address. - * @param cb The allocation size in bytes. This is always - * rounded up to PAGE_SIZE. - */ RTR0DECL(void *) RTMemContAlloc(PRTCCPHYS pPhys, size_t cb) { /* @@ -142,12 +133,6 @@ RTR0DECL(void *) RTMemContAlloc(PRTCCPHYS pPhys, size_t cb) } -/** - * Frees memory allocated ysing RTMemContAlloc(). - * - * @param pv Pointer to return from RTMemContAlloc(). - * @param cb The cb parameter passed to RTMemContAlloc(). - */ RTR0DECL(void) RTMemContFree(void *pv, size_t cb) { if (pv) diff --git a/src/VBox/Runtime/r0drv/nt/timer-r0drv-nt.cpp b/src/VBox/Runtime/r0drv/nt/timer-r0drv-nt.cpp index cf3295e99e9..517b3f86059 100644 --- a/src/VBox/Runtime/r0drv/nt/timer-r0drv-nt.cpp +++ b/src/VBox/Runtime/r0drv/nt/timer-r0drv-nt.cpp @@ -312,7 +312,6 @@ static void rtTimerNtRearmInternval(PRTTIMER pTimer, PKDPC pMasterDpc) /** * Common timer callback worker for the non-omni timers. * - * @returns HRTIMER_NORESTART or HRTIMER_RESTART depending on whether it's a one-shot or interval timer. * @param pTimer The timer. */ static void rtTimerNtSimpleCallbackWorker(PRTTIMER pTimer) diff --git a/src/VBox/Runtime/r3/fileio.cpp b/src/VBox/Runtime/r3/fileio.cpp index 8fefa689747..e30268cff04 100644 --- a/src/VBox/Runtime/r3/fileio.cpp +++ b/src/VBox/Runtime/r3/fileio.cpp @@ -209,13 +209,6 @@ int rtFileRecalcAndValidateFlags(uint64_t *pfOpen) } -/** - * Gets the current file position. - * - * @returns File offset. - * @returns ~0UUL on failure. - * @param File File handle. - */ RTR3DECL(uint64_t) RTFileTell(RTFILE File) { /* diff --git a/src/VBox/Runtime/r3/ftp-server.cpp b/src/VBox/Runtime/r3/ftp-server.cpp index 237dc8b9567..5681b3648e1 100644 --- a/src/VBox/Runtime/r3/ftp-server.cpp +++ b/src/VBox/Runtime/r3/ftp-server.cpp @@ -1240,7 +1240,6 @@ static int rtFtpServerDataConnStop(PRTFTPSERVERDATACONN pDataConn) /** * Destroys a data connection. * - * @returns VBox status code. * @param pDataConn Data connection to destroy. The pointer is not valid anymore after successful return. */ static void rtFtpServerDataConnDestroy(PRTFTPSERVERDATACONN pDataConn) @@ -1265,7 +1264,6 @@ static void rtFtpServerDataConnDestroy(PRTFTPSERVERDATACONN pDataConn) /** * Resets a data connection structure. * - * @returns VBox status code. * @param pDataConn Data connection structure to reset. */ static void rtFtpServerDataConnReset(PRTFTPSERVERDATACONN pDataConn) diff --git a/src/VBox/Runtime/r3/generic/dirrel-r3-generic.cpp b/src/VBox/Runtime/r3/generic/dirrel-r3-generic.cpp index e2f5789f7da..8ec842db0ae 100644 --- a/src/VBox/Runtime/r3/generic/dirrel-r3-generic.cpp +++ b/src/VBox/Runtime/r3/generic/dirrel-r3-generic.cpp @@ -117,19 +117,6 @@ static int rtDirRelBuildFullPath(PRTDIRINTERNAL pThis, char *pszPathDst, size_t -/** - * Open a file relative to @a hDir. - * - * @returns IPRT status code. - * @param hDir The directory to open relative to. - * @param pszRelFilename The relative path to the file. - * @param fOpen Open flags, i.e a combination of the RTFILE_O_XXX - * defines. The ACCESS, ACTION and DENY flags are - * mandatory! - * @param phFile Where to store the handle to the opened file. - * - * @sa RTFileOpen - */ RTDECL(int) RTDirRelFileOpen(RTDIR hDir, const char *pszRelFilename, uint64_t fOpen, PRTFILE phFile) { PRTDIRINTERNAL pThis = hDir; @@ -157,16 +144,6 @@ RTDECL(int) RTDirRelFileOpen(RTDIR hDir, const char *pszRelFilename, uint64_t f -/** - * Opens a directory relative to @a hDir. - * - * @returns IPRT status code. - * @param hDir The directory to open relative to. - * @param pszDir The relative path to the directory to open. - * @param phDir Where to store the directory handle. - * - * @sa RTDirOpen - */ RTDECL(int) RTDirRelDirOpen(RTDIR hDir, const char *pszDir, RTDIR *phDir) { PRTDIRINTERNAL pThis = hDir; @@ -182,21 +159,6 @@ RTDECL(int) RTDirRelDirOpen(RTDIR hDir, const char *pszDir, RTDIR *phDir) } -/** - * Opens a directory relative to @a hDir, with flags and optional filtering. - * - * @returns IPRT status code. - * @param hDir The directory to open relative to. - * @param pszDirAndFilter The relative path to the directory to search, this - * must include wildcards. - * @param enmFilter The kind of filter to apply. Setting this to - * RTDIRFILTER_NONE makes this function behave like - * RTDirOpen. - * @param fFlags Open flags, RTDIR_F_XXX. - * @param phDir Where to store the directory handle. - * - * @sa RTDirOpenFiltered - */ RTDECL(int) RTDirRelDirOpenFiltered(RTDIR hDir, const char *pszDirAndFilter, RTDIRFILTER enmFilter, uint32_t fFlags, RTDIR *phDir) { @@ -212,19 +174,6 @@ RTDECL(int) RTDirRelDirOpenFiltered(RTDIR hDir, const char *pszDirAndFilter, RTD } -/** - * Creates a directory relative to @a hDir. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the directory to create. - * @param fMode The mode of the new directory. - * @param fCreate Create flags, RTDIRCREATE_FLAGS_XXX. - * @param phSubDir Where to return the handle of the created directory. - * Optional. - * - * @sa RTDirCreate - */ RTDECL(int) RTDirRelDirCreate(RTDIR hDir, const char *pszRelPath, RTFMODE fMode, uint32_t fCreate, RTDIR *phSubDir) { PRTDIRINTERNAL pThis = hDir; @@ -243,15 +192,6 @@ RTDECL(int) RTDirRelDirCreate(RTDIR hDir, const char *pszRelPath, RTFMODE fMode, } -/** - * Removes a directory relative to @a hDir if empty. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the directory to remove. - * - * @sa RTDirRemove - */ RTDECL(int) RTDirRelDirRemove(RTDIR hDir, const char *pszRelPath) { PRTDIRINTERNAL pThis = hDir; @@ -276,26 +216,6 @@ RTDECL(int) RTDirRelDirRemove(RTDIR hDir, const char *pszRelPath) */ -/** - * Query information about a file system object relative to @a hDir. - * - * @returns IPRT status code. - * @retval VINF_SUCCESS if the object exists, information returned. - * @retval VERR_PATH_NOT_FOUND if any but the last component in the specified - * path was not found or was not a directory. - * @retval VERR_FILE_NOT_FOUND if the object does not exist (but path to the - * parent directory exists). - * - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the file system object. - * @param pObjInfo Object information structure to be filled on successful - * return. - * @param enmAddAttr Which set of additional attributes to request. - * Use RTFSOBJATTRADD_NOTHING if this doesn't matter. - * @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK. - * - * @sa RTPathQueryInfoEx - */ RTDECL(int) RTDirRelPathQueryInfo(RTDIR hDir, const char *pszRelPath, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr, uint32_t fFlags) { @@ -311,20 +231,6 @@ RTDECL(int) RTDirRelPathQueryInfo(RTDIR hDir, const char *pszRelPath, PRTFSOBJIN } -/** - * Changes the mode flags of a file system object relative to @a hDir. - * - * The API requires at least one of the mode flag sets (Unix/Dos) to - * be set. The type is ignored. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the file system object. - * @param fMode The new file mode, see @ref grp_rt_fs for details. - * @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK. - * - * @sa RTPathSetMode - */ RTDECL(int) RTDirRelPathSetMode(RTDIR hDir, const char *pszRelPath, RTFMODE fMode, uint32_t fFlags) { PRTDIRINTERNAL pThis = hDir; @@ -347,32 +253,6 @@ RTDECL(int) RTDirRelPathSetMode(RTDIR hDir, const char *pszRelPath, RTFMODE fMod } -/** - * Changes one or more of the timestamps associated of file system object - * relative to @a hDir. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the file system object. - * @param pAccessTime Pointer to the new access time. - * @param pModificationTime Pointer to the new modification time. - * @param pChangeTime Pointer to the new change time. NULL if not to be changed. - * @param pBirthTime Pointer to the new time of birth. NULL if not to be changed. - * @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK. - * - * @remark The file system might not implement all these time attributes, - * the API will ignore the ones which aren't supported. - * - * @remark The file system might not implement the time resolution - * employed by this interface, the time will be chopped to fit. - * - * @remark The file system may update the change time even if it's - * not specified. - * - * @remark POSIX can only set Access & Modification and will always set both. - * - * @sa RTPathSetTimesEx - */ RTDECL(int) RTDirRelPathSetTimes(RTDIR hDir, const char *pszRelPath, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime, PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime, uint32_t fFlags) { @@ -388,20 +268,6 @@ RTDECL(int) RTDirRelPathSetTimes(RTDIR hDir, const char *pszRelPath, PCRTTIMESPE } -/** - * Changes the owner and/or group of a file system object relative to @a hDir. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the file system object. - * @param uid The new file owner user id. Pass NIL_RTUID to leave - * this unchanged. - * @param gid The new group id. Pass NIL_RTGID to leave this - * unchanged. - * @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK. - * - * @sa RTPathSetOwnerEx - */ RTDECL(int) RTDirRelPathSetOwner(RTDIR hDir, const char *pszRelPath, uint32_t uid, uint32_t gid, uint32_t fFlags) { PRTDIRINTERNAL pThis = hDir; @@ -423,21 +289,6 @@ RTDECL(int) RTDirRelPathSetOwner(RTDIR hDir, const char *pszRelPath, uint32_t ui } -/** - * Renames a directory relative path within a filesystem. - * - * This will rename symbolic links. If RTPATHRENAME_FLAGS_REPLACE is used and - * pszDst is a symbolic link, it will be replaced and not its target. - * - * @returns IPRT status code. - * @param hDirSrc The directory the source path is relative to. - * @param pszSrc The source path, relative to @a hDirSrc. - * @param hDirDst The directory the destination path is relative to. - * @param pszDst The destination path, relative to @a hDirDst. - * @param fRename Rename flags, RTPATHRENAME_FLAGS_XXX. - * - * @sa RTPathRename - */ RTDECL(int) RTDirRelPathRename(RTDIR hDirSrc, const char *pszSrc, RTDIR hDirDst, const char *pszDst, unsigned fRename) { PRTDIRINTERNAL pThis = hDirSrc; @@ -464,16 +315,6 @@ RTDECL(int) RTDirRelPathRename(RTDIR hDirSrc, const char *pszSrc, RTDIR hDirDst, } -/** - * Removes the last component of the directory relative path. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the file system object. - * @param fUnlink Unlink flags, RTPATHUNLINK_FLAGS_XXX. - * - * @sa RTPathUnlink - */ RTDECL(int) RTDirRelPathUnlink(RTDIR hDir, const char *pszRelPath, uint32_t fUnlink) { PRTDIRINTERNAL pThis = hDir; @@ -498,24 +339,6 @@ RTDECL(int) RTDirRelPathUnlink(RTDIR hDir, const char *pszRelPath, uint32_t fUnl */ -/** - * Creates a symbolic link (@a pszSymlink) relative to @a hDir targeting @a - * pszTarget. - * - * @returns IPRT status code. - * @param hDir The directory @a pszSymlink is relative to. - * @param pszSymlink The relative path of the symbolic link. - * @param pszTarget The path to the symbolic link target. This is - * relative to @a pszSymlink or an absolute path. - * @param enmType The symbolic link type. For Windows compatability - * it is very important to set this correctly. When - * RTSYMLINKTYPE_UNKNOWN is used, the API will try - * make a guess and may attempt query information - * about @a pszTarget in the process. - * @param fCreate Create flags, RTSYMLINKCREATE_FLAGS_XXX. - * - * @sa RTSymlinkCreate - */ RTDECL(int) RTDirRelSymlinkCreate(RTDIR hDir, const char *pszSymlink, const char *pszTarget, RTSYMLINKTYPE enmType, uint32_t fCreate) { @@ -531,24 +354,6 @@ RTDECL(int) RTDirRelSymlinkCreate(RTDIR hDir, const char *pszSymlink, const char } -/** - * Read the symlink target relative to @a hDir. - * - * @returns IPRT status code. - * @retval VERR_NOT_SYMLINK if @a pszSymlink does not specify a symbolic link. - * @retval VERR_BUFFER_OVERFLOW if the link is larger than @a cbTarget. The - * buffer will contain what all we managed to read, fully terminated - * if @a cbTarget > 0. - * - * @param hDir The directory @a pszSymlink is relative to. - * @param pszSymlink The relative path to the symbolic link that should - * be read. - * @param pszTarget The target buffer. - * @param cbTarget The size of the target buffer. - * @param fRead Read flags, RTSYMLINKREAD_FLAGS_XXX. - * - * @sa RTSymlinkRead - */ RTDECL(int) RTDirRelSymlinkRead(RTDIR hDir, const char *pszSymlink, char *pszTarget, size_t cbTarget, uint32_t fRead) { PRTDIRINTERNAL pThis = hDir; diff --git a/src/VBox/Runtime/r3/nt/dirrel-r3-nt.cpp b/src/VBox/Runtime/r3/nt/dirrel-r3-nt.cpp index 415dd2d7dfc..a7951e2e238 100644 --- a/src/VBox/Runtime/r3/nt/dirrel-r3-nt.cpp +++ b/src/VBox/Runtime/r3/nt/dirrel-r3-nt.cpp @@ -481,20 +481,6 @@ RTDECL(int) RTDirRelPathQueryInfo(RTDIR hDir, const char *pszRelPath, PRTFSOBJIN } -/** - * Changes the mode flags of a file system object relative to @a hDir. - * - * The API requires at least one of the mode flag sets (Unix/Dos) to - * be set. The type is ignored. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the file system object. - * @param fMode The new file mode, see @ref grp_rt_fs for details. - * @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK. - * - * @sa RTPathSetMode - */ RTDECL(int) RTDirRelPathSetMode(RTDIR hDir, const char *pszRelPath, RTFMODE fMode, uint32_t fFlags) { PRTDIRINTERNAL pThis = hDir; @@ -549,32 +535,6 @@ RTDECL(int) RTDirRelPathSetMode(RTDIR hDir, const char *pszRelPath, RTFMODE fMod } -/** - * Changes one or more of the timestamps associated of file system object - * relative to @a hDir. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the file system object. - * @param pAccessTime Pointer to the new access time. - * @param pModificationTime Pointer to the new modification time. - * @param pChangeTime Pointer to the new change time. NULL if not to be changed. - * @param pBirthTime Pointer to the new time of birth. NULL if not to be changed. - * @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK. - * - * @remark The file system might not implement all these time attributes, - * the API will ignore the ones which aren't supported. - * - * @remark The file system might not implement the time resolution - * employed by this interface, the time will be chopped to fit. - * - * @remark The file system may update the change time even if it's - * not specified. - * - * @remark POSIX can only set Access & Modification and will always set both. - * - * @sa RTPathSetTimesEx - */ RTDECL(int) RTDirRelPathSetTimes(RTDIR hDir, const char *pszRelPath, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime, PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime, uint32_t fFlags) { @@ -585,28 +545,11 @@ RTDECL(int) RTDirRelPathSetTimes(RTDIR hDir, const char *pszRelPath, PCRTTIMESPE char szPath[RTPATH_MAX]; int rc = rtDirRelBuildFullPath(pThis, szPath, sizeof(szPath), pszRelPath); if (RT_SUCCESS(rc)) - { -RTAssertMsg2("DBG: RTDirRelPathSetTimes(%s)...\n", szPath); rc = RTPathSetTimesEx(szPath, pAccessTime, pModificationTime, pChangeTime, pBirthTime, fFlags); - } return rc; } -/** - * Changes the owner and/or group of a file system object relative to @a hDir. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the file system object. - * @param uid The new file owner user id. Pass NIL_RTUID to leave - * this unchanged. - * @param gid The new group id. Pass NIL_RTGID to leave this - * unchanged. - * @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK. - * - * @sa RTPathSetOwnerEx - */ RTDECL(int) RTDirRelPathSetOwner(RTDIR hDir, const char *pszRelPath, uint32_t uid, uint32_t gid, uint32_t fFlags) { PRTDIRINTERNAL pThis = hDir; @@ -617,7 +560,6 @@ RTDECL(int) RTDirRelPathSetOwner(RTDIR hDir, const char *pszRelPath, uint32_t ui int rc = rtDirRelBuildFullPath(pThis, szPath, sizeof(szPath), pszRelPath); if (RT_SUCCESS(rc)) { -RTAssertMsg2("DBG: RTDirRelPathSetOwner(%s)...\n", szPath); #ifndef RT_OS_WINDOWS rc = RTPathSetOwnerEx(szPath, uid, gid, fFlags); #else @@ -629,21 +571,6 @@ RTAssertMsg2("DBG: RTDirRelPathSetOwner(%s)...\n", szPath); } -/** - * Renames a directory relative path within a filesystem. - * - * This will rename symbolic links. If RTPATHRENAME_FLAGS_REPLACE is used and - * pszDst is a symbolic link, it will be replaced and not its target. - * - * @returns IPRT status code. - * @param hDirSrc The directory the source path is relative to. - * @param pszSrc The source path, relative to @a hDirSrc. - * @param hDirSrc The directory the destination path is relative to. - * @param pszDst The destination path, relative to @a hDirDst. - * @param fRename Rename flags, RTPATHRENAME_FLAGS_XXX. - * - * @sa RTPathRename - */ RTDECL(int) RTDirRelPathRename(RTDIR hDirSrc, const char *pszSrc, RTDIR hDirDst, const char *pszDst, unsigned fRename) { PRTDIRINTERNAL pThis = hDirSrc; @@ -664,25 +591,12 @@ RTDECL(int) RTDirRelPathRename(RTDIR hDirSrc, const char *pszSrc, RTDIR hDirDst, char szDstPath[RTPATH_MAX]; rc = rtDirRelBuildFullPath(pThis, szDstPath, sizeof(szDstPath), pszDst); if (RT_SUCCESS(rc)) - { -RTAssertMsg2("DBG: RTDirRelPathRename(%s,%s)...\n", szSrcPath, szDstPath); rc = RTPathRename(szSrcPath, szDstPath, fRename); - } } return rc; } -/** - * Removes the last component of the directory relative path. - * - * @returns IPRT status code. - * @param hDir The directory @a pszRelPath is relative to. - * @param pszRelPath The relative path to the file system object. - * @param fUnlink Unlink flags, RTPATHUNLINK_FLAGS_XXX. - * - * @sa RTPathUnlink - */ RTDECL(int) RTDirRelPathUnlink(RTDIR hDir, const char *pszRelPath, uint32_t fUnlink) { PRTDIRINTERNAL pThis = hDir; @@ -692,10 +606,7 @@ RTDECL(int) RTDirRelPathUnlink(RTDIR hDir, const char *pszRelPath, uint32_t fUnl char szPath[RTPATH_MAX]; int rc = rtDirRelBuildFullPath(pThis, szPath, sizeof(szPath), pszRelPath); if (RT_SUCCESS(rc)) - { -RTAssertMsg2("DBG: RTDirRelPathUnlink(%s)...\n", szPath); rc = RTPathUnlink(szPath, fUnlink); - } return rc; } @@ -710,24 +621,6 @@ RTAssertMsg2("DBG: RTDirRelPathUnlink(%s)...\n", szPath); */ -/** - * Creates a symbolic link (@a pszSymlink) relative to @a hDir targeting @a - * pszTarget. - * - * @returns IPRT status code. - * @param hDir The directory @a pszSymlink is relative to. - * @param pszSymlink The relative path of the symbolic link. - * @param pszTarget The path to the symbolic link target. This is - * relative to @a pszSymlink or an absolute path. - * @param enmType The symbolic link type. For Windows compatability - * it is very important to set this correctly. When - * RTSYMLINKTYPE_UNKNOWN is used, the API will try - * make a guess and may attempt query information - * about @a pszTarget in the process. - * @param fCreate Create flags, RTSYMLINKCREATE_FLAGS_XXX. - * - * @sa RTSymlinkCreate - */ RTDECL(int) RTDirRelSymlinkCreate(RTDIR hDir, const char *pszSymlink, const char *pszTarget, RTSYMLINKTYPE enmType, uint32_t fCreate) { @@ -738,32 +631,11 @@ RTDECL(int) RTDirRelSymlinkCreate(RTDIR hDir, const char *pszSymlink, const char char szPath[RTPATH_MAX]; int rc = rtDirRelBuildFullPath(pThis, szPath, sizeof(szPath), pszSymlink); if (RT_SUCCESS(rc)) - { -RTAssertMsg2("DBG: RTDirRelSymlinkCreate(%s)...\n", szPath); rc = RTSymlinkCreate(szPath, pszTarget, enmType, fCreate); - } return rc; } -/** - * Read the symlink target relative to @a hDir. - * - * @returns IPRT status code. - * @retval VERR_NOT_SYMLINK if @a pszSymlink does not specify a symbolic link. - * @retval VERR_BUFFER_OVERFLOW if the link is larger than @a cbTarget. The - * buffer will contain what all we managed to read, fully terminated - * if @a cbTarget > 0. - * - * @param hDir The directory @a pszSymlink is relative to. - * @param pszSymlink The relative path to the symbolic link that should - * be read. - * @param pszTarget The target buffer. - * @param cbTarget The size of the target buffer. - * @param fRead Read flags, RTSYMLINKREAD_FLAGS_XXX. - * - * @sa RTSymlinkRead - */ RTDECL(int) RTDirRelSymlinkRead(RTDIR hDir, const char *pszSymlink, char *pszTarget, size_t cbTarget, uint32_t fRead) { PRTDIRINTERNAL pThis = hDir; @@ -773,10 +645,7 @@ RTDECL(int) RTDirRelSymlinkRead(RTDIR hDir, const char *pszSymlink, char *pszTar char szPath[RTPATH_MAX]; int rc = rtDirRelBuildFullPath(pThis, szPath, sizeof(szPath), pszSymlink); if (RT_SUCCESS(rc)) - { -RTAssertMsg2("DBG: RTDirRelSymlinkRead(%s)...\n", szPath); rc = RTSymlinkRead(szPath, pszTarget, cbTarget, fRead); - } return rc; } diff --git a/src/VBox/Runtime/r3/stream.cpp b/src/VBox/Runtime/r3/stream.cpp index 930f2f28ca7..0bc788c9f93 100644 --- a/src/VBox/Runtime/r3/stream.cpp +++ b/src/VBox/Runtime/r3/stream.cpp @@ -641,27 +641,6 @@ static int rtStrmOpenComon(const char *pszFilename, RTFILE hFile, const char *ps } -/** - * Opens a file stream. - * - * @returns iprt status code. - * @param pszFilename Path to the file to open. - * @param pszMode The open mode. See fopen() standard. - * Format: <a|r|w>[+][b|t][x][e|N|E] - * - 'a': Open or create file and writes - * append tos it. - * - 'r': Open existing file and read from it. - * - 'w': Open or truncate existing file and write - * to it. - * - '+': Open for both read and write access. - * - 'b' / 't': binary / text - * - 'x': exclusively create, no open. Only - * possible with 'w'. - * - 'e' / 'N': No inherit on exec. (The 'e' is - * how Linux and FreeBSD expresses this, the - * latter is Visual C++). - * @param ppStream Where to store the opened stream. - */ RTR3DECL(int) RTStrmOpen(const char *pszFilename, const char *pszMode, PRTSTREAM *ppStream) { *ppStream = NULL; @@ -670,16 +649,6 @@ RTR3DECL(int) RTStrmOpen(const char *pszFilename, const char *pszMode, PRTSTREAM } -/** - * Opens a file stream. - * - * @returns iprt status code. - * @param pszMode The open mode. See fopen() standard. - * Format: <a|r|w>[+][b] - * @param ppStream Where to store the opened stream. - * @param pszFilenameFmt Filename path format string. - * @param args Arguments to the format string. - */ RTR3DECL(int) RTStrmOpenFV(const char *pszMode, PRTSTREAM *ppStream, const char *pszFilenameFmt, va_list args) { int rc; @@ -696,16 +665,6 @@ RTR3DECL(int) RTStrmOpenFV(const char *pszMode, PRTSTREAM *ppStream, const char } -/** - * Opens a file stream. - * - * @returns iprt status code. - * @param pszMode The open mode. See fopen() standard. - * Format: <a|r|w>[+][b] - * @param ppStream Where to store the opened stream. - * @param pszFilenameFmt Filename path format string. - * @param ... Arguments to the format string. - */ RTR3DECL(int) RTStrmOpenF(const char *pszMode, PRTSTREAM *ppStream, const char *pszFilenameFmt, ...) { va_list args; @@ -716,19 +675,6 @@ RTR3DECL(int) RTStrmOpenF(const char *pszMode, PRTSTREAM *ppStream, const char * } -/** - * Opens a file stream for a RTFILE handle, taking ownership of the handle. - * - * @returns iprt status code. - * @param hFile The file handle to use. On success, handle - * ownership is transfered to the stream and it will be - * closed when the stream closes. - * @param pszMode The open mode, accept the same as RTStrOpen and - * friends however it is only used to figure out what - * we can do with the handle. - * @param fFlags Reserved, must be zero. - * @param ppStream Where to store the opened stream. - */ RTR3DECL(int) RTStrmOpenFileHandle(RTFILE hFile, const char *pszMode, uint32_t fFlags, PRTSTREAM *ppStream) { *ppStream = NULL; @@ -738,12 +684,6 @@ RTR3DECL(int) RTStrmOpenFileHandle(RTFILE hFile, const char *pszMode, uint32_t f } -/** - * Closes the specified stream. - * - * @returns iprt status code. - * @param pStream The stream to close. - */ RTR3DECL(int) RTStrmClose(PRTSTREAM pStream) { /* @@ -814,12 +754,6 @@ RTR3DECL(int) RTStrmClose(PRTSTREAM pStream) } -/** - * Get the pending error of the stream. - * - * @returns iprt status code. of the stream. - * @param pStream The stream. - */ RTR3DECL(int) RTStrmError(PRTSTREAM pStream) { AssertPtrReturn(pStream, VERR_INVALID_POINTER); @@ -828,15 +762,6 @@ RTR3DECL(int) RTStrmError(PRTSTREAM pStream) } -/** - * Clears stream error condition. - * - * All stream operations save RTStrmClose and this will fail - * while an error is asserted on the stream - * - * @returns iprt status code. - * @param pStream The stream. - */ RTR3DECL(int) RTStrmClearError(PRTSTREAM pStream) { AssertPtrReturn(pStream, VERR_INVALID_POINTER); @@ -1673,18 +1598,6 @@ IPRT_COMPILER_TERM_CALLBACK(rtStrmFlushAndCloseAll); #endif /* RTSTREAM_STANDALONE */ -/** - * Rewinds the stream. - * - * Stream errors will be reset on success. - * - * @returns IPRT status code. - * - * @param pStream The stream. - * - * @remarks Not all streams are rewindable and that behavior is currently - * undefined for those. - */ RTR3DECL(int) RTStrmRewind(PRTSTREAM pStream) { AssertPtrReturn(pStream, VERR_INVALID_HANDLE); @@ -1711,18 +1624,6 @@ RTR3DECL(int) RTStrmRewind(PRTSTREAM pStream) } -/** - * Changes the file position. - * - * @returns IPRT status code. - * - * @param pStream The stream. - * @param off The seek offset. - * @param uMethod Seek method, i.e. one of the RTFILE_SEEK_* defines. - * - * @remarks Not all streams are seekable and that behavior is currently - * undefined for those. - */ RTR3DECL(int) RTStrmSeek(PRTSTREAM pStream, RTFOFF off, uint32_t uMethod) { AssertReturn(uMethod <= RTFILE_SEEK_END, VERR_INVALID_PARAMETER); @@ -1752,17 +1653,6 @@ RTR3DECL(int) RTStrmSeek(PRTSTREAM pStream, RTFOFF off, uint32_t uMethod) } -/** - * Tells the stream position. - * - * @returns Stream position or IPRT error status. Non-negative numbers are - * stream positions, while negative numbers are IPRT error stauses. - * - * @param pStream The stream. - * - * @remarks Not all streams have a position and that behavior is currently - * undefined for those. - */ RTR3DECL(RTFOFF) RTStrmTell(PRTSTREAM pStream) { #ifdef RTSTREAM_STANDALONE @@ -1849,17 +1739,6 @@ static void rtStreamRecheckMode(PRTSTREAM pStream) } -/** - * Reads from a file stream. - * - * @returns iprt status code. - * @param pStream The stream. - * @param pvBuf Where to put the read bits. - * Must be cbRead bytes or more. - * @param cbToRead Number of bytes to read. - * @param pcbRead Where to store the number of bytes actually read. - * If NULL cbRead bytes are read or an error is returned. - */ RTR3DECL(int) RTStrmReadEx(PRTSTREAM pStream, void *pvBuf, size_t cbToRead, size_t *pcbRead) { AssertPtrReturn(pStream, VERR_INVALID_HANDLE); @@ -2320,17 +2199,6 @@ DECLINLINE(int) rtStrmWrite(PRTSTREAM pStream, const void *pvBuf, size_t cbToWri } -/** - * Writes to a file stream. - * - * @returns iprt status code. - * @param pStream The stream. - * @param pvBuf Where to get the bits to write from. - * @param cbToWrite Number of bytes to write. - * @param pcbWritten Where to store the number of bytes actually written. - * If NULL cbToWrite bytes are written or an error is - * returned. - */ RTR3DECL(int) RTStrmWriteEx(PRTSTREAM pStream, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten) { AssertReturn(RT_VALID_PTR(pStream) && pStream->u32Magic == RTSTREAM_MAGIC, VERR_INVALID_PARAMETER); @@ -2338,13 +2206,6 @@ RTR3DECL(int) RTStrmWriteEx(PRTSTREAM pStream, const void *pvBuf, size_t cbToWri } -/** - * Reads a character from a file stream. - * - * @returns The char as an unsigned char cast to int. - * @returns -1 on failure. - * @param pStream The stream. - */ RTR3DECL(int) RTStrmGetCh(PRTSTREAM pStream) { unsigned char ch; @@ -2355,28 +2216,12 @@ RTR3DECL(int) RTStrmGetCh(PRTSTREAM pStream) } -/** - * Writes a character to a file stream. - * - * @returns iprt status code. - * @param pStream The stream. - * @param ch The char to write. - */ RTR3DECL(int) RTStrmPutCh(PRTSTREAM pStream, int ch) { return rtStrmWrite(pStream, &ch, 1, NULL, true /*fSureIsText*/); } -/** - * Writes a string to a file stream. - * - * @returns iprt status code. - * @param pStream The stream. - * @param pszString The string to write. - * No newlines or anything is appended or prepended. - * The terminating '\\0' is not written, of course. - */ RTR3DECL(int) RTStrmPutStr(PRTSTREAM pStream, const char *pszString) { size_t cch = strlen(pszString); @@ -2540,12 +2385,6 @@ RTR3DECL(int) RTStrmGetLine(PRTSTREAM pStream, char *pszString, size_t cbString) } -/** - * Flushes a stream. - * - * @returns iprt status code. - * @param pStream The stream to flush. - */ RTR3DECL(int) RTStrmFlush(PRTSTREAM pStream) { AssertPtrReturn(pStream, VERR_INVALID_HANDLE); @@ -2582,14 +2421,6 @@ static DECLCALLBACK(size_t) rtstrmOutput(void *pvArg, const char *pachChars, siz } -/** - * Prints a formatted string to the specified stream. - * - * @returns Number of bytes printed. - * @param pStream The stream to print to. - * @param pszFormat IPRT format string. - * @param args Arguments specified by pszFormat. - */ RTR3DECL(int) RTStrmPrintfV(PRTSTREAM pStream, const char *pszFormat, va_list args) { AssertReturn(RT_VALID_PTR(pStream) && pStream->u32Magic == RTSTREAM_MAGIC, VERR_INVALID_PARAMETER); @@ -2608,14 +2439,6 @@ RTR3DECL(int) RTStrmPrintfV(PRTSTREAM pStream, const char *pszFormat, va_list ar } -/** - * Prints a formatted string to the specified stream. - * - * @returns Number of bytes printed. - * @param pStream The stream to print to. - * @param pszFormat IPRT format string. - * @param ... Arguments specified by pszFormat. - */ RTR3DECL(int) RTStrmPrintf(PRTSTREAM pStream, const char *pszFormat, ...) { va_list args; @@ -2626,39 +2449,18 @@ RTR3DECL(int) RTStrmPrintf(PRTSTREAM pStream, const char *pszFormat, ...) } -/** - * Dumper vprintf-like function outputting to a stream. - * - * @param pvUser The stream to print to. NULL means standard output. - * @param pszFormat Runtime format string. - * @param va Arguments specified by pszFormat. - */ RTDECL(void) RTStrmDumpPrintfV(void *pvUser, const char *pszFormat, va_list va) { RTStrmPrintfV(pvUser ? (PRTSTREAM)pvUser : g_pStdOut, pszFormat, va); } -/** - * Prints a formatted string to the standard output stream (g_pStdOut). - * - * @returns Number of bytes printed. - * @param pszFormat IPRT format string. - * @param args Arguments specified by pszFormat. - */ RTR3DECL(int) RTPrintfV(const char *pszFormat, va_list args) { return RTStrmPrintfV(g_pStdOut, pszFormat, args); } -/** - * Prints a formatted string to the standard output stream (g_pStdOut). - * - * @returns Number of bytes printed. - * @param pszFormat IPRT format string. - * @param ... Arguments specified by pszFormat. - */ RTR3DECL(int) RTPrintf(const char *pszFormat, ...) { va_list args; diff --git a/src/VBox/Runtime/r3/tcp.cpp b/src/VBox/Runtime/r3/tcp.cpp index 24124a3a985..f74de0a0f45 100644 --- a/src/VBox/Runtime/r3/tcp.cpp +++ b/src/VBox/Runtime/r3/tcp.cpp @@ -214,24 +214,6 @@ static int rtTcpServerDestroySocket(RTSOCKET volatile *pSock, const char *pszMsg } -/** - * Create single connection at a time TCP Server in a separate thread. - * - * The thread will loop accepting connections and call pfnServe for - * each of the incoming connections in turn. The pfnServe function can - * return VERR_TCP_SERVER_STOP too terminate this loop. RTTcpServerDestroy() - * should be used to terminate the server. - * - * @returns iprt status code. - * @param pszAddress The address for creating a listening socket. - * If NULL or empty string the server is bound to all interfaces. - * @param uPort The port for creating a listening socket. - * @param enmType The thread type. - * @param pszThrdName The name of the worker thread. - * @param pfnServe The function which will serve a new client connection. - * @param pvUser User argument passed to pfnServe. - * @param ppServer Where to store the serverhandle. - */ RTR3DECL(int) RTTcpServerCreate(const char *pszAddress, unsigned uPort, RTTHREADTYPE enmType, const char *pszThrdName, PFNRTTCPSERVE pfnServe, void *pvUser, PPRTTCPSERVER ppServer) { @@ -301,16 +283,6 @@ static DECLCALLBACK(int) rtTcpServerThread(RTTHREAD ThreadSelf, void *pvServer) } -/** - * Create single connection at a time TCP Server. - * The caller must call RTTcpServerListen() to actually start the server. - * - * @returns iprt status code. - * @param pszAddress The address for creating a listening socket. - * If NULL the server is bound to all interfaces. - * @param uPort The port for creating a listening socket. - * @param ppServer Where to store the serverhandle. - */ RTR3DECL(int) RTTcpServerCreateEx(const char *pszAddress, uint32_t uPort, PPRTTCPSERVER ppServer) { /* @@ -378,22 +350,6 @@ RTR3DECL(int) RTTcpServerCreateEx(const char *pszAddress, uint32_t uPort, PPRTTC } -/** - * Listen for incoming connections. - * - * The function will loop accepting connections and call pfnServe for - * each of the incoming connections in turn. The pfnServe function can - * return VERR_TCP_SERVER_STOP too terminate this loop. A stopped server - * can only be destroyed. - * - * @returns IPRT status code. - * @retval VERR_TCP_SERVER_STOP if stopped by pfnServe. - * @retval VERR_TCP_SERVER_SHUTDOWN if shut down by RTTcpServerShutdown. - * - * @param pServer The server handle as returned from RTTcpServerCreateEx(). - * @param pfnServe The function which will serve a new client connection. - * @param pvUser User argument passed to pfnServe. - */ RTR3DECL(int) RTTcpServerListen(PRTTCPSERVER pServer, PFNRTTCPSERVE pfnServe, void *pvUser) { /* @@ -559,21 +515,6 @@ static int rtTcpServerListenCleanup(PRTTCPSERVER pServer) } -/** - * Listen and accept one incoming connection. - * - * This is an alternative to RTTcpServerListen for the use the callbacks are not - * possible. - * - * @returns IPRT status code. - * @retval VERR_TCP_SERVER_SHUTDOWN if shut down by RTTcpServerShutdown. - * @retval VERR_INTERRUPTED if the listening was interrupted. - * - * @param pServer The server handle as returned from RTTcpServerCreateEx(). - * @param phClientSocket Where to return the socket handle to the client - * connection (on success only). This must be closed - * by calling RTTcpServerDisconnectClient2(). - */ RTR3DECL(int) RTTcpServerListen2(PRTTCPSERVER pServer, PRTSOCKET phClientSocket) { /* @@ -655,12 +596,6 @@ RTR3DECL(int) RTTcpServerListen2(PRTTCPSERVER pServer, PRTSOCKET phClientSocket) } -/** - * Terminate the open connection to the server. - * - * @returns iprt status code. - * @param pServer Handle to the server. - */ RTR3DECL(int) RTTcpServerDisconnectClient(PRTTCPSERVER pServer) { /* @@ -677,26 +612,12 @@ RTR3DECL(int) RTTcpServerDisconnectClient(PRTTCPSERVER pServer) } -/** - * Terminates an open client connect when using RTTcpListen2 - * - * @returns IPRT status code. - * @param hClientSocket The client socket handle. This will be invalid upon - * return, whether successful or not. NIL is quietly - * ignored (VINF_SUCCESS). - */ RTR3DECL(int) RTTcpServerDisconnectClient2(RTSOCKET hClientSocket) { return rtTcpClose(hClientSocket, "RTTcpServerDisconnectClient2", true /*fTryGracefulShutdown*/); } -/** - * Shuts down the server, leaving client connections open. - * - * @returns IPRT status code. - * @param pServer Handle to the server. - */ RTR3DECL(int) RTTcpServerShutdown(PRTTCPSERVER pServer) { /* @@ -744,13 +665,6 @@ RTR3DECL(int) RTTcpServerShutdown(PRTTCPSERVER pServer) } -/** - * Closes down and frees a TCP Server. - * This will also terminate any open connections to the server. - * - * @returns iprt status code. - * @param pServer Handle to the server. - */ RTR3DECL(int) RTTcpServerDestroy(PRTTCPSERVER pServer) { /* @@ -1027,15 +941,6 @@ static int rtTcpClose(RTSOCKET Sock, const char *pszMsg, bool fTryGracefulShutdo } -/** - * Creates connected pair of TCP sockets. - * - * @returns IPRT status code. - * @param phServer Where to return the "server" side of the pair. - * @param phClient Where to return the "client" side of the pair. - * - * @note There is no server or client side, but we gotta call it something. - */ RTR3DECL(int) RTTcpCreatePair(PRTSOCKET phServer, PRTSOCKET phClient, uint32_t fFlags) { /* diff --git a/src/VBox/Runtime/r3/test.cpp b/src/VBox/Runtime/r3/test.cpp index 42b408787a9..798a7ef8ef7 100644 --- a/src/VBox/Runtime/r3/test.cpp +++ b/src/VBox/Runtime/r3/test.cpp @@ -485,12 +485,6 @@ RTR3DECL(RTEXITCODE) RTTestInitExAndCreate(int cArgs, char ***ppapszArgs, uint32 } -/** - * Destroys a test instance previously created by RTTestCreate. - * - * @returns IPRT status code. - * @param hTest The test handle. NIL_RTTEST is ignored. - */ RTR3DECL(int) RTTestDestroy(RTTEST hTest) { /* @@ -539,14 +533,6 @@ RTR3DECL(int) RTTestDestroy(RTTEST hTest) } -/** - * Changes the default test instance for the calling thread. - * - * @returns IPRT status code. - * - * @param hNewDefaultTest The new default test. NIL_RTTEST is fine. - * @param phOldTest Where to store the old test handle. Optional. - */ RTR3DECL(int) RTTestSetDefault(RTTEST hNewDefaultTest, PRTTEST phOldTest) { if (phOldTest) @@ -583,17 +569,6 @@ RTR3DECL(int) RTTestChangeName(RTTEST hTest, const char *pszName) } -/** - * Allocate a block of guarded memory. - * - * @returns IPRT status code. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param cb The amount of memory to allocate. - * @param cbAlign The alignment of the returned block. - * @param fHead Head or tail optimized guard. - * @param ppvUser Where to return the pointer to the block. - */ RTR3DECL(int) RTTestGuardedAlloc(RTTEST hTest, size_t cb, uint32_t cbAlign, bool fHead, void **ppvUser) { PRTTESTINT pTest = hTest; @@ -661,15 +636,6 @@ RTR3DECL(int) RTTestGuardedAlloc(RTTEST hTest, size_t cb, uint32_t cbAlign, bool } -/** - * Allocates a block of guarded memory where the guarded is immediately after - * the user memory. - * - * @returns Pointer to the allocated memory. NULL on failure. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param cb The amount of memory to allocate. - */ RTR3DECL(void *) RTTestGuardedAllocTail(RTTEST hTest, size_t cb) { void *pvUser; @@ -680,15 +646,6 @@ RTR3DECL(void *) RTTestGuardedAllocTail(RTTEST hTest, size_t cb) } -/** - * Allocates a block of guarded memory where the guarded is right in front of - * the user memory. - * - * @returns Pointer to the allocated memory. NULL on failure. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param cb The amount of memory to allocate. - */ RTR3DECL(void *) RTTestGuardedAllocHead(RTTEST hTest, size_t cb) { void *pvUser; @@ -716,14 +673,6 @@ static void rtTestGuardedFreeOne(PRTTESTGUARDEDMEM pMem) } -/** - * Frees a block of guarded memory. - * - * @returns IPRT status code. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pv The memory. NULL is ignored. - */ RTR3DECL(int) RTTestGuardedFree(RTTEST hTest, void *pv) { PRTTESTINT pTest = hTest; @@ -1100,16 +1049,6 @@ static int rtTestPrintf(PRTTESTINT pTest, const char *pszFormat, ...) } -/** - * Test vprintf making sure the output starts on a new line. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param enmLevel Message importance level. - * @param pszFormat The message. - * @param va Arguments. - */ RTR3DECL(int) RTTestPrintfNlV(RTTEST hTest, RTTESTLVL enmLevel, const char *pszFormat, va_list va) { PRTTESTINT pTest = hTest; @@ -1131,16 +1070,6 @@ RTR3DECL(int) RTTestPrintfNlV(RTTEST hTest, RTTESTLVL enmLevel, const char *pszF } -/** - * Test printf making sure the output starts on a new line. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param enmLevel Message importance level. - * @param pszFormat The message. - * @param ... Arguments. - */ RTR3DECL(int) RTTestPrintfNl(RTTEST hTest, RTTESTLVL enmLevel, const char *pszFormat, ...) { va_list va; @@ -1153,16 +1082,6 @@ RTR3DECL(int) RTTestPrintfNl(RTTEST hTest, RTTESTLVL enmLevel, const char *pszFo } -/** - * Test vprintf, makes sure lines are prefixed and so forth. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param enmLevel Message importance level. - * @param pszFormat The message. - * @param va Arguments. - */ RTR3DECL(int) RTTestPrintfV(RTTEST hTest, RTTESTLVL enmLevel, const char *pszFormat, va_list va) { PRTTESTINT pTest = hTest; @@ -1178,16 +1097,6 @@ RTR3DECL(int) RTTestPrintfV(RTTEST hTest, RTTESTLVL enmLevel, const char *pszFor } -/** - * Test printf, makes sure lines are prefixed and so forth. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param enmLevel Message importance level. - * @param pszFormat The message. - * @param ... Arguments. - */ RTR3DECL(int) RTTestPrintf(RTTEST hTest, RTTESTLVL enmLevel, const char *pszFormat, ...) { va_list va; @@ -1200,13 +1109,6 @@ RTR3DECL(int) RTTestPrintf(RTTEST hTest, RTTESTLVL enmLevel, const char *pszForm } -/** - * Prints the test banner. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - */ RTR3DECL(int) RTTestBanner(RTTEST hTest) { return RTTestPrintfNl(hTest, RTTESTLVL_ALWAYS, "TESTING...\n"); @@ -1281,13 +1183,6 @@ static int rtTestSubCleanup(PRTTESTINT pTest) } -/** - * Summaries the test, destroys the test instance and return an exit code. - * - * @returns Test program exit code. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - */ RTR3DECL(RTEXITCODE) RTTestSummaryAndDestroy(RTTEST hTest) { PRTTESTINT pTest = hTest; @@ -1352,17 +1247,6 @@ RTR3DECL(RTEXITCODE) RTTestSkipAndDestroy(RTTEST hTest, const char *pszReasonFmt } -/** - * Starts a sub-test. - * - * This will perform an implicit RTTestSubDone() call if that has not been done - * since the last RTTestSub call. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pszSubTest The sub-test name - */ RTR3DECL(int) RTTestSub(RTTEST hTest, const char *pszSubTest) { PRTTESTINT pTest = hTest; @@ -1401,17 +1285,6 @@ RTR3DECL(int) RTTestSub(RTTEST hTest, const char *pszSubTest) } -/** - * Format string version of RTTestSub. - * - * See RTTestSub for details. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pszSubTestFmt The sub-test name format string. - * @param ... Arguments. - */ RTR3DECL(int) RTTestSubF(RTTEST hTest, const char *pszSubTestFmt, ...) { va_list va; @@ -1422,17 +1295,6 @@ RTR3DECL(int) RTTestSubF(RTTEST hTest, const char *pszSubTestFmt, ...) } -/** - * Format string version of RTTestSub. - * - * See RTTestSub for details. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pszSubTestFmt The sub-test name format string. - * @param ... Arguments. - */ RTR3DECL(int) RTTestSubV(RTTEST hTest, const char *pszSubTestFmt, va_list va) { char *pszSubTest; @@ -1447,13 +1309,6 @@ RTR3DECL(int) RTTestSubV(RTTEST hTest, const char *pszSubTestFmt, va_list va) } -/** - * Completes a sub-test. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - */ RTR3DECL(int) RTTestSubDone(RTTEST hTest) { PRTTESTINT pTest = hTest; @@ -1466,18 +1321,7 @@ RTR3DECL(int) RTTestSubDone(RTTEST hTest) return cch; } -/** - * Prints an extended PASSED message, optional. - * - * This does not conclude the sub-test, it could be used to report the passing - * of a sub-sub-to-the-power-of-N-test. - * - * @returns IPRT status code. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pszFormat The message. No trailing newline. - * @param va The arguments. - */ + RTR3DECL(int) RTTestPassedV(RTTEST hTest, const char *pszFormat, va_list va) { PRTTESTINT pTest = hTest; @@ -1501,18 +1345,6 @@ RTR3DECL(int) RTTestPassedV(RTTEST hTest, const char *pszFormat, va_list va) } -/** - * Prints an extended PASSED message, optional. - * - * This does not conclude the sub-test, it could be used to report the passing - * of a sub-sub-to-the-power-of-N-test. - * - * @returns IPRT status code. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pszFormat The message. No trailing newline. - * @param ... The arguments. - */ RTR3DECL(int) RTTestPassed(RTTEST hTest, const char *pszFormat, ...) { va_list va; @@ -1672,13 +1504,6 @@ RTR3DECL(int) RTTestValueV(RTTEST hTest, uint64_t u64Value, RTTESTUNIT enmUnit, } -/** - * Increments the error counter. - * - * @returns IPRT status code. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - */ RTR3DECL(int) RTTestErrorInc(RTTEST hTest) { PRTTESTINT pTest = hTest; @@ -1690,14 +1515,6 @@ RTR3DECL(int) RTTestErrorInc(RTTEST hTest) } - -/** - * Get the current error count. - * - * @returns The error counter, UINT32_MAX if no valid test handle. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - */ RTR3DECL(uint32_t) RTTestErrorCount(RTTEST hTest) { PRTTESTINT pTest = hTest; @@ -1716,15 +1533,6 @@ RTR3DECL(uint32_t) RTTestSubErrorCount(RTTEST hTest) } -/** - * Increments the error counter and prints a failure message. - * - * @returns IPRT status code. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pszFormat The message. No trailing newline. - * @param va The arguments. - */ RTR3DECL(int) RTTestFailedV(RTTEST hTest, const char *pszFormat, va_list va) { PRTTESTINT pTest = hTest; @@ -1759,15 +1567,6 @@ RTR3DECL(int) RTTestFailedV(RTTEST hTest, const char *pszFormat, va_list va) } -/** - * Increments the error counter and prints a failure message. - * - * @returns IPRT status code. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pszFormat The message. No trailing newline. - * @param ... The arguments. - */ RTR3DECL(int) RTTestFailed(RTTEST hTest, const char *pszFormat, ...) { va_list va; @@ -1780,30 +1579,12 @@ RTR3DECL(int) RTTestFailed(RTTEST hTest, const char *pszFormat, ...) } -/** - * Same as RTTestPrintfV with RTTESTLVL_FAILURE. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pszFormat The message. - * @param va Arguments. - */ RTR3DECL(int) RTTestFailureDetailsV(RTTEST hTest, const char *pszFormat, va_list va) { return RTTestPrintfV(hTest, RTTESTLVL_FAILURE, pszFormat, va); } -/** - * Same as RTTestPrintf with RTTESTLVL_FAILURE. - * - * @returns Number of chars printed. - * @param hTest The test handle. If NIL_RTTEST we'll use the one - * associated with the calling thread. - * @param pszFormat The message. - * @param ... Arguments. - */ RTR3DECL(int) RTTestFailureDetails(RTTEST hTest, const char *pszFormat, ...) { va_list va; diff --git a/src/VBox/Runtime/r3/udp.cpp b/src/VBox/Runtime/r3/udp.cpp index 048e9008a31..44852c7379e 100644 --- a/src/VBox/Runtime/r3/udp.cpp +++ b/src/VBox/Runtime/r3/udp.cpp @@ -184,24 +184,6 @@ static int rtUdpServerDestroySocket(RTSOCKET volatile *pSock, const char *pszMsg } -/** - * Create single datagram at a time UDP Server in a separate thread. - * - * The thread will loop waiting for datagrams and call pfnServe for - * each of the incoming datagrams in turn. The pfnServe function can - * return VERR_UDP_SERVER_STOP too terminate this loop. RTUdpServerDestroy() - * should be used to terminate the server. - * - * @returns iprt status code. - * @param pszAddress The address for creating a datagram socket. - * If NULL or empty string the server is bound to all interfaces. - * @param uPort The port for creating a datagram socket. - * @param enmType The thread type. - * @param pszThrdName The name of the worker thread. - * @param pfnServe The function which will handle incoming datagrams. - * @param pvUser User argument passed to pfnServe. - * @param ppServer Where to store the serverhandle. - */ RTR3DECL(int) RTUdpServerCreate(const char *pszAddress, unsigned uPort, RTTHREADTYPE enmType, const char *pszThrdName, PFNRTUDPSERVE pfnServe, void *pvUser, PPRTUDPSERVER ppServer) { @@ -271,16 +253,6 @@ static DECLCALLBACK(int) rtUdpServerThread(RTTHREAD ThreadSelf, void *pvServer) } -/** - * Create single datagram at a time UDP Server. - * The caller must call RTUdpServerReceive() to actually start the server. - * - * @returns iprt status code. - * @param pszAddress The address for creating a datagram socket. - * If NULL the server is bound to all interfaces. - * @param uPort The port for creating a datagram socket. - * @param ppServer Where to store the serverhandle. - */ RTR3DECL(int) RTUdpServerCreateEx(const char *pszAddress, uint32_t uPort, PPRTUDPSERVER ppServer) { @@ -346,22 +318,6 @@ RTR3DECL(int) RTUdpServerCreateEx(const char *pszAddress, uint32_t uPort, PPRTUD } -/** - * Listen for incoming datagrams. - * - * The function will loop waiting for datagrams and call pfnServe for - * each of the incoming datagrams in turn. The pfnServe function can - * return VERR_UDP_SERVER_STOP too terminate this loop. A stopped server - * can only be destroyed. - * - * @returns IPRT status code. - * @retval VERR_UDP_SERVER_STOP if stopped by pfnServe. - * @retval VERR_UDP_SERVER_SHUTDOWN if shut down by RTUdpServerShutdown. - * - * @param pServer The server handle as returned from RTUdpServerCreateEx(). - * @param pfnServe The function which will handle incoming datagrams. - * @param pvUser User argument passed to pfnServe. - */ RTR3DECL(int) RTUdpServerListen(PRTUDPSERVER pServer, PFNRTUDPSERVE pfnServe, void *pvUser) { /* @@ -515,12 +471,6 @@ static int rtUdpServerListenCleanup(PRTUDPSERVER pServer) } -/** - * Shuts down the server. - * - * @returns IPRT status code. - * @param pServer Handle to the server. - */ RTR3DECL(int) RTUdpServerShutdown(PRTUDPSERVER pServer) { /* @@ -568,12 +518,6 @@ RTR3DECL(int) RTUdpServerShutdown(PRTUDPSERVER pServer) } -/** - * Closes down and frees a UDP Server. - * - * @returns iprt status code. - * @param pServer Handle to the server. - */ RTR3DECL(int) RTUdpServerDestroy(PRTUDPSERVER pServer) { /* diff --git a/src/VBox/Runtime/r3/win/localipc-win.cpp b/src/VBox/Runtime/r3/win/localipc-win.cpp index f2e011e6529..2685f791d85 100644 --- a/src/VBox/Runtime/r3/win/localipc-win.cpp +++ b/src/VBox/Runtime/r3/win/localipc-win.cpp @@ -566,7 +566,6 @@ RTDECL(int) RTLocalIpcServerCreate(PRTLOCALIPCSERVER phServer, const char *pszNa /** * Retains a reference to the server instance. * - * @returns * @param pThis The server instance. */ DECLINLINE(void) rtLocalIpcServerRetain(PRTLOCALIPCSERVERINT pThis) diff --git a/src/VBox/Runtime/r3/win/path-win.cpp b/src/VBox/Runtime/r3/win/path-win.cpp index 0ec7d4921a7..ec83a846718 100644 --- a/src/VBox/Runtime/r3/win/path-win.cpp +++ b/src/VBox/Runtime/r3/win/path-win.cpp @@ -60,14 +60,7 @@ typedef HRESULT WINAPI FNSHGETFOLDERPATHW(HWND, int, HANDLE, DWORD, LPWSTR); typedef FNSHGETFOLDERPATHW *PFNSHGETFOLDERPATHW; -/** - * Get the real (no symlinks, no . or .. components) path, must exist. - * - * @returns iprt status code. - * @param pszPath The path to resolve. - * @param pszRealPath Where to store the real path. - * @param cchRealPath Size of the buffer. - */ + RTDECL(int) RTPathReal(const char *pszPath, char *pszRealPath, size_t cchRealPath) { /* @@ -100,14 +93,6 @@ RTDECL(int) RTPathReal(const char *pszPath, char *pszRealPath, size_t cchRealPat } #if 0 -/** - * Get the absolute path (no symlinks, no . or .. components), doesn't have to exit. - * - * @returns iprt status code. - * @param pszPath The path to resolve. - * @param pszAbsPath Where to store the absolute path. - * @param cchAbsPath Size of the buffer. - */ RTDECL(int) RTPathAbs(const char *pszPath, char *pszAbsPath, size_t cchAbsPath) { /* @@ -159,13 +144,6 @@ RTDECL(int) RTPathAbs(const char *pszPath, char *pszAbsPath, size_t cchAbsPath) #endif -/** - * Gets the user home directory. - * - * @returns iprt status code. - * @param pszPath Buffer where to store the path. - * @param cchPath Buffer size in bytes. - */ RTDECL(int) RTPathUserHome(char *pszPath, size_t cchPath) { /* diff --git a/src/VBox/Runtime/r3/xml.cpp b/src/VBox/Runtime/r3/xml.cpp index 9633aec25e9..7c92d7b8e9f 100644 --- a/src/VBox/Runtime/r3/xml.cpp +++ b/src/VBox/Runtime/r3/xml.cpp @@ -750,13 +750,6 @@ ElementNode::~ElementNode() } -/** - * Gets the next tree element in a full tree enumeration. - * - * @returns Pointer to the next element in the tree, NULL if we're done. - * @param pElmRoot The root of the tree we're enumerating. NULL if - * it's the entire tree. - */ ElementNode const *ElementNode::getNextTreeElement(ElementNode const *pElmRoot /*= NULL */) const { /* |