libdvbv5: add documentation for ISDB partial reception descriptor

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

2 files changed, 73 insertions, 2 deletions

diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
index 8cc09e8a..420f9480 100644
--- a/doxygen_libdvbv5.cfg
+++ b/doxygen_libdvbv5.cfg
@@ -780,6 +780,7 @@ INPUT                  = $(SRCDIR)/doc/libdvbv5-index.doc \
 			 $(SRCDIR)/lib/include/libdvbv5/desc_language.h \
 			 $(SRCDIR)/lib/include/libdvbv5/desc_logical_channel.h \
 			 $(SRCDIR)/lib/include/libdvbv5/desc_network_name.h \
+			 $(SRCDIR)/lib/include/libdvbv5/desc_partial_reception.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/desc_partial_reception.h b/lib/include/libdvbv5/desc_partial_reception.h
index 7197e016..b9c8c6ac 100644
--- a/lib/include/libdvbv5/desc_partial_reception.h
+++ b/lib/include/libdvbv5/desc_partial_reception.h
@@ -22,15 +22,53 @@
  *	http://tdt.telecom.pt/recursos/apresentacoes/Signalling Specifications for DTT deployment in Portugal.pdf
  */
 
+/**
+ * @file desc_partial_reception.h
+ * @ingroup descriptors
+ * @brief Provides the descriptors for the ISDB partial reception descriptor
+ * @copyright GNU General Public License version 2 (GPLv2)
+ * @author Mauro Carvalho Chehab
+ * @author Andre Roth
+ *
+ * @par Relevant specs
+ * The descriptor described herein is defined at:
+ * - IEC/CENELEC DS/EN 62216-1:2011
+ *
+ * @see http://tdt.telecom.pt/recursos/apresentacoes/Signalling Specifications for DTT deployment in Portugal.pdf
+ *
+ * @par Bug Report
+ * Please submit bug reports and patches to linux-media@vger.kernel.org
+ */
+
+
 #ifndef _PARTIAL_RECEPTION_H
 #define _PARTIAL_RECEPTION_H
 
 #include <libdvbv5/descriptors.h>
 
+/**
+ * @struct isdb_partial_reception_service_id
+ * @ingroup descriptors
+ * @brief Service ID that uses partial reception
+ *
+ * @param service_id	service id
+ */
 struct isdb_partial_reception_service_id {
 	uint16_t service_id;
 } __attribute__((packed));
 
+/**
+ * @struct isdb_desc_partial_reception
+ * @ingroup descriptors
+ * @brief Structure containing the partial reception descriptor
+ *
+ * @param type			descriptor tag
+ * @param length		descriptor length
+ * @param next			pointer to struct dvb_desc
+ * @param partial_reception	vector of struct isdb_partial_reception_service_id.
+ *				The length of the vector is given by:
+ *				length / sizeof(struct isdb_partial_reception_service_id).
+ */
 struct isdb_desc_partial_reception {
 	uint8_t type;
 	uint8_t length;
@@ -45,8 +83,40 @@ struct dvb_v5_fe_parms;
 extern "C" {
 #endif
 
-int isdb_desc_partial_reception_init(struct dvb_v5_fe_parms *parms, const uint8_t *buf, struct dvb_desc *desc);
-void isdb_desc_partial_reception_print(struct dvb_v5_fe_parms *parms, const struct dvb_desc *desc);
+/**
+ * @brief Initializes and parses the ISDB-T partial reception descriptor
+ * @ingroup descriptors
+ *
+ * @param parms	struct dvb_v5_fe_parms pointer to the opened device
+ * @param buf	buffer containing the descriptor's raw data
+ * @param desc	pointer to struct dvb_desc to be allocated and filled
+ *
+ * This function allocates a the descriptor and fills the fields inside
+ * the struct. It also makes sure that all fields will follow the CPU
+ * endianness. Due to that, the content of the buffer may change.
+ *
+ * @return On success, it returns the size of the allocated struct.
+ *	   A negative value indicates an error.
+ */
+int isdb_desc_partial_reception_init(struct dvb_v5_fe_parms *parms,
+				     const uint8_t *buf, struct dvb_desc *desc);
+
+/**
+ * @brief Prints the content of the ISDB-T partial reception descriptor
+ * @ingroup descriptors
+ *
+ * @param parms	struct dvb_v5_fe_parms pointer to the opened device
+ * @param desc	pointer to struct dvb_desc
+ */
+void isdb_desc_partial_reception_print(struct dvb_v5_fe_parms *parms,
+				       const struct dvb_desc *desc);
+
+/**
+ * @brief Frees all data allocated by the ISDB-T partial reception descriptor
+ * @ingroup descriptors
+ *
+ * @param desc pointer to struct dvb_desc to be freed
+ */
 void isdb_desc_partial_reception_free(struct dvb_desc *desc);
 
 #ifdef __cplusplus