Skip to content

Commit

Permalink
Code autogenerated from Kurento/doc-kurento@7f62479
Browse files Browse the repository at this point in the history
  • Loading branch information
jenkinskurento committed Jun 17, 2020
1 parent b072cb4 commit 720492d
Show file tree
Hide file tree
Showing 342 changed files with 1,104 additions and 970 deletions.
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ help:
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@echo " langdoc to make JavaDocs and JsDocs of the Kurento Clients"
@echo " dist to make <langdoc html epub latexpdf> and then pack"
@echo " all resulting files as kurento-doc-6.13.2.tgz"
@echo " all resulting files as kurento-doc-6.14.0.tgz"
@echo " readthedocs to make <langdoc> and then copy the results to the"
@echo " Sphinx theme's static folder"
@echo ""
Expand Down Expand Up @@ -62,7 +62,7 @@ langdoc-client-java: langdoc-init
cd $(WORKPATH)
git clone https://github.com/Kurento/kurento-java.git
cd kurento-java
[ "false" = "true" ] && git checkout "6.13.1"
[ "true" = "true" ] && git checkout "6.14.0"
cd kurento-client || { echo "ERROR: 'cd' failed, ls:"; ls -lA; exit 1; }
mvn --batch-mode --quiet clean package \
-DskipTests || { echo "ERROR: 'mvn clean' failed"; exit 1; }
Expand All @@ -76,7 +76,7 @@ langdoc-client-js: langdoc-init
cd $(WORKPATH)
git clone https://github.com/Kurento/kurento-client-js.git
cd kurento-client-js
[ "false" = "true" ] && git checkout "6.13.0"
[ "true" = "true" ] && git checkout "6.14.0"
npm install --no-color
node_modules/.bin/grunt --no-color --force jsdoc \
|| { echo "ERROR: 'grunt jsdoc' failed"; exit 1; }
Expand All @@ -86,7 +86,7 @@ langdoc-utils-js: langdoc-init
cd $(WORKPATH)
git clone https://github.com/Kurento/kurento-utils-js.git
cd kurento-utils-js
[ "false" = "true" ] && git checkout "6.13.1"
[ "true" = "true" ] && git checkout "6.14.0"
npm install --no-color
node_modules/.bin/grunt --no-color --force jsdoc \
|| { echo "ERROR: 'grunt jsdoc' failed"; exit 1; }
Expand All @@ -95,7 +95,7 @@ langdoc-utils-js: langdoc-init
langdoc: langdoc-client-java langdoc-client-js langdoc-utils-js

dist: langdoc html epub latexpdf
$(eval DISTDIR := $(BUILDDIR)/dist/kurento-doc-6.13.2)
$(eval DISTDIR := $(BUILDDIR)/dist/kurento-doc-6.14.0)
mkdir -p $(DISTDIR)
rsync -a $(BUILDDIR)/html $(BUILDDIR)/epub/Kurento.epub \
$(BUILDDIR)/latex/Kurento.pdf $(DISTDIR)
Expand Down
20 changes: 10 additions & 10 deletions VERSIONS.conf.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,32 @@
# shellcheck disable=SC2034
declare -A PROJECT_VERSIONS=(
# Version of the documentation itself; it appears in the main menu
[VERSION_DOC]="6.13.2"
[VERSION_DOC]="6.14.0"

# Version of Kurento Media Server
[VERSION_KMS]="6.13.2"
[VERSION_KMS]="6.14.0"

# Version of each Client API SDK
[VERSION_CLIENT_JAVA]="6.13.1"
[VERSION_CLIENT_JS]="6.13.0"
[VERSION_CLIENT_JAVA]="6.14.0"
[VERSION_CLIENT_JS]="6.14.0"

# Version of the JavaScript utils module (kurento-utils-js)
[VERSION_UTILS_JS]="6.13.1"
[VERSION_UTILS_JS]="6.14.0"

# Version of each platform's tutorials
[VERSION_TUTORIAL_JAVA]="6.13.0"
[VERSION_TUTORIAL_JS]="6.13.0"
[VERSION_TUTORIAL_NODE]="6.13.0"
[VERSION_TUTORIAL_JAVA]="6.14.0"
[VERSION_TUTORIAL_JS]="6.14.0"
[VERSION_TUTORIAL_NODE]="6.14.0"

# Indicates if the current state of this code is Release or Nightly.
# If "true", all mentioned repos will be checked out to the corresponding
# versions; otherwise, they will be kept at the default branch (master).
[VERSION_RELEASE]="false"
[VERSION_RELEASE]="true"
)

# If the build is not a release build, then some versions can be set to more
# adequate values for each case:
if [[ "${PROJECT_VERSIONS[VERSION_RELEASE]}" == "false" ]]; then
if [[ "${PROJECT_VERSIONS[VERSION_RELEASE]}" == "true" ]]; then
# VERSION_TUTORIAL_{JAVA,JS,NODE} are used in tutorial texts to instruct the
# user about running `git checkout <Version>`, so making it "master" will
# keep them at the development versions on non-release builds of the docs.
Expand Down
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
# built documents.
#
# The short X.Y version.
version = '6.13.2'
version = '6.14.0'

# The full version, including alpha/beta/rc tags.
release = version
Expand Down
4 changes: 2 additions & 2 deletions source/dev/writing_documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Our Sphinx-based project is hosted in the `doc-kurento`_ repository. Here, the m

- **init-workdir**. This target constitutes the first step to be run before most other targets. Our documentation source files contain substitution keywords in some parts, in the form ``| KEYWORD |``, which is expected to be substituted by some actual value during the generation process. Currently, the only keyword in use is ``VERSION``, which must be expanded to the actual version of the documentation being built.

For example, here is the *VERSION_KMS* keyword when substituted with its final value: ``6.13.2``.
For example, here is the *VERSION_KMS* keyword when substituted with its final value: ``6.14.0``.

Yes, Sphinx does already include a substitutions feature by itself, and the keyword ``VERSION`` is precisely one of the supported substitutions. Sadly, this feature of Sphinx is very unreliable. For example, it won't work if the keyword is located inside a literal code block, or inside an URL. So, we must resort to performing the substitutions by ourselves if we want reliable results.

Expand All @@ -196,6 +196,6 @@ In order to overcome this limitation, we opted for the simple solution of handli
1. Read The Docs has been configured to watch for changes in the `doc-kurento-readthedocs`_ repo, instead of *doc-kurento*.
2. The *init-workdir* and *langdoc* targets run locally from our *doc-kurento* repo.
3. The resulting files from those targets are copied as-is to the *doc-kurento-readthedocs* repository.
4. Everything is then committed and pushed to this later repo, thus triggering a new RTD build.
4. Everything is then committed and pushed to this latter repo, thus triggering a new RTD build.

.. _doc-kurento-readthedocs: https://github.com/Kurento/doc-kurento-readthedocs
2 changes: 1 addition & 1 deletion source/features/kurento_utils_js.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ How to use it
=============

* **Minified file** - Download the file from
`here <http://builds.openvidu.io/release/6.13.1/js/kurento-utils.min.js>`__.
`here <http://builds.openvidu.io/release/6.14.0/js/kurento-utils.min.js>`__.


* **NPM** - Install and use library in your NodeJS files.
Expand Down
2 changes: 1 addition & 1 deletion source/knowledge/nat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Meaning: Some host initiated an outbound packet transmission from the IP address
Types of NAT
============

There are two categories of NAT behavior, namely **Cone** and **Symmetric** NAT. The crucial difference between them is that the former will use the same port numbers for internal and external transport addresses, while the later will always use different numbers for each side of the NAT. This will be explained later in more detail.
There are two categories of NAT behavior, namely **Cone** and **Symmetric** NAT. The crucial difference between them is that the former will use the same port numbers for internal and external transport addresses, while the latter will always use different numbers for each side of the NAT. This will be explained later in more detail.

Besides, there are 3 types of Cone NATs, with varying degrees of restrictions regarding the allowed sources of inbound transmissions. To connect with a local host which is behind a Cone NAT, it's first required that the local host performs an outbound transmission to a remote one. This way, a dynamic rule will be created for the destination transport address, allowing the remote host to connect back. The only exception is the Full Cone NAT, where a static rule can be created beforehand by an administrator, thanks to the fact that this kind of NAT ignores what is the source transport address of the remote host that is connecting.

Expand Down
4 changes: 2 additions & 2 deletions source/langdoc/client-javadoc/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -90,7 +90,7 @@ <h2 title="Contents">Contents</h2>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
4 changes: 2 additions & 2 deletions source/langdoc/client-javadoc/deprecated-list.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -276,7 +276,7 @@ <h2 title="Contents">Contents</h2>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
4 changes: 2 additions & 2 deletions source/langdoc/client-javadoc/help-doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<li><a href="index-all.html">Index</a></li>
<li class="navBarCell1Rev">Help</li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -191,7 +191,7 @@ <h2>Constant Field Values</h2>
<li><a href="index-all.html">Index</a></li>
<li class="navBarCell1Rev">Help</li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
16 changes: 8 additions & 8 deletions source/langdoc/client-javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -1367,15 +1367,15 @@ <h2 class="title">G</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalAddress--">getExternalAddress()</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
<dd>
<div class="block">Get External (public) IP address of the media server.</div>
<div class="block">Get External IP address of the media server.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalAddress-org.kurento.client.Continuation-">getExternalAddress(Continuation&lt;String&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
<dd>
<div class="block">Get External (public) IP address of the media server.</div>
<div class="block">Get External IP address of the media server.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalAddress-org.kurento.client.Transaction-">getExternalAddress(Transaction)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
<dd>
<div class="block">Get External (public) IP address of the media server.</div>
<div class="block">Get External IP address of the media server.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/kurento/client/ModuleInfo.html#getFactories--">getFactories()</a></span> - Method in class org.kurento.client.<a href="org/kurento/client/ModuleInfo.html" title="class in org.kurento.client">ModuleInfo</a></dt>
<dd>
Expand Down Expand Up @@ -4074,15 +4074,15 @@ <h2 class="title">S</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String-">setExternalAddress(String)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
<dd>
<div class="block">Set External (public) IP address of the media server.</div>
<div class="block">Set External IP address of the media server.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String-org.kurento.client.Continuation-">setExternalAddress(String, Continuation&lt;Void&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
<dd>
<div class="block">Set External (public) IP address of the media server.</div>
<div class="block">Set External IP address of the media server.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String-org.kurento.client.Transaction-">setExternalAddress(String, Transaction)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
<dd>
<div class="block">Set External (public) IP address of the media server.</div>
<div class="block">Set External IP address of the media server.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/kurento/client/ModuleInfo.html#setFactories-java.util.List-">setFactories(List&lt;String&gt;)</a></span> - Method in class org.kurento.client.<a href="org/kurento/client/ModuleInfo.html" title="class in org.kurento.client">ModuleInfo</a></dt>
<dd>
Expand Down Expand Up @@ -5489,7 +5489,7 @@ <h2 class="title">Z</h2>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -364,7 +364,7 @@ <h4>with</h4>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -279,7 +279,7 @@ <h4>with</h4>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -399,7 +399,7 @@ <h4>setPortProperties</h4>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -297,7 +297,7 @@ <h4>setBitrate</h4>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -305,7 +305,7 @@ <h4>valueOf</h4>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down

0 comments on commit 720492d

Please sign in to comment.