Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

A few formatting tweaks in the BEntry and BDirectory class documentation.

Browse Source
This commit is contained in:
John Scipione 2011-12-18 21:43:22 -05:00
parent d4fa97f8f8
commit f969ed4153
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/user/storage/Directory.dox
View File

@ -23,7 +23,7 @@
\class BDirectory
\ingroup storage
\ingroup libbe
\brief Represents a directory in the file system.
\brief A directory in the file system.
*/
@ -250,17 +250,17 @@
\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.
\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)
*/

8
docs/user/storage/Entry.dox
View File

@ -241,8 +241,8 @@ BEntry entry("/boot/home/fido");
\brief Returns the result of the most recent construction or SetTo() call.
\returns A status code.
\retval \c B_OK Success
\retval \c B_NO_INIT The object has been Unset() or is uninitialized.
\retval B_OK Success
\retval B_NO_INIT The object has been Unset() or is uninitialized.
*/
@ -378,7 +378,7 @@ if (err != B_ENTRY_NOT_FOUND)
\returns A status code.
\retval B_OK Success
\retval B_ENTRY_NOT_FOUND - Attempted to get the parent of the root
\retval B_ENTRY_NOT_FOUND Attempted to get the parent of the root
directory.
*/
@ -394,7 +394,7 @@ if (err != B_ENTRY_NOT_FOUND)
\returns A status code.
\retval B_OK Success
\retval B_ENTRY_NOT_FOUND - Attempted to get the parent of the root
\retval B_ENTRY_NOT_FOUND Attempted to get the parent of the root
directory.
*/