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

Style fixes to FindDirectory

This commit is contained in:
John Scipione 2013-11-05 13:36:23 -05:00
parent f27f868283
commit dd1281c99b
1 changed files with 40 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/user/storage/FindDirectory.dox
View File

@ -1,13 +1,14 @@
/* /*
* Copyright 2011 Haiku Inc. All rights reserved. * Copyright 2011-2013 Haiku Inc. All rights reserved.
* Distributed under the terms of the MIT License. * Distributed under the terms of the MIT License.
* *
* Documentation by: * Documentation by:
* Adrien Destugues, pulkomandy@pulkomandy.ath.cx * Adrien Destugues, pulkomandy@pulkomandy.ath.cx
* John Scipione, jscipione@gmail.com
* *
* Corresponds to: * Corresponds to:
* headers/os/storage/FindDirectory.h rev 42600 * headers/os/storage/FindDirectory.h hrev46316
* src/kits/storage/FindDirectory.cpp rev 42600 * src/kits/storage/FindDirectory.cpp hrev46316
*/ */
@ -43,7 +44,7 @@
directories have a different value depending on the UID of the application directories have a different value depending on the UID of the application
calling the function. They are usually located in the user home directory. calling the function. They are usually located in the user home directory.
Use common directories for system-wide filessuch as drivers. Use user Use common directories for system-wide files such as drivers. Use user
directories for application settings, since each user may want different directories for application settings, since each user may want different
settings. settings.
*/ */
@ -72,11 +73,11 @@
\var directory_which B_SYSTEM_LIB_DIRECTORY \var directory_which B_SYSTEM_LIB_DIRECTORY
The system lib directory. The system lib directory.
\var directory_which B_SYSTEM_SERVERS_DIRECTORY \var directory_which B_SYSTEM_SERVERS_DIRECTORY
The system servers directory. The system servers directory.
\var directory_which B_SYSTEM_APPS_DIRECTORY \var directory_which B_SYSTEM_APPS_DIRECTORY
The system applications direcotry. Contains applications executable from The system applications directory. Contains applications executable from
Tracker. Tracker.
\var directory_which B_SYSTEM_BIN_DIRECTORY \var directory_which B_SYSTEM_BIN_DIRECTORY
@ -168,17 +169,19 @@
/*! /*!
\fn status_t find_directory(directory_which which, dev_t volume, bool createIt, char* pathString, int32 length) \fn status_t find_directory(directory_which which, dev_t volume,
bool createIt, char* pathString, int32 length)
\brief C interface to find_directory \brief C interface to find_directory
Fills up to \a length characters of \a pathString with the path to \a which Fills up to \a length characters of \a pathString with the path to \a which
on \a volume. Creates the directory if it doesn't exists and \a creqteIt is on \a volume. Creates the directory if it doesn't exists if \a createIt is
set. set.
*/ */
/*! /*!
\fn status_t find_directory(directory_which which, BPath* path, bool createIt = false, BVolume* volume = NULL) \fn status_t find_directory(directory_which which, BPath* path, bool createIt,
BVolume* volume)
\brief C++ interface to find_directory \brief C++ interface to find_directory
Set \a path to \a which on \a volume. Set \a path to \a which on \a volume.