ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #6510 from yossi2le/add-deprecated-doxygen-remarks 

Adding missing @deprecated to function inline documentation
pull/6538/merge
Cruz Monrreal 2018-04-17 10:53:54 -05:00 committed by GitHub
parent 7489401044 8684a63732
commit 7dabd247ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
platform/DirHandle.h
View File

@ -105,6 +105,7 @@ public:
* @returns * @returns
* 0 on success, * 0 on success,
* -1 on error. * -1 on error.
* @deprecated Replaced by `int DirHandle::close()'
*/ */
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::close") MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::close")
virtual int closedir() { return close(); }; virtual int closedir() { return close(); };
@ -116,6 +117,7 @@ public:
* A pointer to a dirent structure representing the * A pointer to a dirent structure representing the
* directory entry at the current position, or NULL on reaching * directory entry at the current position, or NULL on reaching
* end of directory or error. * end of directory or error.
* @deprecated Replaced by `ssize_t DirHandle::read(struct dirent *ent)
*/ */
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::read") MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::read")
virtual struct dirent *readdir() virtual struct dirent *readdir()
@ -125,6 +127,7 @@ public:
} }
/** Resets the position to the beginning of the directory. /** Resets the position to the beginning of the directory.
* @deprecated Replaced by `void DirHandle::rewind()'
*/ */
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::rewind") MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::rewind")
virtual void rewinddir() { rewind(); } virtual void rewinddir() { rewind(); }
@ -134,6 +137,7 @@ public:
* @returns * @returns
* the current position, * the current position,
* -1 on error. * -1 on error.
* @deprecated Replaced by `off_t DirHandle::tell()'
*/ */
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::tell") MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::tell")
virtual off_t telldir() { return tell(); } virtual off_t telldir() { return tell(); }
@ -141,6 +145,7 @@ public:
/** Sets the position of the DirHandle. /** Sets the position of the DirHandle.
* *
* @param location The location to seek to. Must be a value returned by telldir. * @param location The location to seek to. Must be a value returned by telldir.
* @deprecated Replaced by `void DirHandle::seek(off_t offset)'
*/ */
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::seek") MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::seek")
virtual void seekdir(off_t location) { seek(location); } virtual void seekdir(off_t location) { seek(location); }

4
platform/FileHandle.h
View File

@ -146,6 +146,8 @@ public:
* @returns * @returns
* new file position on success, * new file position on success,
* -1 on failure or unsupported * -1 on failure or unsupported
* @deprecated Replaced by `off_t FileHandle::seek(off_t offset, int whence = SEEK_SET)'
*
*/ */
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::seek") MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::seek")
virtual off_t lseek(off_t offset, int whence) virtual off_t lseek(off_t offset, int whence)
@ -159,6 +161,7 @@ public:
* @returns * @returns
* 0 on success or un-needed, * 0 on success or un-needed,
* -1 on error * -1 on error
* @deprecated Replaced by `int FileHandle::sync()'
*/ */
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::sync") MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::sync")
virtual int fsync() virtual int fsync()
@ -170,6 +173,7 @@ public:
* *
* @returns * @returns
* Length of the file * Length of the file
* @deprecated Replaced by `off_t FileHandle::size()'
*/ */
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::size") MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::size")
virtual off_t flen() virtual off_t flen()