From f18d2effbf60ff70fc6ba02f57da02e7c70993b7 Mon Sep 17 00:00:00 2001 From: John Scipione Date: Tue, 18 Apr 2023 12:40:28 -0400 Subject: [PATCH] API Docs: Update BVolume::SetName() 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 Reviewed-by: Adrien Destugues --- docs/user/storage/Volume.dox | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/user/storage/Volume.dox b/docs/user/storage/Volume.dox index 1b9b6c50c6..48d753aa4c 100644 --- a/docs/user/storage/Volume.dox +++ b/docs/user/storage/Volume.dox @@ -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 */