[NUT-devel] [PATCH] libnut: fix Doxygen warnings

Timothy Gu timothygu99 at gmail.com
Thu Oct 24 06:23:13 CEST 2013


Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
 src/trunk/libnut/Doxyfile |  1 -
 src/trunk/libnut/libnut.h | 16 ++++++++--------
 2 files changed, 8 insertions(+), 9 deletions(-)

diff --git a/src/trunk/libnut/Doxyfile b/src/trunk/libnut/Doxyfile
index c4336cc..3e8900e 100644
--- a/src/trunk/libnut/Doxyfile
+++ b/src/trunk/libnut/Doxyfile
@@ -2,7 +2,6 @@ PROJECT_NAME           = libnut
 OUTPUT_DIRECTORY       = doxygen
 CREATE_SUBDIRS         = NO
 REPEAT_BRIEF           = YES
-DETAILS_AT_TOP         = YES
 OPTIMIZE_OUTPUT_FOR_C  = YES
 EXTRACT_ALL            = NO
 SORT_MEMBER_DOCS       = NO
diff --git a/src/trunk/libnut/libnut.h b/src/trunk/libnut/libnut.h
index d1b578d..9a6188e 100644
--- a/src/trunk/libnut/libnut.h
+++ b/src/trunk/libnut/libnut.h
@@ -48,7 +48,7 @@ typedef struct {
 
 /// stream header struct \ingroup demuxer muxer
 typedef struct {
-	int type;                 ///< Possible values are enum ::nut_stream_class_t. A value of -1 terminates a stream header array.
+	int type;                 ///< Possible values are enum ::nut_stream_class_tt. A value of -1 terminates a stream header array.
 	int fourcc_len;           ///< fourcc length
 	uint8_t * fourcc;         ///< fourcc in big-endian format
 	nut_timebase_tt time_base; ///< stream timebase
@@ -99,7 +99,7 @@ typedef struct {
 	int len;          ///< Length of frame in bytes, \b must be zero if #NUT_FLAG_EOR is set.
 	int stream;       ///< stream index of frame
 	uint64_t pts;     ///< presentation timestamp of frame
-	int flags;        ///< frame flags from #nut_frame_flags_t
+	int flags;        ///< frame flags from #nut_frame_flags_tt
 	int64_t next_pts; ///< Only used in muxer. Only necessary if nut_write_frame_reorder() is used.
 } nut_packet_tt;
 
@@ -256,19 +256,19 @@ int nut_seek(nut_context_tt * nut, double time_pos, int flags, const int * activ
  * \verbinclude COPYING
  */
 
-/*! \struct nut_alloc_t
+/*! \struct nut_alloc_tt
  * libc semantics are assumed for all functions (realloc must work with NULL or zero size).
  *
- * #malloc function pointer may be NULL. This indicates using libc malloc, realloc and free functions.
+ * malloc function pointer may be NULL. This indicates using libc malloc, realloc and free functions.
  *
- * If #malloc is not NULL, #realloc and #free \b must \b not be NULL.
+ * If malloc is not NULL, realloc and free \b must \b not be NULL.
  */
 
-/*! \struct nut_timebase_t
+/*! \struct nut_timebase_tt
  * The example shown is if fps is 23.976 (24000/1001). Timebase is the opposite of fps.
  */
 
-/*! \struct nut_info_field_t
+/*! \struct nut_info_field_tt
  * \par Example:
  * \code
  * char * text = "The Foobar Adventure";
@@ -322,7 +322,7 @@ int nut_seek(nut_context_tt * nut, double time_pos, int flags, const int * activ
  */
 
 /*! \var int nut_info_packet_tt::count
- * For arrays of #nut_info_packet_t, the packet with a #count of \a -1
+ * For arrays of #nut_info_packet_tt, the packet with a #count of \a -1
  * terminates the array.
  */
 
-- 
1.8.1.2



More information about the NUT-devel mailing list