Skip to content

docs(java): fix broken java and kotlin urls #9237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Adrastopoulos wants to merge 1 commit into
base: master
Choose a base branch
from
+18 −22
Open

docs(java): fix broken java and kotlin urls #9237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions docs/source/languages/java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,18 @@ documentation to build `flatc` and should be familiar with
## FlatBuffers Java code location

The code for the FlatBuffers Java library can be found at
`flatbuffers/java/com/google/flatbuffers`. You can browse the library on the
[FlatBuffers GitHub page](https://github.com/google/flatbuffers/tree/master/
java/com/google/flatbuffers).
`flatbuffers/java/src/main/java/com/google/flatbuffers`. You can browse the
library on the [FlatBuffers GitHub
page](https://github.com/google/flatbuffers/tree/master/java/src/main/java/com/google/flatbuffers).

## Testing the FlatBuffers Java libraries

The code to test the libraries can be found at `flatbuffers/tests`.
The test code for Java is located in
[JavaTest.java](https://github.com/google/flatbuffers/blob/master/java/src/test/java/JavaTest.java).

The test code for Java is located in [JavaTest.java](https://github.com/google
/flatbuffers/blob/master/tests/JavaTest.java).
To run the tests, run `mvn test` from the `java/` directory.

To run the tests, use either [JavaTest.sh](https://github.com/google/
flatbuffers/blob/master/tests/JavaTest.sh) or [JavaTest.bat](https://github.com/
google/flatbuffers/blob/master/tests/JavaTest.bat), depending on your operating
system.

*Note: These scripts require that [Java](https://www.oracle.com/java/index.html)
*Note: These tests require that [Java](https://www.oracle.com/java/index.html)
is installed.*

## Using the FlatBuffers Java library
Expand Down
21 changes: 11 additions & 10 deletions docs/source/languages/kotlin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Use in Kotlin {#flatbuffers_guide_use_kotlin}

Before diving into the FlatBuffers usage in Kotlin, it should be noted that
the [Tutorial](../tutorial.md) page has a complete guide to
general FlatBuffers usage in all of the supported languages (including K).
general FlatBuffers usage in all of the supported languages (including Kotlin).

This page is designed to cover the nuances of FlatBuffers usage, specific to Kotlin.

Expand All @@ -19,19 +19,20 @@ documentation to build `flatc` and should be familiar with
Code generated for Kotlin currently uses the flatbuffers java runtime library. That means that Kotlin generated code can only have Java virtual machine as target architecture (which includes Android). Kotlin Native and Kotlin.js are currently not supported.

The code for the FlatBuffers Java library can be found at
`flatbuffers/java/com/google/flatbuffers`. You can browse the library on the
[FlatBuffers GitHub page](https://github.com/google/flatbuffers/tree/master/
java/com/google/flatbuffers).
`flatbuffers/java/src/main/java/com/google/flatbuffers`. You can browse the
library on the [FlatBuffers GitHub
page](https://github.com/google/flatbuffers/tree/master/java/src/main/java/com/google/flatbuffers).

## Testing FlatBuffers Kotlin

The test code for Java is located in [KotlinTest.java](https://github.com/google
/flatbuffers/blob/master/tests/KotlinTest.kt).
The test code for Kotlin is located in
[KotlinTest.kt](https://github.com/google/flatbuffers/blob/master/tests/KotlinTest.kt).

To run the tests, use [KotlinTest.sh](https://github.com/google/
flatbuffers/blob/master/tests/KotlinTest.sh) shell script.
To run the tests, use the
[KotlinTest.sh](https://github.com/google/flatbuffers/blob/master/tests/KotlinTest.sh)
shell script.

*Note: These scripts require that [Kotlin](https://kotlinlang.org/) is installed.*
*Note: This script requires that [Kotlin](https://kotlinlang.org/) is installed.*

## Using the FlatBuffers Kotlin library

Expand All @@ -40,7 +41,7 @@ example of how to use FlatBuffers in Kotlin.*

FlatBuffers supports reading and writing binary FlatBuffers in Kotlin.

To use FlatBuffers in your own code, first generate Java classes from your
To use FlatBuffers in your own code, first generate Kotlin classes from your
schema with the `--kotlin` option to `flatc`.
Then you can include both FlatBuffers and the generated code to read
or write a FlatBuffer.
Expand Down