Commit 23cec134 authored by Jean-Paul Saman's avatar Jean-Paul Saman

src/psi.{c,h}: update documentation

parent f53ea0e5
......@@ -96,7 +96,7 @@ bool dvbpsi_ValidPSISection(dvbpsi_psi_section_t* p_section)
{
if (p_section->b_syntax_indicator)
{
/* Check the CRC_32 if b_syntax_indicator is 0 */
/* Check the CRC_32 if b_syntax_indicator is false */
uint32_t i_crc = 0xffffffff;
uint8_t* p_byte = p_section->p_data;
......@@ -113,7 +113,7 @@ bool dvbpsi_ValidPSISection(dvbpsi_psi_section_t* p_section)
}
else
{
/* No check to do if b_syntax_indicator is 0 */
/* No check to do if b_syntax_indicator is false */
return false;
}
}
......
......@@ -49,17 +49,17 @@ extern "C" {
* dvbpsi_psi_section_s::p_data stores the complete section including the
* header.
*
* When dvbpsi_psi_section_s::b_syntax_indicator == 0,
* When dvbpsi_psi_section_s::b_syntax_indicator == false,
* dvbpsi_psi_section_s::p_payload_start points immediately after the
* section_length field and dvbpsi_psi_section_s::p_payload_end points
* immediately after the end of the section (don't try to access this byte).
*
* When dvbpsi_psi_section_s::b_syntax_indicator != 0,
* When dvbpsi_psi_section_s::b_syntax_indicator != false,
* dvbpsi_psi_section_s::p_payload_start points immediately after the
* last_section_number field and dvbpsi_psi_section_s::p_payload_end points to
* the first byte of the CRC_32 field.
*
* When dvbpsi_psi_section_s::b_syntax_indicator == 0
* When dvbpsi_psi_section_s::b_syntax_indicator == false
* dvbpsi_psi_section_s::i_extension, dvbpsi_psi_section_s::i_version,
* dvbpsi_psi_section_s::b_current_next, dvbpsi_psi_section_s::i_number,
* dvbpsi_psi_section_s::i_last_number, and dvbpsi_psi_section_s::i_crc are
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment