Update BBuffer class docs.

docs/user/media/Buffer.dox

@@ -4,7 +4,7 @@
  *
  * Authors:
  *		John Scipione, [email protected]
- * 
+ *
  * Corresponds to:
  *		headers/os/media/Buffer.h	 rev 42274
  *		src/kits/media/Buffer.cpp	 rev 42274
@@ -24,7 +24,7 @@
 	\ingroup media
 	\ingroup libbe
 	\brief A struct that stores where in memory a BBuffer object is in memory
-		as well as the buffer flags.
+		   as well as the buffer flags.
 */
 
 
@@ -39,34 +39,42 @@
 
 /*!
 	\fn void* BBuffer::Data()
-	\brief Returns a pointer to the data of the buffer.
+	\brief Gets a pointer to the data of the buffer.
+
+	\returns A void* pointer to the data.
 */
 
 
 /*!
 	\fn size_t BBuffer::SizeAvailable()
-	\brief Returns the size of the buffer in bytes. Alias for Size().
+	\brief Gets the size of the buffer in bytes. Alias for Size().
+
+	\returns The buffer size in bytes
 */
 
 
 /*!
 	\fn size_t BBuffer::SizeUsed()
-	\brief Returns the size of the portion of the buffer that is currently in
+	\brief Gets the size of the portion of the buffer that is currently in
 		use in bytes.
+
+	\returns The currently used portion of the buffer size in bytes.
 */
 
 
 /*!
 	\fn void BBuffer::SetSizeUsed(size_t size_used)
 	\brief Sets the size of the buffer that is used in bytes.
-	
+
 	This method should be called after writing data to the buffer.
 */
 
 
 /*!
 	\fn uint32 BBuffer::Flags()
-	\brief Returns the flags of the buffer.
+	\brief Gets the flags of the buffer.
+
+	\returns The buffer flags.
 */
 
 
@@ -78,41 +86,57 @@
 
 /*!
 	\fn buffer_clone_info BBuffer::CloneInfo() const
-	\brief Returns the buffer_clone_info struct that describes the buffer.
+	\brief Gets the \c buffer_clone_info struct that describes the buffer.
+
+	\returns The a clone of the \c buffer_clone_info struct.
 */
 
 
 /*!
 	\fn media_buffer_id BBuffer::ID()
-	\brief Returns the app_server ID of the buffer.
+	\brief Gets the ID of the buffer according to the App Server.
+
+	\returns The App Server's ID of the buffer.
 */
 
 
 /*!
 	\fn media_type BBuffer::Type()
-	\brief Returns the media type of the data in the buffer.
+	\brief Gets the media type of the data in the buffer.
+
+	\returns The media type of the data in the buffer.
 */
 
 
 /*!
 	\fn media_header* BBuffer::Header()
-	\brief Returns a pointer to the header of the buffer.
+	\brief Gets a pointer to the header of the buffer.
+
+	\returns A pointer to the header of the buffer.
 */
 
 
 /*!
 	\fn media_audio_header* BBuffer::AudioHeader()
-	\brief Returns a pointer to a header of the audio buffer.
+	\brief Gets a pointer to the header of the audio buffer.
+
+	\returns A pointer to the header of the audio buffer.
 */
 
 
 /*!
 	\fn media_video_header* BBuffer::VideoHeader()
-	\brief Returns a pointer to a header of the video buffer.
+	\brief Gets a pointer to a header of the video buffer.
+
+	\returns A pointer to a header of the video buffer.
 */
 
 
 /*!
 	\fn size_t BBuffer::Size()
-	\brief Returns the size of the buffer in bytes. Alias for SizeAvailable().
+	\brief Gets the size of the buffer in bytes.
+
+	Alias for SizeAvailable().
+
+	\returns The size of the buffer in bytes.
 */