experiments/STT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Include error descriptions in documentation page

Browse Source
This commit is contained in:
Reuben Morais 2020-05-18 17:41:53 +02:00
parent 361e216297
commit bfd90f1f9b
3 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/Error-Codes.rst
View File

@ -1,5 +1,9 @@
Error codes Error codes
=========== ===========
.. doxygenenum:: DeepSpeech_Error_Codes Below is the definition for all error codes used in the API, their numerical values, and a human readable description.
:project: deepspeech-c
.. literalinclude:: ../native_client/deepspeech.h
:language: c
:start-after: sphinx-doc: error_code_listing_start
:end-before: sphinx-doc: error_code_listing_end

2
doc/examples

@ -1 +1 @@
Subproject commit 81a06eea64d1dda734f6b97b3005b4416ac2f50a Subproject commit 6f5f501fa62743f1b78fe162eb1a579a450bd38f

3
native_client/deepspeech.h
View File

@ -59,6 +59,7 @@ typedef struct Metadata {
const unsigned int num_transcripts; const unsigned int num_transcripts;
} Metadata; } Metadata;
// sphinx-doc: error_code_listing_start
#define DS_FOR_EACH_ERROR(APPLY) \ #define DS_FOR_EACH_ERROR(APPLY) \
APPLY(DS_ERR_OK, 0x0000, "No error.") \ APPLY(DS_ERR_OK, 0x0000, "No error.") \
@ -82,6 +83,8 @@ typedef struct Metadata {
APPLY(DS_ERR_FAIL_CREATE_SESS, 0x3006, "Failed to create session.") \ APPLY(DS_ERR_FAIL_CREATE_SESS, 0x3006, "Failed to create session.") \
APPLY(DS_ERR_FAIL_CREATE_MODEL, 0x3007, "Could not allocate model state.") APPLY(DS_ERR_FAIL_CREATE_MODEL, 0x3007, "Could not allocate model state.")
// sphinx-doc: error_code_listing_end
enum DeepSpeech_Error_Codes enum DeepSpeech_Error_Codes
{ {
#define DEFINE(NAME, VALUE, DESC) NAME = VALUE, #define DEFINE(NAME, VALUE, DESC) NAME = VALUE,