Doxygen: Move error handling stuff to error.c.

Also, add an overview mini-section to the main page instead.
This commit is contained in:
Uwe Hermann 2012-10-21 16:36:23 +02:00
parent 7b870c38e3
commit f21193fa03
2 changed files with 10 additions and 3 deletions

View File

@ -39,10 +39,14 @@
* <a href="http://sigrok.org/wiki/Input_output_formats">input/output * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
* file formats</a>. * file formats</a>.
* *
* @section sec_error_handling Error handling * @section sec_api API reference
* *
* libsigrok functions usually return @ref SR_OK upon success, or a negative * See the "Modules" page for an introduction to various libsigrok
* error code on failure. * related topics and the detailed API documentation of the respective
* functions.
*
* You can also browse the API documentation by file, or review all
* data structures.
* *
* @section sec_mailinglists Mailing lists * @section sec_mailinglists Mailing lists
* *

View File

@ -25,6 +25,9 @@
* *
* Error handling in libsigrok. * Error handling in libsigrok.
* *
* libsigrok functions usually return @ref SR_OK upon success, or a negative
* error code on failure.
*
* @{ * @{
*/ */