Code autogenerated from Kurento/doc-kurento@0de07a0

Kurento · Dec 20, 2021 · 1a09a5a · 1a09a5a
1 parent f182322
commit 1a09a5a
Show file tree

Hide file tree

Showing 319 changed files with 856 additions and 842 deletions.
diff --git a/Makefile b/Makefile
@@ -65,7 +65,7 @@ langdoc-client-java: langdoc-init
 	cd kurento-java
 	[ "false" = "true" ] && git checkout "6.16.0"
 	cd kurento-client || { echo "ERROR: 'cd' failed, ls:"; ls -lA; exit 1; }
-	mvn --batch-mode --quiet clean package \
+	mvn --batch-mode --quiet -Psnapshots clean package \
 		-DskipTests || { echo "ERROR: 'mvn clean' failed"; exit 1; }
 	mvn --batch-mode --quiet javadoc:javadoc \
 		-DreportOutputDirectory="$(DESTPATH)" -DdestDir="client-javadoc" \

diff --git a/configure.sh b/configure.sh
@@ -4,14 +4,15 @@
 #/ Initialization script for Kurento documentation.
 #/
 #/ This shell script prepares the sources for building. The main work done here
-#/ is replacing all placeholder variables with their actual values, as defined
-#/ in 'VERSIONS.env'.
+#/ is replacing all |PLACEHOLDER| variables with their actual values, as defined
+#/ in `VERSIONS.env`.
 #/
 #/ Arguments: None.
 
 
 
-# ------------ Shell setup ------------
+# Shell setup
+# ===========
 
 # Shell options for strict error checking
 set -o errexit -o errtrace -o pipefail -o nounset
@@ -32,29 +33,35 @@ log() { echo "[$BASENAME] $*"; }
 
 
 
-# ------------ Script start ------------
-
-# ---- Load VERSIONS file ----
+# Load VERSIONS file
+# ==================
 
 BASEPATH="$(cd -P -- "$(dirname -- "$0")" && pwd -P)"  # Absolute canonical path
+
 CONF_FILE="$BASEPATH/VERSIONS.env"
+
 [[ -f "$CONF_FILE" ]] || {
     log "ERROR: Shell config file not found: $CONF_FILE"
     exit 1
 }
+
 # shellcheck source=VERSIONS.env
 source "$CONF_FILE"
 
 
 
-# ---- Put actual values in their placeholders ----
+# Replace placeholders
+# ====================
 
 # This expects a Bash Associative Array;
-# enumerates all entries to use their name and values
+# enumerates all entries to use their name and values.
+
 for NAME in "${!PROJECT_VERSIONS[@]}"; do
     VALUE="${PROJECT_VERSIONS[$NAME]}"
 
+    # Use long option names for readability. Equivalent to this:
     # grep -lIrZ -- '<OldPattern>' | xargs -0 -L1 -r sed -i -e 's/<OldPattern>/<NewPattern>/g'
+
     grep \
         --files-with-matches \
         --binary-files=without-match \

diff --git a/requirements.txt b/requirements.txt
@@ -6,7 +6,7 @@
 #     python3 -m venv python_modules
 #     source python_modules/bin/activate
 #
-#     # Install Sphinx and the Read the Docs theme
+#     # Install packages
 #     python -m pip install --upgrade -r requirements.txt
 
 Sphinx~=3.5.4

diff --git a/source/dev/release.rst b/source/dev/release.rst
@@ -520,8 +520,7 @@ Release steps
            || { echo "ERROR: Uncommitted files not allowed!"; return 1; }
 
            # Check latest changes from the main branch.
-           # FIXME UPGRADE 16.04: Newer versions of git allow running `git pull --rebase --autostash`.
-           git fetch && git rebase --autostash \
+           git pull --rebase --autostash \
            || { echo "ERROR: Command failed: git pull"; return 1; }
 
            # Set the new version.
@@ -748,12 +747,11 @@ Release steps
            || { echo "ERROR: Uncommitted files not allowed!"; return 1; }
 
            # Check latest changes from the main branch.
-           # FIXME UPGRADE 16.04: Newer versions of git allow running `git pull --rebase --autostash`.
-           git fetch && git rebase --autostash \
+           git pull --rebase --autostash \
            || { echo "ERROR: Command failed: git pull"; return 1; }
 
            # Set the new version.
-           ./bin/set-versions.sh "$NEW_VERSION" --release --git-add \
+           ./bin/set-versions.sh "$NEW_VERSION" --kms-api "$NEW_VERSION" --release --git-add \
            || { echo "ERROR: Command failed: set-versions"; return 1; }
 
            # Check there are no development versions in any of the dependencies.
@@ -868,7 +866,7 @@ New Development
            pushd "$PROJECT" || { echo "ERROR: Command failed: pushd"; return 1; }
 
            # Set the new version.
-           ./bin/set-versions.sh "$NEW_VERSION" --git-add \
+           ./bin/set-versions.sh "$NEW_VERSION" --kms-api "$NEW_VERSION-SNAPSHOT" --git-add \
            || { echo "ERROR: Command failed: set-versions"; return 1; }
 
            # Install the project.

diff --git a/source/dev/writing_documentation.rst b/source/dev/writing_documentation.rst
@@ -181,6 +181,19 @@ Header conventions
 
 
 
+Comments
+--------
+
+It is possible to include hidden comments, which work just like commented-out lines in any programming language. For this, use two dots in a single line, followed by indented text. For example:
+
+.. code-block:: text
+
+   ..
+      These lines are commented out, and won't appear in the final output.
+      You can put here some notes about the text itself.
+
+
+
 Sphinx documentation generator
 ==============================
 

diff --git a/source/features/security.rst b/source/features/security.rst
@@ -234,7 +234,7 @@ Alternatively, an already existing certificate can be provided to be used for al
 .. code-block:: shell
 
    # Make a single file to be used with Kurento Media Server.
-   cat cert.pem key.pem > cert+key.pem
+   cat cert.pem key.pem >cert+key.pem
 
 Then, :ref:`configure <configuration-dtls>` the path to ``cert+key.pem``.
 

diff --git a/source/langdoc/client-javadoc/constant-values.html b/source/langdoc/client-javadoc/constant-values.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/deprecated-list.html b/source/langdoc/client-javadoc/deprecated-list.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -306,7 +306,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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/help-doc.html b/source/langdoc/client-javadoc/help-doc.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/index-all.html b/source/langdoc/client-javadoc/index-all.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -2845,6 +2845,8 @@ <h2 class="title">I</h2>
 <dd>
 <div class="block">Returns <tt>true</tt> if the transaction associated to this future is committed.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/KurentoClient.html#isDestroyed--">isDestroyed()</a></span> - Method in class org.kurento.client.<a href="org/kurento/client/KurentoClient.html" title="class in org.kurento.client">KurentoClient</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/MediaElement.html#isMediaFlowingIn-org.kurento.client.MediaType-java.lang.String-">isMediaFlowingIn(MediaType, String)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a></dt>
 <dd>
 <div class="block">This method indicates whether the media element is receiving media of a certain type.</div>
@@ -5622,7 +5624,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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AbstractBuilder.html b/source/langdoc/client-javadoc/org/kurento/client/AbstractBuilder.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AlphaBlending.Builder.html b/source/langdoc/client-javadoc/org/kurento/client/AlphaBlending.Builder.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AlphaBlending.html b/source/langdoc/client-javadoc/org/kurento/client/AlphaBlending.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AudioCaps.html b/source/langdoc/client-javadoc/org/kurento/client/AudioCaps.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AudioCodec.html b/source/langdoc/client-javadoc/org/kurento/client/AudioCodec.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/BaseRtpEndpoint.html b/source/langdoc/client-javadoc/org/kurento/client/BaseRtpEndpoint.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -1792,7 +1792,7 @@ <h4>removeConnectionStateChangedListener</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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/CertificateKeyType.html b/source/langdoc/client-javadoc/org/kurento/client/CertificateKeyType.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -293,7 +293,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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/CodeFoundEvent.html b/source/langdoc/client-javadoc/org/kurento/client/CodeFoundEvent.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -343,7 +343,7 @@ <h4>setValue</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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/CodecConfiguration.html b/source/langdoc/client-javadoc/org/kurento/client/CodecConfiguration.html
@@ -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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -277,7 +277,7 @@ <h4>setProperties</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.16.1</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.16.3-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">