Merge pull request #2458 from lissyx/doc-dotnet
Add .Net Framework API doc
This commit is contained in:
commit
bde5c31fd4
36
doc/DotNet-API.rst
Normal file
36
doc/DotNet-API.rst
Normal file
@ -0,0 +1,36 @@
|
||||
.Net Framework
|
||||
==============
|
||||
|
||||
DeepSpeech Interface
|
||||
--------------------
|
||||
|
||||
.. doxygeninterface:: DeepSpeechClient::Interfaces::IDeepSpeech
|
||||
:project: deepspeech-dotnet
|
||||
:members:
|
||||
|
||||
DeepSpeech Class
|
||||
----------------
|
||||
|
||||
.. doxygenclass:: DeepSpeechClient::DeepSpeech
|
||||
:project: deepspeech-dotnet
|
||||
:members:
|
||||
|
||||
ErrorCodes
|
||||
----------
|
||||
|
||||
.. doxygenenum:: DeepSpeechClient::Enums::ErrorCodes
|
||||
:project: deepspeech-dotnet
|
||||
|
||||
Metadata
|
||||
--------
|
||||
|
||||
.. doxygenstruct:: DeepSpeechClient::Structs::Metadata
|
||||
:project: deepspeech-dotnet
|
||||
:members: items, num_items, confidence
|
||||
|
||||
MetadataItem
|
||||
------------
|
||||
|
||||
.. doxygenstruct:: DeepSpeechClient::Structs::MetadataItem
|
||||
:project: deepspeech-dotnet
|
||||
:members: character, timestep, start_time
|
@ -8,6 +8,8 @@ SPHINXPROJ = DeepSpeech
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = .build
|
||||
|
||||
PIP_INSTALL ?= pip3 install --user
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
@ -20,8 +22,11 @@ doxygen-c:
|
||||
doxygen-java:
|
||||
cd ../ && doxygen doc/doxygen-java.conf
|
||||
|
||||
doxygen-dotnet:
|
||||
cd ../ && doxygen doc/doxygen-dotnet.conf
|
||||
|
||||
pip3:
|
||||
pip3 install --user -r ../taskcluster/docs-requirements.txt
|
||||
$(PIP_INSTALL) -r ../taskcluster/docs-requirements.txt
|
||||
|
||||
npm:
|
||||
npm install jsdoc@3.6.3
|
||||
@ -34,5 +39,5 @@ dist: html
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile pip3 npm doxygen-c doxygen-java
|
||||
%: Makefile pip3 npm doxygen-c doxygen-java doxygen-dotnet
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
@ -31,6 +31,7 @@ if read_the_docs_build:
|
||||
import subprocess
|
||||
subprocess.call('cd ../ && doxygen doc/doxygen-c.conf', shell=True)
|
||||
subprocess.call('cd ../ && doxygen doc/doxygen-java.conf', shell=True)
|
||||
subprocess.call('cd ../ && doxygen doc/doxygen-dotnet.conf', shell=True)
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
@ -75,6 +76,7 @@ extensions = [
|
||||
breathe_projects = {
|
||||
"deepspeech-c": "xml-c/",
|
||||
"deepspeech-java": "xml-java/",
|
||||
"deepspeech-dotnet": "xml-dotnet/",
|
||||
}
|
||||
|
||||
js_source_path = "../native_client/javascript"
|
||||
|
2494
doc/doxygen-dotnet.conf
Normal file
2494
doc/doxygen-dotnet.conf
Normal file
File diff suppressed because it is too large
Load Diff
@ -33,10 +33,12 @@ Welcome to DeepSpeech's documentation!
|
||||
|
||||
C-API
|
||||
|
||||
NodeJS-API
|
||||
DotNet-API
|
||||
|
||||
Java-API
|
||||
|
||||
NodeJS-API
|
||||
|
||||
Python-API
|
||||
|
||||
.. toctree::
|
||||
|
Loading…
Reference in New Issue
Block a user