[xiph-commits] r16968 - experimental/derf/theora-ptalarbvorm/include/theora

[tterribe at svn.xiph.org]

Author: tterribe
Date: 2010-03-13 13:39:56 -0800 (Sat, 13 Mar 2010)
New Revision: 16968

Modified:
   experimental/derf/theora-ptalarbvorm/include/theora/theoradec.h
Log:
Update API documentation to reflect the decoder changes in r16966.


Modified: experimental/derf/theora-ptalarbvorm/include/theora/theoradec.h
===================================================================
--- experimental/derf/theora-ptalarbvorm/include/theora/theoradec.h	2010-03-13 21:34:40 UTC (rev 16967)
+++ experimental/derf/theora-ptalarbvorm/include/theora/theoradec.h	2010-03-13 21:39:56 UTC (rev 16968)
@@ -283,7 +283,8 @@
  * \retval 0             Success.
  *                       A new decoded frame can be retrieved by calling
  *                        th_decode_ycbcr_out().
- * \retval TH_DUPFRAME   The packet represented a dropped (0-byte) frame.
+ * \retval TH_DUPFRAME   The packet represented a dropped frame (either a
+ *                        0-byte frame or an INTER frame with no coded blocks).
  *                       The player can skip the call to th_decode_ycbcr_out(),
  *                        as the contents of the decoded frame buffer have not
  *                        changed.