Haiku/haiku
Haiku/haiku
1
0
Fork 0
mirror of https://review.haiku-os.org/haiku synced 2024-11-23 07:18:40 +01:00
Code Issues 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 <no-reply+buildbot@haiku-os.org>
Reviewed-by: Adrien Destugues <pulkomandy@pulkomandy.tk>
This commit is contained in:
John Scipione 2023-04-18 12:40:28 -04:00
parent b3fc3bc71d
commit f18d2effbf
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/user/storage/Volume.dox
View File

@ -247,14 +247,15 @@
it to /boot, but is prevented by the kernel.
\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.
\retval B_OK Everything went fine.
\retval B_BAD_VALUE \a name was \c NULL or the object was not properly
initialized.
\retval B_NAME_TOO_LONG \a name was >= \c B_FILE_NAME_LENGTH.
\since Haiku R1
\since BeOS R4
*/