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

API Docs: Update BVolume::SetName()

Browse Source 
Update \since to BeOS R4. This method definitely predates Haiku,
it has existed since at least R4.5 despite not being documented.

Document B_NAME_TOO_LONG return value.

Change-Id: I0816e4e89ae2710f6123e10ee41145a83fdca66f
Reviewed-on: https://review.haiku-os.org/c/haiku/+/6363
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: Adrien Destugues <[email protected]>
This commit is contained in:
John Scipione
2023-05-01 14:21:41 +00:00
parent b3fc3bc71d
commit f18d2effbf
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/storage/Volume.dox
+3 -2
View File
@@ -247,14 +247,15 @@
it to /boot, but is prevented by the kernel. it to /boot, but is prevented by the kernel.
\param name The new name of the volume, must not be longer than \param name The new name of the volume, must not be longer than
\c B_FILE_NAME_LENGTH (including the terminating \c NULL). \c B_FILE_NAME_LENGTH (including the terminating \c NULL).
\return A status code. \return A status code.
\retval B_OK Everything went fine. \retval B_OK Everything went fine.
\retval B_BAD_VALUE \a name was \c NULL or the object was not properly \retval B_BAD_VALUE \a name was \c NULL or the object was not properly
initialized. initialized.
\retval B_NAME_TOO_LONG \a name was >= \c B_FILE_NAME_LENGTH.
\since Haiku R1 \since BeOS R4
*/ */