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

[giles at svn.xiph.org]

Author: giles
Date: 2005-06-28 03:10:48 -0700 (Tue, 28 Jun 2005)
New Revision: 9532

Modified:
   trunk/theora/include/theora/theora.h
Log:
Document that theora_granule_time() may return -1.0 with 
--disable-float. Also, a granulepos of -1 is undefined, not
invalid.


Modified: trunk/theora/include/theora/theora.h
===================================================================
--- trunk/theora/include/theora/theora.h	2005-06-28 09:58:47 UTC (rev 9531)
+++ trunk/theora/include/theora/theora.h	2005-06-28 10:10:48 UTC (rev 9532)
@@ -420,7 +420,7 @@
  * \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)
+ * \retval -1 The given granulepos is undefined (i.e. negative)
  *
  * Thus function was added in the 1.0alpha4 release.
  */
@@ -432,7 +432,9 @@
  * \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)
+ * \retval -1. The given granulepos is undefined (i.e. negative), or
+ * \retval -1. The function has been disabled because floating 
+ *		point support is not available.
  */
 extern double theora_granule_time(theora_state *th,ogg_int64_t granulepos);