diff --git a/doc/Error-Codes.rst b/doc/Error-Codes.rst index 68d6483f..f97ae3ea 100644 --- a/doc/Error-Codes.rst +++ b/doc/Error-Codes.rst @@ -1,5 +1,9 @@ Error codes =========== -.. doxygenenum:: DeepSpeech_Error_Codes - :project: deepspeech-c +Below is the definition for all error codes used in the API, their numerical values, and a human readable description. + +.. literalinclude:: ../native_client/deepspeech.h + :language: c + :start-after: sphinx-doc: error_code_listing_start + :end-before: sphinx-doc: error_code_listing_end diff --git a/doc/examples b/doc/examples index 81a06eea..6f5f501f 160000 --- a/doc/examples +++ b/doc/examples @@ -1 +1 @@ -Subproject commit 81a06eea64d1dda734f6b97b3005b4416ac2f50a +Subproject commit 6f5f501fa62743f1b78fe162eb1a579a450bd38f diff --git a/native_client/deepspeech.h b/native_client/deepspeech.h index b9c0e8e9..1df3cf2e 100644 --- a/native_client/deepspeech.h +++ b/native_client/deepspeech.h @@ -59,6 +59,7 @@ typedef struct Metadata { const unsigned int num_transcripts; } Metadata; +// sphinx-doc: error_code_listing_start #define DS_FOR_EACH_ERROR(APPLY) \ 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_MODEL, 0x3007, "Could not allocate model state.") +// sphinx-doc: error_code_listing_end + enum DeepSpeech_Error_Codes { #define DEFINE(NAME, VALUE, DESC) NAME = VALUE,