Skip to content

Commit b97001e

Browse files
authored
docs: scylla-4.15.0.x documentation fixes (#542)
* Fix broken links in reconnection manual Those links redirect to internal API which is not a part of the generated javadoc, leading to 404 on visit. Instead redirect to code on github for scylla-4.15.0.x branch. * typo: remove extra backtick in docs * docs: Add query-builder and mapper-runtime javadocs When generating documentation website pages move also generated javadoc for query-builder and mapper-runtime modules. Some links in manuals attempt to link to the javadoc for those modules and end up being broken without those javadocs included.
1 parent 4c8eec7 commit b97001e

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

docs/_utils/javadoc.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ mvn javadoc:javadoc
1515
[ -d $OUTPUT_DIR ] && rm -r $OUTPUT_DIR
1616
mkdir -p "$OUTPUT_DIR"
1717
mv -f core/target/site/apidocs/* $OUTPUT_DIR
18+
cp -an query-builder/target/site/apidocs/* $OUTPUT_DIR
19+
cp -an mapper-runtime/target/site/apidocs/* $OUTPUT_DIR

manual/core/reconnection/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Note that the session is not accessible until it is fully ready: the `CqlSession
8484
call — or the future returned by `buildAsync()` — will not complete until the connection
8585
was established.
8686

87-
[ConstantReconnectionPolicy]: https://docs.datastax.com/en/drivers/java/4.14/com/datastax/oss/driver/internal/core/connection/ConstantReconnectionPolicy.html
88-
[DriverContext]: https://docs.datastax.com/en/drivers/java/4.14/com/datastax/oss/driver/api/core/context/DriverContext.html
89-
[ExponentialReconnectionPolicy]: https://docs.datastax.com/en/drivers/java/4.14/com/datastax/oss/driver/internal/core/connection/ExponentialReconnectionPolicy.html
90-
[ReconnectionPolicy]: https://docs.datastax.com/en/drivers/java/4.14/com/datastax/oss/driver/api/core/connection/ReconnectionPolicy.html
87+
[ConstantReconnectionPolicy]: https://github.com/scylladb/java-driver/blob/scylla-4.15.0.x/core/src/main/java/com/datastax/oss/driver/internal/core/connection/ConstantReconnectionPolicy.java
88+
[DriverContext]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/context/DriverContext.html
89+
[ExponentialReconnectionPolicy]: https://github.com/scylladb/java-driver/blob/scylla-4.15.0.x/core/src/main/java/com/datastax/oss/driver/internal/core/connection/ExponentialReconnectionPolicy.java
90+
[ReconnectionPolicy]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/connection/ReconnectionPolicy.html

manual/mapper/daos/getentity/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The method can return:
8989
* a single entity instance. If the argument is a result set type, the generated code will extract
9090
the first row and convert it, or return `null` if the result set is empty.
9191

92-
````java
92+
```java
9393
@GetEntity
9494
Product asProduct(Row row);
9595

0 commit comments

Comments
 (0)