[xiph-commits] r8419 - trunk/theora/include/theora

[giles at motherfish-iii.xiph.org]

Author: giles
Date: 2004-12-15 11:18:13 -0800 (Wed, 15 Dec 2004)
New Revision: 8419

Modified:
   trunk/theora/include/theora/theora.h
Log:
Correct some markup problems.


Modified: trunk/theora/include/theora/theora.h
===================================================================
--- trunk/theora/include/theora/theora.h	2004-12-15 19:10:59 UTC (rev 8418)
+++ trunk/theora/include/theora/theora.h	2004-12-15 19:18:13 UTC (rev 8419)
@@ -343,33 +343,27 @@
 extern int theora_decode_YUVout(theora_state *th,yuv_buffer *yuv);
 
 /**
- * Convert a granulepos to absolute time in seconds. The granulepos is
- * interpreted in the context of a given theora_state handle.
- * \param th A previously initialized theora_state handle (encode or decode)
- * \param granulepos The granulepos to convert.
- * \returns The absolute time in seconds corresponding to \a granulepos.
- * \retval -1 The given granulepos is invalid (ie. negative)
- */
-extern double theora_granule_time(theora_state *th,ogg_int64_t granulepos);
-
-/**
  * Report whether a theora packet is a header or not
  * This function does no verification beyond checking the header
  * flag bit so it should not be used for bitstream identification;
  * use theora_decode_header() for that.
+ *
  * \param op An ogg_packet containing encoded theora data.
  * \retval 1 The packet is a header packet
  * \retval 0 The packet is not a header packet (and so contains frame data)
+ *
  * Thus function was added in the 1.0alpha4 release.
  */
 extern int theora_packet_isheader(ogg_packet *op);
 
 /**
  * Report whether a theora packet is a keyframe or not
+ *
  * \param op An ogg_packet containing encoded theora data.
  * \retval 1 The packet contains a keyframe image
  * \retval 0 The packet is contains an interframe delta
  * \retval -1 the packet is not an image data packet at all
+ *
  * Thus function was added in the 1.0alpha4 release.
  */
 extern int theora_packet_iskeyframe(ogg_packet *op);
@@ -377,15 +371,27 @@
 /**
  * Convert a granulepos to an absolute frame number. The granulepos is
  * interpreted in the context of a given theora_state handle.
+ *
  * \param th A previously initialized theora_state handle (encode or decode)
  * \param granulepos The granulepos to convert.
  * \returns The frame number corresponding to \a granulepos.
  * \retval -1 The given granulepos is invalid (ie. negative)
+ *
  * Thus function was added in the 1.0alpha4 release.
  */
 extern ogg_int64_t theora_granule_frame(theora_state *th,ogg_int64_t granulepos);
 
 /**
+ * Convert a granulepos to absolute time in seconds. The granulepos is
+ * interpreted in the context of a given theora_state handle.
+ * \param th A previously initialized theora_state handle (encode or decode)
+ * \param granulepos The granulepos to convert.
+ * \returns The absolute time in seconds corresponding to \a granulepos.
+ * \retval -1 The given granulepos is invalid (ie. negative)
+ */
+extern double theora_granule_time(theora_state *th,ogg_int64_t granulepos);
+
+/**
  * Initialize a theora_info structure. All values within the given theora_info
  * structure are initialized, and space is allocated within libtheora for
  * internal codec setup data.