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 script extended (versioned links)

pull/431/head
pabloFuente 2020-04-05 20:49:27 +02:00
parent d838518ae3
commit ae92f7d06b
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,8 +1,20 @@
#!/bin/sh #!/bin/bash
if [[ -z "$BASEHREF_VERSION" ]]; then
echo "Example of use: \"BASEHREF_VERSION=2.12.0 ${0}\"" 1>&2
exit 1
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'
# Generate JavaDoc
mvn javadoc:javadoc mvn javadoc:javadoc
rm -rf ../../openvidu.io/api/openvidu-java-client/* 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
grep -rl 'href="/en/'${BASEHREF_VERSION}'/' ./src | xargs sed -i -e 's|href="/en/'${BASEHREF_VERSION}'/|href="/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/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

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

@ -117,8 +117,7 @@ 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= * is set with second parameter of method <a href="/en/stable/api/openvidu-browser/classes/session.html#connect"
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/session.html#connect"
* target="_blank">Session.connect</a> in OpenVidu Browser * target="_blank">Session.connect</a> in OpenVidu Browser
*/ */
public String getClientData() { public String getClientData() {