Skip to content

Commit 57b4653

Browse files
Yossi LevyYossi Levy
authored andcommitted
Adding @deprecated functions to the inline documentation of deprecated functions
1 parent f895392 commit 57b4653

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

platform/DirHandle.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ class DirHandle : private NonCopyable<DirHandle> {
105105
* @returns
106106
* 0 on success,
107107
* -1 on error.
108+
* @deprecated Replaced by `DirHandle::close'
108109
*/
109110
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::close")
110111
virtual int closedir() { return close(); };
@@ -116,6 +117,7 @@ class DirHandle : private NonCopyable<DirHandle> {
116117
* A pointer to a dirent structure representing the
117118
* directory entry at the current position, or NULL on reaching
118119
* end of directory or error.
120+
* @deprecated Replaced by `DirHandle::read'
119121
*/
120122
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::read")
121123
virtual struct dirent *readdir()
@@ -125,6 +127,7 @@ class DirHandle : private NonCopyable<DirHandle> {
125127
}
126128

127129
/** Resets the position to the beginning of the directory.
130+
* @deprecated Replaced by `DirHandle::rewind'
128131
*/
129132
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::rewind")
130133
virtual void rewinddir() { rewind(); }
@@ -134,13 +137,15 @@ class DirHandle : private NonCopyable<DirHandle> {
134137
* @returns
135138
* the current position,
136139
* -1 on error.
140+
* @deprecated Replaced by `DirHandle::tell'
137141
*/
138142
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::tell")
139143
virtual off_t telldir() { return tell(); }
140144

141145
/** Sets the position of the DirHandle.
142146
*
143147
* @param location The location to seek to. Must be a value returned by telldir.
148+
* @deprecated Replaced by `DirHandle::seek'
144149
*/
145150
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::seek")
146151
virtual void seekdir(off_t location) { seek(location); }

platform/FileHandle.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,8 @@ class FileHandle : private NonCopyable<FileHandle> {
146146
* @returns
147147
* new file position on success,
148148
* -1 on failure or unsupported
149+
* @deprecated Replaced by `FileHandle::seek'
150+
*
149151
*/
150152
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::seek")
151153
virtual off_t lseek(off_t offset, int whence)
@@ -159,6 +161,7 @@ class FileHandle : private NonCopyable<FileHandle> {
159161
* @returns
160162
* 0 on success or un-needed,
161163
* -1 on error
164+
* @deprecated Replaced by `FileHandle::sync'
162165
*/
163166
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::sync")
164167
virtual int fsync()
@@ -170,6 +173,7 @@ class FileHandle : private NonCopyable<FileHandle> {
170173
*
171174
* @returns
172175
* Length of the file
176+
* @deprecated Replaced by `FileHandle::size'
173177
*/
174178
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::size")
175179
virtual off_t flen()

0 commit comments

Comments
 (0)