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

Adding missing @deprecated to function inline documentation

Author: Cruz Monrreal

platform/DirHandle.h

@@ -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(); };
@@ -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()
@@ -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(); }
@@ -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); }

platform/FileHandle.h

@@ -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)
@@ -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()
@@ -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()