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

[giles at svn.xiph.org]

Author: giles
Date: 2009-08-31 15:49:44 -0700 (Mon, 31 Aug 2009)
New Revision: 16544

Modified:
   trunk/theora/include/theora/theora.h
Log:
Fix a doxygen warning about duplicate \mainpage attributes.

The original \mainpage directive in theora.h was shadowed by the newer
one in codec.h, generating a warning. This was probably reliable since
the later comes first in sort order, but was still infelicitous.

I've just commuted the second to file-level documenation. I've not
figured out how to get it on the 'Legacy pre-1.0 API' module 
documenation page, which is where it should be.


Modified: trunk/theora/include/theora/theora.h
===================================================================
--- trunk/theora/include/theora/theora.h	2009-08-31 22:30:22 UTC (rev 16543)
+++ trunk/theora/include/theora/theora.h	2009-08-31 22:49:44 UTC (rev 16544)
@@ -27,11 +27,11 @@
 
 #include <ogg/ogg.h>
 
-/** \defgroup oldfuncs Legacy pre-1.0 C API */
-/*  @{ */
-
-/** \mainpage
- * 
+/** \file
+ * The libtheora pre-1.0 legacy C API.
+ *
+ * \ingroup oldfuncs
+ *
  * \section intro Introduction
  *
  * This is the documentation for the libtheora legacy C API, declared in 
@@ -126,10 +126,10 @@
  * examples/encoder_example.c</a> for a simple encoder implementation.
  */
 
-/** \file
- * The libtheora pre-1.0 legacy C API.
- */
 
+/** \defgroup oldfuncs Legacy pre-1.0 C API */
+/*  @{ */
+
 /**
  * A YUV buffer for passing uncompressed frames to and from the codec.
  * This holds a Y'CbCr frame in planar format. The CbCr planes can be