libdvbv5: Create doxygen docs for mpeg_es.h

While here, fix two typos and add documentation for a missing
var.

Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>

diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
index 98340f8..f1f9ab4 100644 (file)
--- a/doxygen_libdvbv5.cfg
+++ b/doxygen_libdvbv5.cfg
@@ -764,6 +764,7 @@ INPUT                  = $(SRCDIR)/doc/libdvbv5-index.doc \
                         $(SRCDIR)/lib/include/libdvbv5/sdt.h \
                         $(SRCDIR)/lib/include/libdvbv5/vct.h \
                         $(SRCDIR)/lib/include/libdvbv5/crc32.h \
+                        $(SRCDIR)/lib/include/libdvbv5/mpeg_es.h \
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/lib/include/libdvbv5/mpeg_es.h b/lib/include/libdvbv5/mpeg_es.h
index 377f235..cc2156b 100644 (file)
--- a/lib/include/libdvbv5/mpeg_es.h
+++ b/lib/include/libdvbv5/mpeg_es.h
@@ -170,6 +170,9 @@ enum dvb_mpeg_es_frame_t
        DVB_MPEG_ES_FRAME_D
 };
 
+/**
+ * @brief Vector that translates from enum dvb_mpeg_es_frame_t to string.
+ */
 extern const char *dvb_mpeg_es_frame_names[5];
 
 struct dvb_v5_fe_parms;
@@ -182,7 +185,7 @@ extern "C" {
  * @brief Initialize a struct dvb_mpeg_es_seq_start from buffer
  *
  * @param buf          Buffer
- * @param buflen       Lenght of buffer
+ * @param buflen       Length of buffer
  * @param seq_start    Pointer to allocated struct dvb_mpeg_es_seq_start
  *
  * @return             If buflen too small, return -1, 0 otherwise.
@@ -209,7 +212,7 @@ void dvb_mpeg_es_seq_start_print(struct dvb_v5_fe_parms *parms,
  * @brief Initialize a struct dvb_mpeg_es_pic_start from buffer
  *
  * @param buf          Buffer
- * @param buflen       Lenght of buffer
+ * @param buflen       Length of buffer
  * @param pic_start    Pointer to allocated structdvb_mpeg_es_pic_start
  *
  * @return             If buflen too small, return -1, 0 otherwise.