Skip to content

Commit 9b2219e

Browse files
authored
feat(doc): Generate Java-Info API documentation and fix java-FFI API documentation (#760)
1 parent d591a47 commit 9b2219e

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

maven-projects/info/pom.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,18 @@
140140
</systemPropertyVariables>
141141
</configuration>
142142
</plugin>
143+
<plugin>
144+
<groupId>org.apache.maven.plugins</groupId>
145+
<artifactId>maven-javadoc-plugin</artifactId>
146+
<executions>
147+
<execution>
148+
<id>attach-javadocs</id>
149+
<goals>
150+
<goal>jar</goal>
151+
</goals>
152+
</execution>
153+
</executions>
154+
</plugin>
143155
</plugins>
144156
</build>
145157

maven-projects/java/src/main/java/org/apache/graphar/arrow/ArrowTable.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public interface ArrowTable extends CXXPointer {
4949
* @param allocator Buffer allocator for allocating C data interface fields
5050
* @param vsr Vector schema root to export
5151
* @param provider Dictionary provider for dictionary encoded vectors (optional)
52-
* @return StdSharedPtr<ArrowTable>
52+
* @return ArrowTbale shared pointer
5353
*/
5454
static StdSharedPtr<ArrowTable> fromVectorSchemaRoot(
5555
BufferAllocator allocator, VectorSchemaRoot vsr, DictionaryProvider provider) {
@@ -83,7 +83,7 @@ interface Static {
8383
*
8484
* @param arrayAddress Address of C ArrowArray
8585
* @param schemaAddress Address of C ArrowSchema
86-
* @return StdSharedPtr<ArrowTable> wrapped by ArrowResult
86+
* @return ArrowTbale shared pointer Result
8787
*/
8888
@CXXValue
8989
ArrowResult<StdSharedPtr<ArrowTable>> fromArrowArrayAndArrowSchema(

0 commit comments

Comments
 (0)