diff options
Diffstat (limited to 'src/VBox/Runtime/r3')
-rw-r--r-- | src/VBox/Runtime/r3/fileio.cpp | 7 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/ftp-server.cpp | 2 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/generic/dirrel-r3-generic.cpp | 195 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/nt/dirrel-r3-nt.cpp | 131 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/stream.cpp | 198 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/tcp.cpp | 95 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/test.cpp | 221 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/udp.cpp | 56 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/win/localipc-win.cpp | 1 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/win/path-win.cpp | 24 | ||||
-rw-r--r-- | src/VBox/Runtime/r3/xml.cpp | 7 |
11 files changed, 2 insertions, 935 deletions
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 { /* |