BEntry::Unset doc: missing \fn, better description.

2014-08-23 17:37:33 +02:00
parent 454ca0b1aa
commit f4df6bfab7
1 changed files with 6 additions and 2 deletions
@@ -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
 */