i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor BPath doc cleanups.

Browse Source 
* Implements BFlattenable::method not overrides, pure virtual.
* Tense of return values should be past.
This commit is contained in:
John Scipione
2013-02-10 16:10:25 -05:00
parent 2675e31a0c
commit 61feea6280
1 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/storage/Path.dox
+18 -18
View File
@@ -135,7 +135,7 @@
\returns A status code. \returns A status code.
\retval B_OK Initialization was successful. \retval B_OK Initialization was successful.
\retval B_BAD_VALUE \c NULL \a ref. \retval B_BAD_VALUE \a ref was \c NULL.
\retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH. \retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH.
*/ */
@@ -148,7 +148,7 @@
\returns A status code. \returns A status code.
\retval B_OK Initialization was successful. \retval B_OK Initialization was successful.
\retval B_BAD_VALUE \c NULL \a ref. \retval B_BAD_VALUE \a ref was \c NULL.
\retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH. \retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH.
*/ */
@@ -173,7 +173,7 @@
\returns A status code. \returns A status code.
\retval B_OK Initialization was successful. \retval B_OK Initialization was successful.
\retval B_BAD_VALUE \c NULL \a ref. \retval B_BAD_VALUE \a ref was \c NULL.
\retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH. \retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH.
*/ */
@@ -196,7 +196,7 @@
\returns A status code. \returns A status code.
\retval B_OK Initialization was successful. \retval B_OK Initialization was successful.
\retval B_BAD_VALUE \c NULL \a ref. \retval B_BAD_VALUE \a ref was \c NULL.
\retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH. \retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH.
*/ */
@@ -204,7 +204,7 @@
/*! /*!
\fn void BPath::Unset() \fn void BPath::Unset()
\brief Returns the object to an uninitialized state. \brief Returns the object to an uninitialized state.
Frees any resources it allocated and marks the object as uninitialized. Frees any resources it allocated and marks the object as uninitialized.
*/ */
@@ -238,7 +238,7 @@
\returns A status code. \returns A status code.
\retval B_OK Initialization was successful. \retval B_OK Initialization was successful.
\retval B_BAD_VALUE \c NULL \a ref. \retval B_BAD_VALUE \a ref was \c NULL.
\retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH. \retval B_NAME_TOO_LONG The pathname was longer than \c B_PATH_NAME_LENGTH.
*/ */
@@ -285,7 +285,7 @@
\returns A status code. \returns A status code.
\retval B_OK Everything went fine. \retval B_OK Everything went fine.
\retval B_BAD_VALUE \c NULL \a path. \retval B_BAD_VALUE \a path was \c NULL.
\retval B_ENTRY_NOT_FOUND The BPath object represents the root path and \retval B_ENTRY_NOT_FOUND The BPath object represents the root path and
thus has no parent. thus has no parent.
*/ */
@@ -389,7 +389,7 @@
/*! /*!
\name BFlattenable override methods \name BFlattenable method implementations
*/ */
@@ -398,7 +398,7 @@
/*! /*!
\fn bool BPath::IsFixedSize() const \fn bool BPath::IsFixedSize() const
\brief Overrides BFlattenable::IsFixedSize(). Always returns \c false. \brief Implements BFlattenable::IsFixedSize(). Always returns \c false.
\return \c false \return \c false
*/ */
@@ -406,7 +406,7 @@
/*! /*!
\fn type_code BPath::TypeCode() const \fn type_code BPath::TypeCode() const
\brief Overrides BFlattenable::TypeCode() Always returns \c B_REF_TYPE. \brief Implements BFlattenable::TypeCode() Always returns \c B_REF_TYPE.
\return \c B_REF_TYPE \return \c B_REF_TYPE
*/ */
@@ -414,7 +414,7 @@
/*! /*!
\fn ssize_t BPath::FlattenedSize() const \fn ssize_t BPath::FlattenedSize() const
\brief Overrides BFlattenable::FlattenedSize() Gets the size of the \brief Implements BFlattenable::FlattenedSize() Gets the size of the
flattened entry_ref struct that represents the path in bytes. flattened entry_ref struct that represents the path in bytes.
\return The size of the flattened entry_ref struct that represents the \return The size of the flattened entry_ref struct that represents the
@@ -424,7 +424,7 @@
/*! /*!
\fn status_t BPath::Flatten(void* buffer, ssize_t size) const \fn status_t BPath::Flatten(void* buffer, ssize_t size) const
\brief Overrides BFlattenable::Flatten(). Converts the path of the object \brief Implements BFlattenable::Flatten(). Converts the path of the object
to an entry_ref and writes it into <em>buffer</em>. to an entry_ref and writes it into <em>buffer</em>.
\param buffer The buffer that the data is to be stored in. \param buffer The buffer that the data is to be stored in.
@@ -432,13 +432,13 @@
\returns A status code. \returns A status code.
\retval B_OK Everything went fine. \retval B_OK Everything went fine.
\retval B_BAD_VALUE \c NULL buffer or the buffer is of insufficient size. \retval B_BAD_VALUE \a buffer was \c NULL or of insufficient size.
*/ */
/*! /*!
\fn bool BPath::AllowsTypeCode(type_code code) const \fn bool BPath::AllowsTypeCode(type_code code) const
\brief Overrides BFlattenable::AllowsTypeCode(). Checks if type code is \brief Implements BFlattenable::AllowsTypeCode(). Checks if type code is
equal to \c B_REF_TYPE. equal to \c B_REF_TYPE.
\param code The type code to test. \param code The type code to test.
@@ -450,7 +450,7 @@
/*! /*!
\fn status_t BPath::Unflatten(type_code code, const void* buffer, \fn status_t BPath::Unflatten(type_code code, const void* buffer,
ssize_t size) ssize_t size)
\brief Overrides BFlattenable::Unflatten(). Initializes the object with \brief Implements BFlattenable::Unflatten(). Initializes the object with
the flattened entry_ref data from the passed in buffer. the flattened entry_ref data from the passed in buffer.
The type code must be set to \c B_REF_TYPE. The type code must be set to \c B_REF_TYPE.
@@ -461,7 +461,7 @@
\returns A status code. \returns A status code.
\retval B_OK Everything went fine. \retval B_OK Everything went fine.
\retval B_BAD_VALUE \a buffer is \c NULL or doesn't contain an entry_ref. \retval B_BAD_VALUE \a buffer was \c NULL or didn't contain an entry_ref.
*/ */
@@ -475,8 +475,8 @@
status_t BPath::_SetPath(const char* path) status_t BPath::_SetPath(const char* path)
\brief Sets the supplied path. \brief Sets the supplied path.
The path is copied. If \a path is \c NULL path of the object is set to The path is copied, if \a path is \c NULL the path of the object is set to
\c NULL as well. The object's old path is deleted. \c NULL as well. The old path is deleted.
\param path the path to be set \param path the path to be set