Skip to content

Adding missing @deprecated to function inline documentation #6510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 17, 2018
Merged

Adding missing @deprecated to function inline documentation #6510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57b4653
Adding @deprecated functions to the inline documentation of deprecate…
Mar 29, 2018
8684a63
Fix Travis CI docs issues
Apr 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions platform/DirHandle.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ class DirHandle : private NonCopyable<DirHandle> {
* @returns
* 0 on success,
* -1 on error.
* @deprecated Replaced by `int DirHandle::close()'
*/
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::close")
virtual int closedir() { return close(); };
Expand All @@ -116,6 +117,7 @@ class DirHandle : private NonCopyable<DirHandle> {
* A pointer to a dirent structure representing the
* directory entry at the current position, or NULL on reaching
* 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")
virtual struct dirent *readdir()
Expand All @@ -125,6 +127,7 @@ class DirHandle : private NonCopyable<DirHandle> {
}

/** 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")
virtual void rewinddir() { rewind(); }
Expand All @@ -134,13 +137,15 @@ class DirHandle : private NonCopyable<DirHandle> {
* @returns
* the current position,
* -1 on error.
* @deprecated Replaced by `off_t DirHandle::tell()'
*/
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::tell")
virtual off_t telldir() { return tell(); }

/** Sets the position of the DirHandle.
*
* @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")
virtual void seekdir(off_t location) { seek(location); }
Expand Down
4 changes: 4 additions & 0 deletions platform/FileHandle.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ class FileHandle : private NonCopyable<FileHandle> {
* @returns
* new file position on success,
* -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")
virtual off_t lseek(off_t offset, int whence)
Expand All @@ -159,6 +161,7 @@ class FileHandle : private NonCopyable<FileHandle> {
* @returns
* 0 on success or un-needed,
* -1 on error
* @deprecated Replaced by `int FileHandle::sync()'
*/
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::sync")
virtual int fsync()
Expand All @@ -170,6 +173,7 @@ class FileHandle : private NonCopyable<FileHandle> {
*
* @returns
* Length of the file
* @deprecated Replaced by `off_t FileHandle::size()'
*/
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::size")
virtual off_t flen()
Expand Down