Skip to content

Commit 8684a63

Browse files
Yossi LevyYossi Levy
authored andcommitted
Fix Travis CI docs issues
1 parent 57b4653 commit 8684a63

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

platform/DirHandle.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ class DirHandle : private NonCopyable<DirHandle> {
105105
* @returns
106106
* 0 on success,
107107
* -1 on error.
108-
* @deprecated Replaced by `DirHandle::close'
108+
* @deprecated Replaced by `int DirHandle::close()'
109109
*/
110110
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::close")
111111
virtual int closedir() { return close(); };
@@ -117,7 +117,7 @@ class DirHandle : private NonCopyable<DirHandle> {
117117
* A pointer to a dirent structure representing the
118118
* directory entry at the current position, or NULL on reaching
119119
* end of directory or error.
120-
* @deprecated Replaced by `DirHandle::read'
120+
* @deprecated Replaced by `ssize_t DirHandle::read(struct dirent *ent)
121121
*/
122122
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::read")
123123
virtual struct dirent *readdir()
@@ -127,7 +127,7 @@ class DirHandle : private NonCopyable<DirHandle> {
127127
}
128128

129129
/** Resets the position to the beginning of the directory.
130-
* @deprecated Replaced by `DirHandle::rewind'
130+
* @deprecated Replaced by `void DirHandle::rewind()'
131131
*/
132132
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::rewind")
133133
virtual void rewinddir() { rewind(); }
@@ -137,15 +137,15 @@ class DirHandle : private NonCopyable<DirHandle> {
137137
* @returns
138138
* the current position,
139139
* -1 on error.
140-
* @deprecated Replaced by `DirHandle::tell'
140+
* @deprecated Replaced by `off_t DirHandle::tell()'
141141
*/
142142
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::tell")
143143
virtual off_t telldir() { return tell(); }
144144

145145
/** Sets the position of the DirHandle.
146146
*
147147
* @param location The location to seek to. Must be a value returned by telldir.
148-
* @deprecated Replaced by `DirHandle::seek'
148+
* @deprecated Replaced by `void DirHandle::seek(off_t offset)'
149149
*/
150150
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by DirHandle::seek")
151151
virtual void seekdir(off_t location) { seek(location); }

platform/FileHandle.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ 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'
149+
* @deprecated Replaced by `off_t FileHandle::seek(off_t offset, int whence = SEEK_SET)'
150150
*
151151
*/
152152
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::seek")
@@ -161,7 +161,7 @@ class FileHandle : private NonCopyable<FileHandle> {
161161
* @returns
162162
* 0 on success or un-needed,
163163
* -1 on error
164-
* @deprecated Replaced by `FileHandle::sync'
164+
* @deprecated Replaced by `int FileHandle::sync()'
165165
*/
166166
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::sync")
167167
virtual int fsync()
@@ -173,7 +173,7 @@ class FileHandle : private NonCopyable<FileHandle> {
173173
*
174174
* @returns
175175
* Length of the file
176-
* @deprecated Replaced by `FileHandle::size'
176+
* @deprecated Replaced by `off_t FileHandle::size()'
177177
*/
178178
MBED_DEPRECATED_SINCE("mbed-os-5.4", "Replaced by FileHandle::size")
179179
virtual off_t flen()

0 commit comments

Comments
 (0)