From f4df6bfab7bf849d88c94f87828dc8cc25ad3c6b Mon Sep 17 00:00:00 2001 From: Adrien Destugues Date: Sat, 23 Aug 2014 17:35:50 +0200 Subject: [PATCH] BEntry::Unset doc: missing \fn, better description. --- docs/user/storage/Entry.dox | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/user/storage/Entry.dox b/docs/user/storage/Entry.dox index f6c6db3ea2..5d3df3e530 100644 --- a/docs/user/storage/Entry.dox +++ b/docs/user/storage/Entry.dox @@ -370,8 +370,12 @@ BEntry entry("/boot/home/fido"); /*! - void BEntry::Unset() - \brief Reinitializes the BEntry to an uninitialized BEntry object + \fn void BEntry::Unset() + \brief Reset the BEntry to the uninitialized state + + The BEntry forgets any information about the entry it was referencing. + Any attempt to get information from it after this will return B_NO_INIT. + The BEntry can later be pointed to another entry using SetTo(). \since BeOS R3 */