[Doc] Provide Java's reference library, documentation for users and developers #242
Conversation
Thespica
changed the title
docs/developers/java-dev.rst
Outdated
| By writing CMakeLists.txt, all C++ dependents(e.g. JNI code, GraphAr C++ | ||
| library and other C++ library) will been integrated into a bridge | ||
| dynamic library called gar-jni which can be called by native methods | ||
| directly. |
There was a problem hiding this comment.
Here can add a link to CMakeLists.txt as example
There was a problem hiding this comment.
We have written CMakeLists.txt, developers only need know the architecture, not need to write new CMakeLists.
I think add a link to CMakeLists is enough.
There was a problem hiding this comment.
If developer do not need to know the CMakeLists, that we should talk about CMakeList here
docs/developers/java-dev.rst
Outdated
| Building GraphAr Java | ||
| --------------------- | ||
|
|
||
| Please refer to user guide. |
There was a problem hiding this comment.
Add a link to the user guide
docs/user-guide/java-lib.rst
Outdated
|
|
||
| Tips: | ||
|
|
||
| - From apt-get: |
There was a problem hiding this comment.
should change to Use Ubuntu as example:
|
|
||
| $ mvn clean install -DskipTests | ||
|
|
||
| Then set GraphAr as a dependency in maven project: |
There was a problem hiding this comment.
the maven project has not set, so maybe we should not include this part. We can add this part back if maven is ready
There was a problem hiding this comment.
User needs to add this part in pom.xml so the project can import the gar-java library
There was a problem hiding this comment.
You mean after building the project, the user can use the project directly?
java/README.md
Outdated
|
|
||
|
|
||
| Tips: | ||
| - From apt-get: |
java/pom.xml
Outdated
| @@ -258,7 +289,7 @@ | |||
| <java> | |||
| <googleJavaFormat> | |||
| <version>1.7</version> | |||
| <style>AOSP</style> | |||
| <style>GOOGLE</style> | |||
There was a problem hiding this comment.
I think AOSP is find for JAVA, DO we have any necessary reason to change the format configuration?
docs/user-guide/java-lib.rst
Outdated
| to build in Java. Instead, the GraphAr Java library provide a static | ||
| method to convert VectorSchemaRoot into arrow::Table. Warning: There are | ||
| some problems concerning this method which lead to memory leaks. We will | ||
| fix it or rewritre writer with Apache arrow Java. |
docs/developers/java-dev.rst
Outdated
| @@ -0,0 +1,63 @@ | |||
| Java Devolopment | |||
Proposed changes
As titile.
Besides, using GOOGLE Java style rather than AOSP style.
Types of changes
What types of changes does your code introduce to GraphAr?
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
Related issue #72 #240