From ef52a3d48fc3b96759cb4e2f9128166aaaffe2a2 Mon Sep 17 00:00:00 2001 From: brjhaiku Date: Fri, 31 May 2019 04:26:54 +0530 Subject: [PATCH] btrfs: document DirectoryIterator class (no functional change) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Iffbd7112a9a266b65d6dd56dbd040f04e5ab58b2 Reviewed-on: https://review.haiku-os.org/c/1493 Reviewed-by: Jérôme Duval --- .../kernel/file_systems/btrfs/DirectoryIterator.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/add-ons/kernel/file_systems/btrfs/DirectoryIterator.h b/src/add-ons/kernel/file_systems/btrfs/DirectoryIterator.h index 6c018199a2..1158c92b57 100644 --- a/src/add-ons/kernel/file_systems/btrfs/DirectoryIterator.h +++ b/src/add-ons/kernel/file_systems/btrfs/DirectoryIterator.h @@ -11,6 +11,7 @@ #include "Inode.h" +//! Class used to iterate through entries in a directory class DirectoryIterator { public: DirectoryIterator(Inode* inode); @@ -18,8 +19,19 @@ public: status_t InitCheck(); + /*! Get details of next entry + * \param name Location to copy name of next entry + * \param _nameLength Location to copy length of next entry's name + * \param _id Location to copy inode number of next entry + */ status_t GetNext(char* name, size_t* _nameLength, ino_t* _id); + /*! Search for item in current directory + * \param name Name of entry to lookup + * \param nameLength Length of name being searched + * \param _id inode value of entry if found, ??? otherwise + */ status_t Lookup(const char* name, size_t nameLength, ino_t* _id); + //! Reset iterator to beginning status_t Rewind(); private: uint64 fOffset;