Move the doxygen documentation comments from src/kits/storage/Directory.cpp to docs/user/storage/Directory.dox and update it both the language, fix a few errors, and bring the syntax up to snuff. The documentation for the BDirectory class is now added to the Haiku Book.

2011-12-18 18:53:46 -05:00 · 2011-12-18 18:53:46 -05:00 · 2ac1eb67b3
commit 2ac1eb67b3
parent 730714fea5
2 changed files with 601 additions and 390 deletions
--- a/docs/user/storage/Directory.dox
+++ b/docs/user/storage/Directory.dox
@ -0,0 +1,600 @@
+/*
+ * Copyright 2011 Haiku Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ *		Tyler Dauwalder
+ *		Ingo Weinhold, bonefish@users.sf.net
+ *		Axel Dörfler, axeld@pinc-software.de
+ *		John Scipione, jscipione@gmail.com
+ * Corresponds to:
+ *		headers/os/storage/Directory.h  hrev43528
+ *		src/kits/storage/Directory.cpp  hrev43528
+ */
+
+
+/*!
+	\file Directory.h
+	\brief Provides the BDirectory class.
+*/
+
+
+/*!
+	\class BDirectory
+	\ingroup storage
+	\ingroup libbe
+	\brief Class that represents a directory in the file system.
+*/
+
+
+/*!
+	\fn BDirectory::BDirectory()
+	\brief Creates an uninitialized BDirectory object.
+*/
+
+
+/*!
+	\fn BDirectory::BDirectory(const BDirectory& dir)
+	\brief Creates a copy of the supplied BDirectory object.
+
+	\param dir The BDirectory object to be copied.
+*/
+
+
+/*!
+	\fn BDirectory::BDirectory(const entry_ref* ref)
+	\brief Creates a BDirectory and initializes it to the directory referred
+		to by the supplied entry_ref.
+
+	\param ref The entry_ref that refers to the directory.
+*/
+
+
+/*!
+	\fn BDirectory::BDirectory(const node_ref* nref)
+	\brief Creates a BDirectory and initializes it to the directory referred
+		to by the supplied node_ref.
+
+	\param nref The node_ref that refers to the directory.
+*/
+
+
+/*!
+	\fn BDirectory::BDirectory(const BEntry* entry)
+	\brief Creates a BDirectory and initializes it to the directory referred
+		to by the supplied BEntry.
+
+	\param entry The BEntry that refers to the directory.
+*/
+
+
+/*!
+	\fn BDirectory::BDirectory(const char* path)
+	\brief Creates a BDirectory and initializes it to the directory referred
+		to by the supplied \a path name.
+
+	\param path The \a path name of the directory.
+*/
+
+
+/*!
+	\fn BDirectory::BDirectory(const BDirectory* dir, const char* path)
+	\brief Creates a BDirectory and initializes it to the directory referred
+		to by the supplied path name relative to the specified BDirectory.
+
+	\param dir The base BDirectory object.
+	\param path The \a path of the directory relative to \a dir
+*/
+
+
+/*!
+	\fn BDirectory::~BDirectory()
+	\brief Destroys the BDirectory object.
+
+	If the BDirectory is properly initialized, the directory's file descriptor
+	is closed.
+*/
+
+
+/*!
+	\fn status_t BDirectory::SetTo(const entry_ref* ref)
+	\brief Re-initializes the BDirectory to the directory referred to by the
+		supplied entry_ref.
+
+	\param ref The entry_ref referring to the directory.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a ref.
+	\retval B_ENTRY_NOT_FOUND Directory not found.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn status_t BDirectory::SetTo(const node_ref* nref)
+	\brief Re-initializes the BDirectory to the directory referred to by the
+		supplied node_ref.
+
+	\param nref The node_ref referring to the directory.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a nref.
+	\retval B_ENTRY_NOT_FOUND Directory not found.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn status_t BDirectory::SetTo(const BEntry* entry)
+	\brief Re-initializes the BDirectory to the directory referred to by the
+		supplied BEntry.
+
+	\param entry The BEntry referring to the directory.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a entry.
+	\retval B_ENTRY_NOT_FOUND Directory not found.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn status_t BDirectory::SetTo(const char* path)
+	\brief Re-initializes the BDirectory to the directory referred to by the
+		supplied path name.
+
+	\param path The directory's \a path name.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a path.
+	\retval B_ENTRY_NOT_FOUND Directory not found.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_NAME_TOO_LONG The supplied path name (\a path) is too long.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+	\retval B_NOT_A_DIRECTORY \a path includes a non-directory.
+*/
+
+
+/*!
+	\fn status_t BDirectory::SetTo(const BDirectory* dir, const char* path)
+	\brief Re-initializes the BDirectory to the directory referred to by the
+		supplied path name relative to the specified BDirectory.
+
+	\param dir The base directory.
+	\param path The directory path name relative to \a dir.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a dir or \a path, or \a path is absolute.
+	\retval B_ENTRY_NOT_FOUND Directory not found.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_NAME_TOO_LONG The supplied path name (\a path) is too long.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+	\retval B_NOT_A_DIRECTORY \a path includes a non-directory.
+*/
+
+
+/*!
+	\fn status_t BDirectory::GetEntry(BEntry* entry) const
+	\brief Gets a BEntry object referring to the directory. If the
+		initialization of \a entry fails, it is Unset().
+
+	\param entry A pointer to the \a entry that will refer to the directory.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a entry.
+	\retval B_ENTRY_NOT_FOUND Directory not found.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn bool BDirectory::IsRootDirectory() const
+	\brief Returns whether the directory is the root directory of a volume.
+
+	\returns \c true if the BDirectory is properly initialized and represents
+		a root directory of a volume, \c false otherwise.
+*/
+
+
+/*!
+	\fn status_t BDirectory::FindEntry(const char* path, BEntry* entry,
+		bool traverse) const
+	\brief Finds an entry referred to by a path relative to the directory
+		represented by this BDirectory.
+
+	\a path may represent an absolute path. If the BDirectory is not properly
+	initialized then the entry is relative to the current directory. If the
+	entry couldn't be found, \a entry is Unset().
+
+	\note The functionality of this method differs from
+		BEntry::SetTo(BDirectory *, const char *, bool) in that it doesn't
+		require the entry to exist, whereas this method does.
+
+	\param path The entry's \a path name. May be relative to this directory
+		or an absolute path.
+	\param entry A pointer to a BEntry to be initialized with the found entry.
+	\param traverse Whether or not to follow a symbolic link.
+
+	\returns A status code.
+	\retval B_OK: Everything went fine.
+	\retval B_BAD_VALUE: \c NULL \a path or \a entry.
+	\retval B_ENTRY_NOT_FOUND: Entry not found.
+	\retval B_PERMISSION_DENIED: Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY: Insufficient memory for operation.
+	\retval B_NAME_TOO_LONG: The supplied path name (\a path) is too long.
+	\retval B_LINK_LIMIT: Indicates a cyclic loop within the file system.
+	\retval B_BUSY: A node was busy.
+	\retval B_FILE_ERROR: A general file error.
+	\retval B_NO_MORE_FDS: The application has run out of file descriptors.
+	\retval B_NOT_A_DIRECTORY: \a path includes a non-directory.
+
+	\sa BEntry::SetTo(BDirectory *, const char *, bool)
+*/
+
+
+/*!
+	\fn bool BDirectory::Contains(const char* path, int32 nodeFlags) const
+	\brief Returns whether or not this directory or any of its subdirectories
+		at any level contain the entry referred to by the supplied path name.
+
+	Only entries that match the node flavor specified by \a nodeFlags are
+	considered.
+
+	If the BDirectory is not properly initialized, the method returns \c false.
+	A non-absolute path is considered relative to the current directory.
+
+	\note R5's implementation always returns \c true given an absolute path
+		or an unitialized directory. This implementation is not compatible
+		with that behavior. Instead it converts the path into a BEntry and
+		passes it to the other version of Contains().
+
+	\param path The entry's \a path name. May be relative to this directory
+		or may be an absolute \a path.
+	\param nodeFlags Any of the following:
+		- \c B_FILE_NODE: The entry must be a file.
+		- \c B_DIRECTORY_NODE: The entry must be a directory.
+		- \c B_SYMLINK_NODE: The entry must be a symbolic link.
+		- \c B_ANY_NODE: The entry may be of any kind.
+
+	\returns \c true if the entry exists and its kind does match \a nodeFlags
+		and the BDirectory is properly initialized and does contain the entry
+		at any level, \c false otherwise.
+*/
+
+
+/*!
+	\fn bool BDirectory::Contains(const BEntry* entry, int32 nodeFlags) const
+	\brief Returns whether or not this directory or any of its subdirectories
+		at any level contain the entry referred to by the supplied BEntry.
+	
+	Only entries that match the node flavor specified by \a nodeFlags are
+	considered.
+
+	\note If the paths are identical, this method returns \c true to stay
+		consistent with BeOS 5.
+
+	\param entry a BEntry referring to the entry
+	\param nodeFlags Any of the following:
+		- \c B_FILE_NODE: The entry must be a file.
+		- \c B_DIRECTORY_NODE: The entry must be a directory.
+		- \c B_SYMLINK_NODE: The entry must be a symbolic link.
+		- \c B_ANY_NODE: The entry may be of any kind.
+
+	\returns \c true if the BDirectory is properly initialized and the
+		entry of the matching kind was found, \c false otherwise.
+*/
+
+
+/*!
+	\fn status_t BDirectory::GetStatFor(const char* path, struct stat* st) const
+	\brief Returns the stat structure of the entry referred to by the supplied
+		path name.
+
+	\param path The entry's path name. May be relative to this directory or
+		   absolute, or \c NULL to get the directories stat info.
+	\param st A pointer to the stat structure to be filled in by this method.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a st.
+	\retval B_ENTRY_NOT_FOUND Entry not found.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_NAME_TOO_LONG The supplied path name (\a path) is too long.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+	\retval B_NOT_A_DIRECTORY \a path includes a non-directory.
+*/
+
+
+/*!
+	\fn status_t BDirectory::GetNextEntry(BEntry* entry, bool traverse)
+	\brief Returns the next entry as a BEntry object.
+
+	Unlike GetNextDirents() this method ignores "." and "..".
+
+	\note The iterator used by this method is the same one used by
+		GetNextRef(), GetNextDirents(), Rewind() and CountEntries().
+
+	\param entry A pointer to a BEntry to be initialized to the found entry
+	\param traverse Specifies whether or not to follow a symbolic link.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a entry.
+	\retval B_ENTRY_NOT_FOUND No more entries found.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn status_t BDirectory::GetNextRef(entry_ref* ref)
+	\brief Returns the BDirectory's next entry as an entry_ref.
+
+	Unlike GetNextDirents() this method ignores "." and "..".
+
+	\note The iterator used be this method is the same one used by
+		GetNextEntry(), GetNextDirents(), Rewind() and CountEntries().
+
+	\param ref A pointer to an entry_ref to be filled in with the data
+		from the found entry.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a ref.
+	\retval B_ENTRY_NOT_FOUND No more entries found.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn int32 BDirectory::GetNextDirents(dirent* buf, size_t bufSize, int32 count)
+	\brief Returns the next entries of the BDirectory object as a pointer
+		to dirent structures.
+
+	Unlike GetNextEntry() and GetNextRef(), this method returns also
+	the entries "." and "..".
+
+	\note The iterator used by this method is the same one used by
+		GetNextEntry(), GetNextRef(), Rewind() and CountEntries().
+
+	\param buf A pointer to a buffer filled with dirent structures containing
+		the found entries.
+	\param bufSize The size of \a buf.
+	\param count The maximum number of entries to be returned.
+
+	\returns The number of dirent structures stored in the buffer, 0 when
+		there are no more entries to be returned or a status code on error.
+	\retval B_BAD_VALUE \c NULL \a buf.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_NAME_TOO_LONG The entry's name is too long for the buffer.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn status_t BDirectory::Rewind()
+	\brief Rewinds the directory iterator.
+
+	\returns A status code.
+	\retval B_OK: Everything went fine.
+	\retval B_PERMISSION_DENIED: Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY: Insufficient memory for operation.
+	\retval B_LINK_LIMIT: Indicates a cyclic loop within the file system.
+	\retval B_BUSY: A node was busy.
+	\retval B_FILE_ERROR: A general file error.
+	\retval B_NO_MORE_FDS: The application has run out of file descriptors.
+
+	\sa BDirectory::GetNextEntry()
+	\sa BDirectory::GetNextRef()
+	\sa BDirectory::GetNextDirents()
+	\sa BDirectory::CountEntries()
+*/
+
+
+/*!
+	\fn int32 BDirectory::CountEntries()
+	\brief Returns the number of entries in this directory.
+
+	CountEntries() uses the directory iterator also used by GetNextEntry(),
+	GetNextRef() and GetNextDirents(). It does a Rewind(), iterates through
+	the entries and Rewind()s again. The entries "." and ".." are not counted.
+
+	\returns The number of entries in the directory (not counting "." and
+		"..") or a status code on error.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+
+	\sa BDirectory::GetNextEntry()
+	\sa BDirectory::GetNextRef()
+	\sa BDirectory::GetNextDirents()
+	\sa BDirectory::Rewind()
+*/
+
+
+/*!
+	\fn status_t BDirectory::CreateDirectory(const char* path, BDirectory* dir)
+	\brief Creates a new directory.
+
+	If an entry with the supplied name already exists this method returns
+	an error status code.
+
+	\param path The new path name of the directory. May be a relative
+		path to this directory or an absolute path.
+	\param dir A pointer to a BDirectory to be initialized to the newly
+		created directory. May be \c NULL.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a path.
+	\retval B_ENTRY_NOT_FOUND \a path does not refer to a possible entry.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_FILE_EXISTS An entry with that name does already exist.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn status_t BDirectory::CreateFile(const char* path, BFile* file,
+		bool failIfExists)
+	\brief Creates a new file.
+
+	If a file with the supplied name does already exist, the method fails,
+	unless it is passed \c false to \a failIfExists -- in that case the file
+	is truncated to zero size. The new BFile will operate in \c B_READ_WRITE
+	mode.
+
+	\param path The new file's path name. May be relative to this
+		directory or an absolute path.
+	\param file A pointer to a BFile to be initialized to the newly
+		created file. May be \c NULL.
+	\param failIfExists Whether or not to fail if the file already exists.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a path.
+	\retval B_ENTRY_NOT_FOUND \a path does not refer to a possible entry.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_FILE_EXISTS A file with that name does already exist and
+		\c true has been passed for \a failIfExists.
+	\retval B_IS_A_DIRECTORY A directory with the supplied name already
+		exists.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn status_t BDirectory::CreateSymLink(const char* path,
+		const char* linkToPath, BSymLink* link)
+	\brief Creates a new symbolic link.
+
+	This method fails if an entry with the supplied name already exists.
+
+	\param path the new symbolic link's path name. May be relative to this
+		   directory or absolute.
+	\param linkToPath the path the symbolic link shall point to.
+	\param link a pointer to a BSymLink to be initialized to the newly
+		   created symbolic link. May be \c NULL.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a path or \a linkToPath.
+	\retval B_ENTRY_NOT_FOUND \a path does not refer to a possible entry.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_FILE_EXISTS An entry with that name does already exist.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
+
+
+/*!
+	\fn BDirectory& BDirectory::operator=(const BDirectory& dir)
+	\brief Assigns another BDirectory to this BDirectory.
+
+	If the passed in BDirectory object is uninitialized, the returned object
+	will be too. Otherwise it will refer to the same directory, unless an
+	error occurs.
+
+	\param dir The original BDirectory object.
+
+	\returns A reference to this BDirectory object.
+*/
+
+
+/*!
+	\fn int BDirectory::get_fd() const
+	\brief Returns the file descriptor of the BDirectory object.
+
+	This method should be used instead of accessing the private \c fDirFd
+	member directly.
+
+	\returns the file descriptor, or -1 if not properly initialized.
+*/
+
+
+/*!
+	\fn status_t create_directory(const char* path, mode_t mode)
+	\brief Creates all missing directories along a given path.
+
+	\param path The directory path name.
+	\param mode A permission specification, which shall be used for the
+		   newly created directories.
+
+	\returns A status code.
+	\retval B_OK Everything went fine.
+	\retval B_BAD_VALUE \c NULL \a path.
+	\retval B_ENTRY_NOT_FOUND \a path does not refer to a possible entry.
+	\retval B_PERMISSION_DENIED Directory permissions didn't allow operation.
+	\retval B_NO_MEMORY Insufficient memory for operation.
+	\retval B_LINK_LIMIT Indicates a cyclic loop within the file system.
+	\retval B_BUSY A node was busy.
+	\retval B_FILE_ERROR A general file error.
+	\retval B_NOT_A_DIRECTORY An entry other than a directory with that name
+		already exists.
+	\retval B_NO_MORE_FDS The application has run out of file descriptors.
+*/
--- a/src/kits/storage/Directory.cpp
+++ b/src/kits/storage/Directory.cpp
@ -27,7 +27,6 @@
 #include <umask.h>


-//! Creates an uninitialized BDirectory object.
 BDirectory::BDirectory()
 	:
 	fDirFd(-1)
@ -35,9 +34,6 @@ BDirectory::BDirectory()
 }


-/*!	\brief Creates a copy of the supplied BDirectory.
-	\param dir the BDirectory object to be copied
-*/
 BDirectory::BDirectory(const BDirectory& dir)
 	:
 	fDirFd(-1)
@ -46,10 +42,6 @@ BDirectory::BDirectory(const BDirectory& dir)
 }


-/*! \brief Creates a BDirectory and initializes it to the directory referred
-	to by the supplied entry_ref.
-	\param ref the entry_ref referring to the directory
-*/
 BDirectory::BDirectory(const entry_ref* ref)
 	:
 	fDirFd(-1)
@ -58,10 +50,6 @@ BDirectory::BDirectory(const entry_ref* ref)
 }


-/*! \brief Creates a BDirectory and initializes it to the directory referred
-	to by the supplied node_ref.
-	\param nref the node_ref referring to the directory
-*/
 BDirectory::BDirectory(const node_ref* nref)
 	:
 	fDirFd(-1)
@ -70,10 +58,6 @@ BDirectory::BDirectory(const node_ref* nref)
 }


-/*! \brief Creates a BDirectory and initializes it to the directory referred
-	to by the supplied BEntry.
-	\param entry the BEntry referring to the directory
-*/
 BDirectory::BDirectory(const BEntry* entry)
 	:
 	fDirFd(-1)
@ -82,10 +66,6 @@ BDirectory::BDirectory(const BEntry* entry)
 }


-/*! \brief Creates a BDirectory and initializes it to the directory referred
-	to by the supplied path name.
-	\param path the directory's path name
-*/
 BDirectory::BDirectory(const char* path)
 	:
 	fDirFd(-1)
@ -94,12 +74,6 @@ BDirectory::BDirectory(const char* path)
 }


-/*! \brief Creates a BDirectory and initializes it to the directory referred
-	to by the supplied path name relative to the specified BDirectory.
-	\param dir the BDirectory, relative to which the directory's path name is
-		   given
-	\param path the directory's path name relative to \a dir
-*/
 BDirectory::BDirectory(const BDirectory* dir, const char* path)
 	:
 	fDirFd(-1)
@ -108,9 +82,6 @@ BDirectory::BDirectory(const BDirectory* dir, const char* path)
 }


-/*! If the BDirectory is properly initialized, the directory's file descriptor
-	is closed.
-*/
 BDirectory::~BDirectory()
 {
 	// Also called by the BNode destructor, but we rather try to avoid
@ -122,20 +93,6 @@ BDirectory::~BDirectory()
 }


-/*! \brief Re-initializes the BDirectory to the directory referred to by the
-	supplied entry_ref.
-	\param ref the entry_ref referring to the directory
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a ref.
-	- \c B_ENTRY_NOT_FOUND: Directory not found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 status_t
 BDirectory::SetTo(const entry_ref* ref)
 {
@ -159,20 +116,6 @@ BDirectory::SetTo(const entry_ref* ref)
 }


-/*! \brief Re-initializes the BDirectory to the directory referred to by the
-	supplied node_ref.
-	\param nref the node_ref referring to the directory
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a nref.
-	- \c B_ENTRY_NOT_FOUND: Directory not found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 status_t
 BDirectory::SetTo(const node_ref* nref)
 {
@ -187,20 +130,6 @@ BDirectory::SetTo(const node_ref* nref)
 }


-/*! \brief Re-initializes the BDirectory to the directory referred to by the
-	supplied BEntry.
-	\param entry the BEntry referring to the directory
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a entry.
-	- \c B_ENTRY_NOT_FOUND: Directory not found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 status_t
 BDirectory::SetTo(const BEntry* entry)
 {
@ -229,22 +158,6 @@ BDirectory::SetTo(const BEntry* entry)
 }


-/*! \brief Re-initializes the BDirectory to the directory referred to by the
-	supplied path name.
-	\param path the directory's path name
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a path.
-	- \c B_ENTRY_NOT_FOUND: Directory not found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_NAME_TOO_LONG: The supplied path name (\a path) is too long.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-	- \c B_NOT_A_DIRECTORY: \a path includes a non-directory.
-*/
 status_t
 BDirectory::SetTo(const char* path)
 {
@ -268,24 +181,6 @@ BDirectory::SetTo(const char* path)
 }


-/*! \brief Re-initializes the BDirectory to the directory referred to by the
-	supplied path name relative to the specified BDirectory.
-	\param dir the BDirectory, relative to which the directory's path name is
-		   given
-	\param path the directory's path name relative to \a dir
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a dir or \a path, or \a path is absolute.
-	- \c B_ENTRY_NOT_FOUND: Directory not found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_NAME_TOO_LONG: The supplied path name (\a path) is too long.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-	- \c B_NOT_A_DIRECTORY: \a path includes a non-directory.
-*/
 status_t
 BDirectory::SetTo(const BDirectory* dir, const char* path)
 {
@ -325,21 +220,6 @@ BDirectory::SetTo(const BDirectory* dir, const char* path)
 }


-/*!	\brief Returns a BEntry referring to the directory represented by this object.
-	If the initialization of \a entry fails, it is Unset().
-	\param entry a pointer to the entry that shall be set to refer to the
-		   directory
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a entry.
-	- \c B_ENTRY_NOT_FOUND: Directory not found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 status_t
 BDirectory::GetEntry(BEntry* entry) const
 {
@ -351,13 +231,6 @@ BDirectory::GetEntry(BEntry* entry) const
 }


-/*!	\brief Returns whether the directory represented by this BDirectory is a
-	root directory of a volume.
-	\return
-	- \c true, if the BDirectory is properly initialized and represents a
-	  root directory of some volume,
-	- \c false, otherwise.
-*/
 bool
 BDirectory::IsRootDirectory() const
 {
@ -371,33 +244,6 @@ BDirectory::IsRootDirectory() const
 }


-/*! \brief Finds an entry referred to by a path relative to the directory
-	represented by this BDirectory.
-	\a path may be absolute. If the BDirectory is not properly initialized,
-	the entry is search relative to the current directory.
-	If the entry couldn't be found, \a entry is Unset().
-	\param path the entry's path name. May be relative to this directory or
-		   absolute.
-	\param entry a pointer to a BEntry to be initialized with the found entry
-	\param traverse specifies whether to follow it, if the found entry
-		   is a symbolic link.
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a path or \a entry.
-	- \c B_ENTRY_NOT_FOUND: Entry not found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_NAME_TOO_LONG: The supplied path name (\a path) is too long.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-	- \c B_NOT_A_DIRECTORY: \a path includes a non-directory.
-	\note The functionality of this method differs from the one of
-		  BEntry::SetTo(BDirectory *, const char *, bool) in that the
-		  latter doesn't require the entry to be existent, whereas this
-		  function does.
-*/
 status_t
 BDirectory::FindEntry(const char* path, BEntry* entry, bool traverse) const
 {
@ -423,31 +269,6 @@ BDirectory::FindEntry(const char* path, BEntry* entry, bool traverse) const
 }


-/*!	\brief Returns whether this directory or any of its subdirectories
-	at any level contain the entry referred to by the supplied path name.
-	Only entries that match the node flavor specified by \a nodeFlags are
-	considered.
-	If the BDirectory is not properly initialized, the method returns \c false.
-	A non-absolute path is considered relative to the current directory.
-
-	\note R5's implementation always returns \c true given an absolute path or
-	an unitialized directory. This implementation is not compatible with that
-	behavior. Instead it converts the path into a BEntry and passes it to the
-	other version of Contains().
-
-	\param path the entry's path name. May be relative to this directory or
-		   absolute.
-	\param nodeFlags Any of the following:
-		   - \c B_FILE_NODE: The entry must be a file.
-		   - \c B_DIRECTORY_NODE: The entry must be a directory.
-		   - \c B_SYMLINK_NODE: The entry must be a symbolic link.
-		   - \c B_ANY_NODE: The entry may be of any kind.
-	\return
-	- \c true, if the entry exists, its kind does match \nodeFlags and the
-	  BDirectory is properly initialized and does contain the entry at any
-	  level,
-	- \c false, otherwise
-*/
 bool
 BDirectory::Contains(const char* path, int32 nodeFlags) const
 {
@ -468,21 +289,6 @@ BDirectory::Contains(const char* path, int32 nodeFlags) const
 }


-/*!	\brief Returns whether this directory or any of its subdirectories
-	at any level contain the entry referred to by the supplied BEntry.
-	Only entries that match the node flavor specified by \a nodeFlags are
-	considered.
-	\param entry a BEntry referring to the entry
-	\param nodeFlags Any of the following:
-		   - \c B_FILE_NODE: The entry must be a file.
-		   - \c B_DIRECTORY_NODE: The entry must be a directory.
-		   - \c B_SYMLINK_NODE: The entry must be a symbolic link.
-		   - \c B_ANY_NODE: The entry may be of any kind.
-	\return
-	- \c true, if the BDirectory is properly initialized and the entry of the
-	  matching kind could be found,
-	- \c false, otherwise
-*/
 bool
 BDirectory::Contains(const BEntry* entry, int32 nodeFlags) const
 {
@ -522,46 +328,6 @@ BDirectory::Contains(const BEntry* entry, int32 nodeFlags) const
 }


-/*!	\fn status_t BDirectory::GetStatFor(const char* path, struct stat* st) const
-	\brief Returns the stat structure of the entry referred to by the supplied
-	path name.
-	\param path the entry's path name. May be relative to this directory or
-		   absolute, or \c NULL to get the directories stat info.
-	\param st a pointer to the stat structure to be filled in by this function
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a st.
-	- \c B_ENTRY_NOT_FOUND: Entry not found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_NAME_TOO_LONG: The supplied path name (\a path) is too long.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-	- \c B_NOT_A_DIRECTORY: \a path includes a non-directory.
-*/
-// Implemented as BDirectory::_GetStatFor().
-
-
-/*!	\brief Returns the BDirectory's next entry as a BEntry.
-	Unlike GetNextDirents() this method ignores the entries "." and "..".
-	\param entry a pointer to a BEntry to be initialized to the found entry
-	\param traverse specifies whether to follow it, if the found entry
-		   is a symbolic link.
-	\note The iterator used by this method is the same one used by
-		  GetNextRef(), GetNextDirents(), Rewind() and CountEntries().
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a entry.
-	- \c B_ENTRY_NOT_FOUND: No more entries found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 status_t
 BDirectory::GetNextEntry(BEntry* entry, bool traverse)
 {
@ -576,25 +342,6 @@ BDirectory::GetNextEntry(BEntry* entry, bool traverse)
 }


-/*!	\brief Returns the BDirectory's next entry as an entry_ref.
-	Unlike GetNextDirents() this method ignores the entries "." and "..".
-	\param ref a pointer to an entry_ref to be filled in with the data of the
-		   found entry
-	\param traverse specifies whether to follow it, if the found entry
-		   is a symbolic link.
-	\note The iterator used be this method is the same one used by
-		  GetNextEntry(), GetNextDirents(), Rewind() and CountEntries().
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a ref.
-	- \c B_ENTRY_NOT_FOUND: No more entries found.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 status_t
 BDirectory::GetNextRef(entry_ref* ref)
 {
@ -622,26 +369,6 @@ BDirectory::GetNextRef(entry_ref* ref)
 }


-/*!	\brief Returns the BDirectory's next entries as dirent structures.
-	Unlike GetNextEntry() and GetNextRef(), this method returns also
-	the entries "." and "..".
-	\param buf a pointer to a buffer to be filled with dirent structures of
-		   the found entries
-	\param count the maximal number of entries to be returned.
-	\note The iterator used by this method is the same one used by
-		  GetNextEntry(), GetNextRef(), Rewind() and CountEntries().
-	\return
-	- The number of dirent structures stored in the buffer, 0 when there are
-	  no more entries to be returned.
-	- \c B_BAD_VALUE: \c NULL \a buf.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_NAME_TOO_LONG: The entry's name is too long for the buffer.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 int32
 BDirectory::GetNextDirents(dirent* buf, size_t bufSize, int32 count)
 {
@ -653,17 +380,6 @@ BDirectory::GetNextDirents(dirent* buf, size_t bufSize, int32 count)
 }


-/*!	\brief Rewinds the directory iterator.
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-	\see GetNextEntry(), GetNextRef(), GetNextDirents(), CountEntries()
-*/
 status_t
 BDirectory::Rewind()
 {
@ -673,20 +389,6 @@ BDirectory::Rewind()
 }


-/*!	\brief Returns the number of entries in this directory.
-	CountEntries() uses the directory iterator also used by GetNextEntry(),
-	GetNextRef() and GetNextDirents(). It does a Rewind(), iterates through
-	the entries and Rewind()s again. The entries "." and ".." are not counted.
-	\return
-	- the number of entries in the directory (not counting "." and "..").
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-	\see GetNextEntry(), GetNextRef(), GetNextDirents(), Rewind()
-*/
 int32
 BDirectory::CountEntries()
 {
@ -706,24 +408,6 @@ BDirectory::CountEntries()
 }


-/*! \brief Creates a new directory.
-	If an entry with the supplied name does already exist, the method fails.
-	\param path the new directory's path name. May be relative to this
-		   directory or absolute.
-	\param dir a pointer to a BDirectory to be initialized to the newly
-		   created directory. May be \c NULL.
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a path.
-	- \c B_ENTRY_NOT_FOUND: \a path does not refer to a possible entry.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_FILE_EXISTS: An entry with that name does already exist.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 status_t
 BDirectory::CreateDirectory(const char* path, BDirectory* dir)
 {
@ -747,32 +431,6 @@ BDirectory::CreateDirectory(const char* path, BDirectory* dir)
 }


-/*! \brief Creates a new file.
-	If a file with the supplied name does already exist, the method fails,
-	unless it is passed \c false to \a failIfExists -- in that case the file
-	is truncated to zero size. The new BFile will operate in \c B_READ_WRITE
-	mode.
-	\param path the new file's path name. May be relative to this
-		   directory or absolute.
-	\param file a pointer to a BFile to be initialized to the newly
-		   created file. May be \c NULL.
-	\param failIfExists \c true, if the method should fail when the file
-		   already exists, \c false otherwise
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a path.
-	- \c B_ENTRY_NOT_FOUND: \a path does not refer to a possible entry.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_FILE_EXISTS: A file with that name does already exist and
-	  \c true has been passed for \a failIfExists.
-	- \c B_IS_A_DIRECTORY: A directory with the supplied name does already
-	  exist.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 status_t
 BDirectory::CreateFile(const char* path, BFile* file, bool failIfExists)
 {
@ -795,25 +453,6 @@ BDirectory::CreateFile(const char* path, BFile* file, bool failIfExists)
 }


-/*! \brief Creates a new symbolic link.
-	If an entry with the supplied name does already exist, the method fails.
-	\param path the new symbolic link's path name. May be relative to this
-		   directory or absolute.
-	\param linkToPath the path the symbolic link shall point to.
-	\param dir a pointer to a BSymLink to be initialized to the newly
-		   created symbolic link. May be \c NULL.
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a path or \a linkToPath.
-	- \c B_ENTRY_NOT_FOUND: \a path does not refer to a possible entry.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_FILE_EXISTS: An entry with that name does already exist.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-*/
 status_t
 BDirectory::CreateSymLink(const char* path, const char* linkToPath,
 	BSymLink* link)
@ -838,12 +477,6 @@ BDirectory::CreateSymLink(const char* path, const char* linkToPath,
 }


-/*!	\brief Assigns another BDirectory to this BDirectory.
-	If the other BDirectory is uninitialized, this one wi'll be too. Otherwise
-	it will refer to the same directory, unless an error occurs.
-	\param dir the original BDirectory
-	\return a reference to this BDirectory
-*/
 BDirectory&
 BDirectory::operator=(const BDirectory& dir)
 {
@ -907,11 +540,6 @@ BDirectory::close_fd()
 }


-/*!	\brief Returns the BDirectory's file descriptor.
-	To be used instead of accessing the BDirectory's private \c fDirFd member
-	directly.
-	\return the file descriptor, or -1, if not properly initialized.
-*/
 int
 BDirectory::get_fd() const
 {
@ -922,24 +550,7 @@ BDirectory::get_fd() const
 //	#pragma mark - C functions


-/*!	\brief Creates all missing directories along a given path.
-	\param path the directory path name.
-	\param mode a permission specification, which shall be used for the
-		   newly created directories.
-	\return
-	- \c B_OK: Everything went fine.
-	- \c B_BAD_VALUE: \c NULL \a path.
-	- \c B_ENTRY_NOT_FOUND: \a path does not refer to a possible entry.
-	- \c B_PERMISSION_DENIED: Directory permissions didn't allow operation.
-	- \c B_NO_MEMORY: Insufficient memory for operation.
-	- \c B_LINK_LIMIT: Indicates a cyclic loop within the file system.
-	- \c B_BUSY: A node was busy.
-	- \c B_FILE_ERROR: A general file error.
-	- \c B_NOT_A_DIRECTORY: An entry other than a directory with that name does
-	  already exist.
-	- \c B_NO_MORE_FDS: The application has run out of file descriptors.
-	\todo Check for efficency.
-*/
+// TODO: Check this method for efficiency.
 status_t
 create_directory(const char* path, mode_t mode)
 {