Skip to content

Commit

Permalink
Code autogenerated from Kurento/doc-kurento@81bacee
Browse files Browse the repository at this point in the history
  • Loading branch information
jenkinskurento committed Dec 1, 2020
1 parent 164b406 commit f5326d9
Show file tree
Hide file tree
Showing 40 changed files with 406 additions and 469 deletions.
2 changes: 1 addition & 1 deletion source/dev/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The documentation of Kurento includes a number of tutorials `tutorials <https://
API
---

The `Kurento API <https://doc-kurento.readthedocs.io/en/latest/features/kurento_api.html>`_ is available in two languages: Java and JavaScript. For both of them, a test suite has been created to verify the correctness of the Kurento API against a running instance of KMS. In you want to run API tests for Java, as usual for Kurento tests, Maven is required, as follows:
Kurento provides :doc:`Java and JavaScript clients </features/kurento_client>` that implement the :doc:`/features/kurento_protocol`. For both of them, a test suite has been created to verify the correctness of the Kurento API against a running instance of KMS. In you want to run API tests for Java, as usual for Kurento tests, Maven is required, as follows:

.. code-block:: shell
Expand Down
2 changes: 1 addition & 1 deletion source/dev/writing_documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Our Sphinx-based project is hosted in the `doc-kurento <https://github.com/Kuren

The way this works is that the *source* folder gets copied into the *build* directory, and then the substitutions take place over this copy.

* **langdoc**. This target creates the automatically generated reference documentation for each :doc:`/features/kurento_client`. Currently, this means the Javadoc and Jsdoc documentations for Java and Js clients, respectively. The Kurento client repositories are checked out in the same version as specified by the documentation version file, or in the master branch if no such version tag exists. Then, the client stubs of the :doc:`/features/kurento_api` are automatically generated, and from the resulting source files, the appropriate documentation is automatically generated too.
* **langdoc**. This target creates the automatically generated reference documentation for each :doc:`/features/kurento_client`. Currently, this means the Javadoc and Jsdoc documentations for Java and Js clients, respectively. The Kurento client repositories are checked out in the same version as specified by the documentation version file, or in the master branch if no such version tag exists. Then, the client stubs of the :doc:`/features/kurento_modules` are automatically generated, and from the resulting source files, the appropriate documentation is automatically generated too.

The *langdoc* target is usually run before the *html* target, in order to end up with a complete set of HTML documents that include all the reST documentation with the Javadoc/Jsdoc sections.

Expand Down
133 changes: 0 additions & 133 deletions source/features/kurento_api.rst

This file was deleted.

2 changes: 1 addition & 1 deletion source/features/kurento_client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Kurento Client
==============

Currently, the Kurento project provides implementations of the :doc:`Kurento API </features/kurento_api>` for two programming languages: *Java* and *JavaScript*.
Currently, the Kurento project provides implementations of the :doc:`/features/kurento_protocol` for two programming languages: *Java* and *JavaScript*.

In the future, additional Kurento Clients can be created, exposing the same kind of modularity in other languages such as Python, C/C++, PHP, etc.

Expand Down

0 comments on commit f5326d9

Please sign in to comment.