mirror of https://github.com/OpenVidu/openvidu.git
openvidu-java-client: JavaDoc rest of links fixed
pabloFuente
parent
ae92f7d06b
commit
b182b8b30e
|
|
@ -6,7 +6,7 @@ if [[ -z "$BASEHREF_VERSION" ]]; then
|
|||
fi
|
||||
|
||||
# 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
|
||||
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
|
||||
|
||||
# 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
|
||||
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
|
||||
|
|
|
|||
|
|
@ -85,10 +85,10 @@ public class Connection {
|
|||
}
|
||||
|
||||
/**
|
||||
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block;
|
||||
* background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding:
|
||||
* 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px;
|
||||
* line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
|
||||
* <a href="/en/stable/openvidu-pro/" target="_blank" style="display:
|
||||
* inline-block; background-color: rgb(0, 136, 170); color: white; font-weight:
|
||||
* bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size:
|
||||
* 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
|
||||
*
|
||||
* Returns the geo location of the connection, with the following format:
|
||||
* <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
|
||||
* is set with second parameter of method <a href="/en/stable/api/openvidu-browser/classes/session.html#connect"
|
||||
* target="_blank">Session.connect</a> in OpenVidu Browser
|
||||
* is set with second parameter of method
|
||||
* <a href="/en/stable/api/openvidu-browser/classes/session.html#connect" target
|
||||
* ="_blank">Session.connect</a> in OpenVidu Browser
|
||||
*/
|
||||
public String getClientData() {
|
||||
return clientData;
|
||||
|
|
|
|||
|
|
@ -107,8 +107,8 @@ public class KurentoOptions {
|
|||
/**
|
||||
* 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
|
||||
* value 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"
|
||||
* value to this property will override the global configuration set in <a
|
||||
* href=/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
|
||||
* target="_blank">OpenVidu Server configuration</a> (parameter
|
||||
* <code>openvidu.streams.video.max-recv-bandwidth</code>) for every incoming
|
||||
* 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
|
||||
* to receive from Kurento Media Server. 0 means unconstrained. Giving a value
|
||||
* 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
|
||||
* <code>openvidu.streams.video.min-recv-bandwidth</code>) for every incoming
|
||||
* 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
|
||||
* 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=
|
||||
* "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
|
||||
* <code>openvidu.streams.video.max-send-bandwidth</code>) for every outgoing
|
||||
* 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
|
||||
* to send to Kurento Media Server. 0 means unconstrained. Giving a value 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
|
||||
* <code>openvidu.streams.video.min-send-bandwidth</code>) for every outgoing
|
||||
* 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
|
||||
* apply. See
|
||||
* <a href="https://docs.openvidu.io/en/stable/advanced-features/filters/" target=
|
||||
* "_blank">Voice and video filters</a>
|
||||
* <a href="/en/stable/advanced-features/filters/" target= "_blank">Voice and
|
||||
* video filters</a>
|
||||
*/
|
||||
public String[] getAllowedFilters() {
|
||||
return allowedFilters;
|
||||
|
|
|
|||
|
|
@ -195,8 +195,8 @@ public class Recording {
|
|||
/**
|
||||
* URL of the recording. You can access the file from there. It is
|
||||
* <code>null</code> until recording reaches "ready" or "failed" status. If
|
||||
* <a href="https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/"
|
||||
* target="_blank">OpenVidu Server configuration</a> property
|
||||
* <a href="/en/stable/reference-docs/openvidu-server-params/" target=
|
||||
* "_blank">OpenVidu Server configuration</a> property
|
||||
* <code>openvidu.recording.public-access</code> is false, this path will be
|
||||
* secured with OpenVidu credentials
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -46,8 +46,8 @@ public enum RecordingLayout {
|
|||
HORIZONTAL_PRESENTATION,
|
||||
|
||||
/**
|
||||
* Use your own custom recording layout. See <a href=
|
||||
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
|
||||
* Use your own custom recording layout. See
|
||||
* <a href="/en/stable/advanced-features/recording#custom-recording-layouts"
|
||||
* target="_blank">Custom recording layouts</a> to learn more
|
||||
*/
|
||||
CUSTOM
|
||||
|
|
|
|||
|
|
@ -102,8 +102,7 @@ public class RecordingProperties {
|
|||
* {@link io.openvidu.java.client.RecordingProperties.Builder#outputMode(Recording.OutputMode)}
|
||||
* has been called with value
|
||||
* {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED}.<br>
|
||||
* See <a href=
|
||||
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
|
||||
* See <a href="/en/stable/advanced-features/recording#custom-recording-layouts"
|
||||
* target="_blank">Custom recording layouts</a> to learn more
|
||||
*/
|
||||
public RecordingProperties.Builder customLayout(String path) {
|
||||
|
|
@ -197,8 +196,7 @@ public class RecordingProperties {
|
|||
* If {@link io.openvidu.java.client.RecordingProperties#recordingLayout()} is
|
||||
* 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>
|
||||
* See <a href=
|
||||
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
|
||||
* See <a href="/en/stable/advanced-features/recording#custom-recording-layouts"
|
||||
* target="_blank">Custom recording layouts</a> to learn more
|
||||
*/
|
||||
public String customLayout() {
|
||||
|
|
|
|||
Loading…
Reference in New Issue