Commit ee0610c6 authored by Jean-Paul Saman's avatar Jean-Paul Saman

src/descriptor.h: Document that descriptor functions return NULL on error.

Descriptors generators and decoders return NULL on error and a pointer to
the descriptor structure on success.
parent ffa65b4e
......@@ -27,6 +27,9 @@
* \brief Common descriptor tools.
*
* Descriptor structure and its Manipulation tools.
*
* NOTE: Descriptor generators and decoder functions return a pointer on success
* and NULL on error. They do not use a dvbpsi_t handle as first argument.
*/
#ifndef _DVBPSI_DESCRIPTOR_H_
......
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