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

Merge pull request #3460 from mozilla/more-doc-fixes

Browse Source 
More documentation fixes
This commit is contained in:
Reuben Morais 2020-12-08 15:42:11 +02:00 committed by GitHub
commit b3b9e268a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/Java-Examples.rst
View File

@ -1,12 +1,12 @@
Java API Usage example
======================
Examples are from `native_client/java/app/src/main/java/org/mozilla/deepspeech/DeepSpeechActivity.java`.
Examples are from `native_client/java/app/src/main/java/org/deepspeech/DeepSpeechActivity.java`.
Creating a model instance and loading model
-------------------------------------------
.. literalinclude:: ../native_client/java/app/src/main/java/org/mozilla/deepspeech/DeepSpeechActivity.java
.. literalinclude:: ../native_client/java/app/src/main/java/org/deepspeech/DeepSpeechActivity.java
:language: java
:linenos:
:lineno-match:
@ -16,7 +16,7 @@ Creating a model instance and loading model
Performing inference
--------------------
.. literalinclude:: ../native_client/java/app/src/main/java/org/mozilla/deepspeech/DeepSpeechActivity.java
.. literalinclude:: ../native_client/java/app/src/main/java/org/deepspeech/DeepSpeechActivity.java
:language: java
:linenos:
:lineno-match:
@ -26,4 +26,4 @@ Performing inference
Full source code
----------------
See :download:`Full source code<../native_client/java/app/src/main/java/org/mozilla/deepspeech/DeepSpeechActivity.java>`.
See :download:`Full source code<../native_client/java/app/src/main/java/org/deepspeech/DeepSpeechActivity.java>`.

2
doc/NodeJS-API.rst
View File

@ -10,7 +10,7 @@ Model
Stream
------
.. js:autoclass:: Stream
.. js:autoclass:: StreamImpl
:members:
Module exported methods

2
doc/doxygen-java.conf
View File

@ -790,7 +790,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = native_client/java/libdeepspeech/src/main/java/org/mozilla/deepspeech/libdeepspeech/ native_client/java/libdeepspeech/src/main/java/org/mozilla/deepspeech/libdeepspeech_doc/
INPUT = native_client/java/libdeepspeech/src/main/java/org/deepspeech/libdeepspeech/ native_client/java/libdeepspeech/src/main/java/org/deepspeech/libdeepspeech_doc/
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

0
native_client/java/app/src/androidTest/java/org/mozilla/deepspeech/ExampleInstrumentedTest.java → native_client/java/app/src/androidTest/java/org/deepspeech/ExampleInstrumentedTest.java
View File

0
native_client/java/app/src/main/java/org/mozilla/deepspeech/DeepSpeechActivity.java → native_client/java/app/src/main/java/org/deepspeech/DeepSpeechActivity.java
View File

0
native_client/java/app/src/test/java/org/mozilla/deepspeech/ExampleUnitTest.java → native_client/java/app/src/test/java/org/deepspeech/ExampleUnitTest.java
View File

6
native_client/javascript/index.ts
View File

@ -306,9 +306,9 @@ export class Model {
}
/**
* Create a new streaming inference state. One can then call :js:func:`Stream.feedAudioContent` and :js:func:`Stream.finishStream` on the returned stream object.
* Create a new streaming inference state. One can then call :js:func:`StreamImpl.feedAudioContent` and :js:func:`StreamImpl.finishStream` on the returned stream object.
*
* @return a :js:func:`Stream` object that represents the streaming state.
* @return a :js:func:`StreamImpl` object that represents the streaming state.
*
* @throws on error
*/
@ -334,7 +334,7 @@ export function FreeModel(model: Model): void {
/**
* Free memory allocated for metadata information.
*
* @param metadata Object containing metadata as returned by :js:func:`Model.sttWithMetadata` or :js:func:`Stream.finishStreamWithMetadata`
* @param metadata Object containing metadata as returned by :js:func:`Model.sttWithMetadata` or :js:func:`StreamImpl.finishStreamWithMetadata`
*/
export function FreeMetadata(metadata: Metadata): void {
binding.FreeMetadata(metadata);