ambiser
/
openvidu
mirror of https://github.com/OpenVidu/openvidu.git
8
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

openvidu-java-client: JavaDoc rest of links fixed

pull/431/head
pabloFuente 2020-04-05 20:58:02 +02:00
parent ae92f7d06b
commit b182b8b30e
6 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
openvidu-java-client/generate-docs.sh
View File

@ -6,7 +6,7 @@ if [[ -z "$BASEHREF_VERSION" ]]; then
fi fi
# Replace version from "stable" to the specified one in all Javadoc links # Replace version from "stable" to the specified one in all Javadoc links
grep -rl 'href="/en/stable/' ./src | xargs sed -i -e 's|href="/en/stable/|href="/en/'${BASEHREF_VERSION}'/|g' grep -rl '"/en/stable/' ./src | xargs sed -i -e 's|"/en/stable/|"/en/'${BASEHREF_VERSION}'/|g'
# Generate JavaDoc # Generate JavaDoc
mvn javadoc:javadoc mvn javadoc:javadoc
@ -14,7 +14,7 @@ rm -rf ../../openvidu.io/api/openvidu-java-client/*
cp -R ./target/site/apidocs/. ../../openvidu.io-docs/docs/api/openvidu-java-client cp -R ./target/site/apidocs/. ../../openvidu.io-docs/docs/api/openvidu-java-client
# Return links to "stable" version # Return links to "stable" version
grep -rl 'href="/en/'${BASEHREF_VERSION}'/' ./src | xargs sed -i -e 's|href="/en/'${BASEHREF_VERSION}'/|href="/en/stable/|g' grep -rl '"/en/'${BASEHREF_VERSION}'/' ./src | xargs sed -i -e 's|"/en/'${BASEHREF_VERSION}'/|"/en/stable/|g'
# Add favicon to index.html # Add favicon to index.html
sed -i -e 's/<head>/<head><link rel=\"shortcut icon\" href=\"\/img\/favicon.ico\" type=\"image\/x-icon\">/g' ../../openvidu.io-docs/docs/api/openvidu-java-client/index.html sed -i -e 's/<head>/<head><link rel=\"shortcut icon\" href=\"\/img\/favicon.ico\" type=\"image\/x-icon\">/g' ../../openvidu.io-docs/docs/api/openvidu-java-client/index.html

13
openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java
View File

@ -85,10 +85,10 @@ public class Connection {
} }
/** /**
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; * <a href="/en/stable/openvidu-pro/" target="_blank" style="display:
* background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: * inline-block; background-color: rgb(0, 136, 170); color: white; font-weight:
* 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; * bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size:
* line-height:21px; font-family: Montserrat, sans-serif">PRO</a> * 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* *
* Returns the geo location of the connection, with the following format: * Returns the geo location of the connection, with the following format:
* <code>"CITY, COUNTRY"</code> (<code>"unknown"</code> if it wasn't possible to * <code>"CITY, COUNTRY"</code> (<code>"unknown"</code> if it wasn't possible to
@ -117,8 +117,9 @@ public class Connection {
/** /**
* Returns the data associated to the connection on the client-side. This value * Returns the data associated to the connection on the client-side. This value
* is set with second parameter of method <a href="/en/stable/api/openvidu-browser/classes/session.html#connect" * is set with second parameter of method
* target="_blank">Session.connect</a> in OpenVidu Browser * <a href="/en/stable/api/openvidu-browser/classes/session.html#connect" target
* ="_blank">Session.connect</a> in OpenVidu Browser
*/ */
public String getClientData() { public String getClientData() {
return clientData; return clientData;

14
openvidu-java-client/src/main/java/io/openvidu/java/client/KurentoOptions.java
View File

@ -107,8 +107,8 @@ public class KurentoOptions {
/** /**
* Defines the maximum number of Kbps that the client owning the token will be * Defines the maximum number of Kbps that the client owning the token will be
* able to receive from Kurento Media Server. 0 means unconstrained. Giving a * able to receive from Kurento Media Server. 0 means unconstrained. Giving a
* value to this property will override the global configuration set in <a href= * value to this property will override the global configuration set in <a
* "https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server" * href=/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
* target="_blank">OpenVidu Server configuration</a> (parameter * target="_blank">OpenVidu Server configuration</a> (parameter
* <code>openvidu.streams.video.max-recv-bandwidth</code>) for every incoming * <code>openvidu.streams.video.max-recv-bandwidth</code>) for every incoming
* stream of the user owning the token. <br> * stream of the user owning the token. <br>
@ -125,7 +125,7 @@ public class KurentoOptions {
* Defines the minimum number of Kbps that the client owning the token will try * Defines the minimum number of Kbps that the client owning the token will try
* to receive from Kurento Media Server. 0 means unconstrained. Giving a value * to receive from Kurento Media Server. 0 means unconstrained. Giving a value
* to this property will override the global configuration set in <a href= * to this property will override the global configuration set in <a href=
* "https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server" * "/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
* target="_blank">OpenVidu Server configuration</a> (parameter * target="_blank">OpenVidu Server configuration</a> (parameter
* <code>openvidu.streams.video.min-recv-bandwidth</code>) for every incoming * <code>openvidu.streams.video.min-recv-bandwidth</code>) for every incoming
* stream of the user owning the token. * stream of the user owning the token.
@ -138,7 +138,7 @@ public class KurentoOptions {
* Defines the maximum number of Kbps that the client owning the token will be * Defines the maximum number of Kbps that the client owning the token will be
* able to send to Kurento Media Server. 0 means unconstrained. Giving a value * able to send to Kurento Media Server. 0 means unconstrained. Giving a value
* to this property will override the global configuration set in <a href= * to this property will override the global configuration set in <a href=
* "https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server" * "/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
* target="_blank">OpenVidu Server configuration</a> (parameter * target="_blank">OpenVidu Server configuration</a> (parameter
* <code>openvidu.streams.video.max-send-bandwidth</code>) for every outgoing * <code>openvidu.streams.video.max-send-bandwidth</code>) for every outgoing
* stream of the user owning the token. <br> * stream of the user owning the token. <br>
@ -154,7 +154,7 @@ public class KurentoOptions {
* Defines the minimum number of Kbps that the client owning the token will try * Defines the minimum number of Kbps that the client owning the token will try
* to send to Kurento Media Server. 0 means unconstrained. Giving a value to * to send to Kurento Media Server. 0 means unconstrained. Giving a value to
* this property will override the global configuration set in <a href= * this property will override the global configuration set in <a href=
* "https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server" * "/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
* target="_blank">OpenVidu Server configuration</a> (parameter * target="_blank">OpenVidu Server configuration</a> (parameter
* <code>openvidu.streams.video.min-send-bandwidth</code>) for every outgoing * <code>openvidu.streams.video.min-send-bandwidth</code>) for every outgoing
* stream of the user owning the token. * stream of the user owning the token.
@ -166,8 +166,8 @@ public class KurentoOptions {
/** /**
* Defines the names of the filters the user owning the token will be able to * Defines the names of the filters the user owning the token will be able to
* apply. See * apply. See
* <a href="https://docs.openvidu.io/en/stable/advanced-features/filters/" target= * <a href="/en/stable/advanced-features/filters/" target= "_blank">Voice and
* "_blank">Voice and video filters</a> * video filters</a>
*/ */
public String[] getAllowedFilters() { public String[] getAllowedFilters() {
return allowedFilters; return allowedFilters;

4
openvidu-java-client/src/main/java/io/openvidu/java/client/Recording.java
View File

@ -195,8 +195,8 @@ public class Recording {
/** /**
* URL of the recording. You can access the file from there. It is * URL of the recording. You can access the file from there. It is
* <code>null</code> until recording reaches "ready" or "failed" status. If * <code>null</code> until recording reaches "ready" or "failed" status. If
* <a href="https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/" * <a href="/en/stable/reference-docs/openvidu-server-params/" target=
* target="_blank">OpenVidu Server configuration</a> property * "_blank">OpenVidu Server configuration</a> property
* <code>openvidu.recording.public-access</code> is false, this path will be * <code>openvidu.recording.public-access</code> is false, this path will be
* secured with OpenVidu credentials * secured with OpenVidu credentials
*/ */

4
openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingLayout.java
View File

@ -46,8 +46,8 @@ public enum RecordingLayout {
HORIZONTAL_PRESENTATION, HORIZONTAL_PRESENTATION,
/** /**
* Use your own custom recording layout. See <a href= * Use your own custom recording layout. See
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts" * <a href="/en/stable/advanced-features/recording#custom-recording-layouts"
* target="_blank">Custom recording layouts</a> to learn more * target="_blank">Custom recording layouts</a> to learn more
*/ */
CUSTOM CUSTOM

6
openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java
View File

@ -102,8 +102,7 @@ public class RecordingProperties {
* {@link io.openvidu.java.client.RecordingProperties.Builder#outputMode(Recording.OutputMode)} * {@link io.openvidu.java.client.RecordingProperties.Builder#outputMode(Recording.OutputMode)}
* has been called with value * has been called with value
* {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED}.<br> * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED}.<br>
* See <a href= * See <a href="/en/stable/advanced-features/recording#custom-recording-layouts"
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
* target="_blank">Custom recording layouts</a> to learn more * target="_blank">Custom recording layouts</a> to learn more
*/ */
public RecordingProperties.Builder customLayout(String path) { public RecordingProperties.Builder customLayout(String path) {
@ -197,8 +196,7 @@ public class RecordingProperties {
* If {@link io.openvidu.java.client.RecordingProperties#recordingLayout()} is * If {@link io.openvidu.java.client.RecordingProperties#recordingLayout()} is
* set to {@link io.openvidu.java.client.RecordingLayout#CUSTOM}, this property * set to {@link io.openvidu.java.client.RecordingLayout#CUSTOM}, this property
* defines the relative path to the specific custom layout you want to use.<br> * defines the relative path to the specific custom layout you want to use.<br>
* See <a href= * See <a href="/en/stable/advanced-features/recording#custom-recording-layouts"
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
* target="_blank">Custom recording layouts</a> to learn more * target="_blank">Custom recording layouts</a> to learn more
*/ */
public String customLayout() { public String customLayout() {