Merge pull request #100 from mekjaer/master

Updatding yaml doc for java addAt
realm · Sep 6, 2013 · 22a95eb · 22a95eb
2 parents fdc4edb + e8318f5
commit 22a95eb
Show file tree

Hide file tree

Showing 25 changed files with 741 additions and 347 deletions.
diff --git a/.gitignore b/.gitignore
@@ -79,3 +79,9 @@ _ReSharper*/
 *.lock
 
 tightdb-java-test/testng.xml
+
+*.prefs
+
+# Ref doc generated classes
+
+doc/ref/examples/generated/com/tightdb/refdoc/*.java
diff --git a/doc/ref/data/dyn_table_ref.yaml b/doc/ref/data/dyn_table_ref.yaml
@@ -75,6 +75,8 @@ CATEGORIES :
       EXAMPLES:
       - CODE   : ex_java_dyn_table_clear
         DESCR  :
+      SEE      : >
+                See also {@link g_dyn_table_is_empty}.
   - g_dyn_table_optimize:
       NAMES    : optimize
       SUMMARY  : *g_dyn_table_optimize_summary
@@ -136,15 +138,15 @@ CATEGORIES :
                  
                  Currently, the following types are supported from the <code>ColumnType</code> class:
                  <ul>
-                   <li><code>ColumnTypeBool</code></li>
-                   <li><code>ColumnTypeInt</code></li>
-                   <li><code>ColumnTypeFloat</code></li>
-                   <li><code>ColumnTypeDouble</code></li>
-                   <li><code>ColumnTypeString</code></li>
-                   <li><code>ColumnTypeBinary</code></li>
-                   <li><code>ColumnTypeDate</code></li>
-                   <li><code>ColumnTypeTable</code></li>
-                   <li><code>ColumnTypeMixed</code></li>
+                   <li><code>BOOLEAN</code></li>
+                   <li><code>LONG</code></li>
+                   <li><code>FLOAT</code></li>
+                   <li><code>DOUBLE</code></li>
+                   <li><code>STRING</code></li>
+                   <li><code>BINARY</code></li>
+                   <li><code>DATE</code></li>
+                   <li><code>TABLE</code></li>
+                   <li><code>MIXED</code></li>
                  </ul>
 
       PARAMS:
@@ -238,15 +240,15 @@ CATEGORIES :
                  This method returns the type of a column using the column index. Currently,
                  the following types are supported from the <code>ColumnType</code> class:
                  <ul>
-                   <li><code>ColumnTypeBool</code></li>
-                   <li><code>ColumnTypeInt</code></li>
-                   <li><code>ColumnTypeFloat</code></li>
-                   <li><code>ColumnTypeDouble</code></li>
-                   <li><code>ColumnTypeString</code></li>
-                   <li><code>ColumnTypeBinary</code></li>
-                   <li><code>ColumnTypeDate</code></li>
-                   <li><code>ColumnTypeTable</code></li>
-                   <li><code>ColumnTypeMixed</code></li>
+                   <li><code>BOOLEAN</code></li>
+                   <li><code>LONG</code></li>
+                   <li><code>FLOAT</code></li>
+                   <li><code>DOUBLE</code></li>
+                   <li><code>STRING</code></li>
+                   <li><code>BINARY</code></li>
+                   <li><code>DATE</code></li>
+                   <li><code>TABLE</code></li>
+                   <li><code>MIXED</code></li>
                  </ul>
       PARAMS:
       - NAME   : columnIndex
@@ -297,11 +299,17 @@ CATEGORIES :
       - NAME   : rows
         TYPES  : long
         DESCR  : Number of rows to add.
+      EXAMPLES:
+      - CODE   : ex_java_dyn_table_add_empty_rows
+        DESCR  :
+      SEE      : >
+                 See also {@link g_dyn_table_add_empty_row} to add one empty row,
+                 or {@link g_dyn_table_add} to add a row with specific values.
   - g_dyn_table_insert:
-      NAMES    : insert
-      SUMMARY  : Append a row.
-      DESCR    : This method inserts one row at a given row index.
-                 The existing row at rowIndex and the following are all incremented one position.
+      NAMES    : addAt
+      SUMMARY  : Inserts a row at the specified row index.
+      DESCR    : Inserts a row at the specified row index. 
+                 Shifts the row currently at that row index and any subsequent rows down (adds one to their row index).
       PARAMS:
       - NAME   : rowIndex
         TYPES  : long
@@ -311,10 +319,10 @@ CATEGORIES :
         DESCR  : For each column in the table, you must provide a parameter with a matching type
                  in the same order as the columns are defined.
       EXAMPLES:
-      - CODE   : ex_java_dyn_table_insert
+      - CODE   : ex_java_dyn_table_add_at
         DESCR  :
       SEE      : >
-                See also {@link g_dyn_table_add} to add a row at the end of the table 
+                See also {@link g_dyn_table_add} to append a row at the end of the table 
                 (equivalent to using size() as rowIndex).
   - g_dyn_table_set_row:
       NAMES    : set
@@ -353,7 +361,7 @@ CATEGORIES :
         DESCR  :
 
   - g_dyn_table_add_int:
-      NAMES    : addInt
+      NAMES    : adjustColumnValues
       SUMMARY  : *g_dyn_table_add_int_summary
       DESCR    : *g_dyn_table_add_int_descr
       PARAMS:

diff --git a/doc/ref/data/read_transaction_ref.yaml b/doc/ref/data/read_transaction_ref.yaml
@@ -17,8 +17,10 @@ DESCR      : >
              an exception will be thrown.
 SEE        : 
 EXAMPLES: 
-- DESCR    : 
-  CODE     : ex_java_read_transaction_intro
+- DESCR    : Typed interface
+  CODE     : ex_java_typed_read_transaction_intro
+- DESCR    : Dynamic interface
+  CODE     : ex_java_dyn_read_transaction_intro  
 IGNORE     : []
 CATEGORIES:
 - -:

diff --git a/doc/ref/data/write_transaction_ref.yaml b/doc/ref/data/write_transaction_ref.yaml
@@ -16,8 +16,10 @@ DESCR      : >
 
 SEE        : 
 EXAMPLES: 
-- DESCR    : 
-  CODE     : ex_java_write_transaction_intro
+- DESCR    : Typed interface
+  CODE     : ex_java_typed_write_transaction_intro
+- DESCR    : Dynamic interface
+  CODE     : ex_java_dyn_write_transaction_intro  
 IGNORE     : []
 CATEGORIES:
 - -:

diff --git a/doc/ref/examples/ReadTransactionIntro.java b/doc/ref/examples/ReadTransactionIntro.java
diff --git a/doc/ref/examples/SharedGroupIntro.java b/doc/ref/examples/SharedGroupIntro.java
diff --git a/doc/ref/examples/TableViewIntro.java b/doc/ref/examples/TableViewIntro.java
diff --git a/doc/ref/examples/WriteTransactionIntro.java b/doc/ref/examples/WriteTransactionIntro.java
diff --git a/doc/ref/examples/pom.xml b/doc/ref/examples/pom.xml
@@ -0,0 +1,21 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+	<parent>
+		<groupId>com.tightdb</groupId>
+		<artifactId>tightdb-parent</artifactId>
+		<version>1.1.0</version>
+	</parent>
+
+	<artifactId>tightdb-java-refdoc</artifactId>
+
+	<dependencies>
+		<dependency>
+			<groupId>com.tightdb</groupId>
+			<artifactId>tightdb-java-core</artifactId>
+			<version>1.1.0</version>
+		</dependency>
+	</dependencies>
+
+</project>