Diff: platform/DirHandle.h

Revision:

167:84c0a372a020

Parent:

158:1c57384330a6

Child:

170:e95d10626187

--- a/platform/DirHandle.h	Fri Apr 20 11:08:29 2018 +0100
+++ b/platform/DirHandle.h	Fri May 11 16:51:14 2018 +0100
@@ -105,6 +105,7 @@
      *  @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(); };
@@ -116,6 +117,7 @@
      *  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()
@@ -125,6 +127,7 @@
     }
 
     /** 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(); }
@@ -134,6 +137,7 @@
      * @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(); }
@@ -141,6 +145,7 @@
     /** 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); }