Skip to content

Commit 3bccc17

Browse files
suhebsuheb
committed
Adding missing docs and keywords for TableRow.
Signed-off-by: Suhaib Khan <suheb.work@gmail.com>
1 parent d1e20da commit 3bccc17

2 files changed

Lines changed: 81 additions & 7 deletions

File tree

‎core/src/processing/data/TableRow.java‎

Lines changed: 72 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,17 @@ public interface TableRow {
3636
* @param columnName title of the column to reference
3737
*/
3838
public int getInt(String columnName);
39-
39+
/**
40+
* @webref tablerow:method
41+
* @brief Get a long value from the specified column
42+
* @param column ID number of the column to reference
43+
* @see TableRow#getFloat(int)
44+
* @see TableRow#getString(int)
45+
*/
4046
public long getLong(int column);
47+
/**
48+
* @param columnName title of the column to reference
49+
*/
4150
public long getLong(String columnName);
4251

4352
/**
@@ -52,8 +61,17 @@ public interface TableRow {
5261
* @param columnName title of the column to reference
5362
*/
5463
public float getFloat(String columnName);
55-
64+
/**
65+
* @webref tablerow:method
66+
* @brief Get a double value from the specified column
67+
* @param column ID number of the column to reference
68+
* @see TableRow#getInt(int)
69+
* @see TableRow#getString(int)
70+
*/
5671
public double getDouble(int column);
72+
/**
73+
* @param columnName title of the column to reference
74+
*/
5775
public double getDouble(String columnName);
5876

5977
/**
@@ -83,8 +101,18 @@ public interface TableRow {
83101
* @param columnName title of the target column
84102
*/
85103
public void setInt(String columnName, int value);
86-
104+
/**
105+
* @webref tablerow:method
106+
* @brief Store a long value in the specified column
107+
* @param column ID number of the target column
108+
* @param value value to assign
109+
* @see TableRow#setFloat(int, float)
110+
* @see TableRow#setString(int, String)
111+
*/
87112
public void setLong(int column, long value);
113+
/**
114+
* @param columnName title of the target column
115+
*/
88116
public void setLong(String columnName, long value);
89117

90118
/**
@@ -100,16 +128,53 @@ public interface TableRow {
100128
* @param columnName title of the target column
101129
*/
102130
public void setFloat(String columnName, float value);
103-
131+
/**
132+
* @webref tablerow:method
133+
* @brief Store a double value in the specified column
134+
* @param column ID number of the target column
135+
* @param value value to assign
136+
* @see TableRow#setFloat(int, float)
137+
* @see TableRow#setString(int, String)
138+
*/
104139
public void setDouble(int column, double value);
140+
/**
141+
* @param columnName title of the target column
142+
*/
105143
public void setDouble(String columnName, double value);
106-
144+
/**
145+
* @webref tablerow:method
146+
* @brief Get the column count.
147+
* @return count of all columns
148+
*/
107149
public int getColumnCount();
150+
/**
151+
* @webref tablerow:method
152+
* @brief Get the column type.
153+
* @param columnName title of the target column
154+
* @return type of the column
155+
*/
108156
public int getColumnType(String columnName);
157+
/**
158+
* @param column ID number of the target column
159+
*/
109160
public int getColumnType(int column);
110-
161+
/**
162+
* @webref tablerow:method
163+
* @brief Get the all column types.
164+
* @return list of all column types
165+
*/
111166
public int[] getColumnTypes();
112-
167+
/**
168+
* @webref tablerow:method
169+
* @brief Get the column title.
170+
* @param column ID number of the target column
171+
* @return title of the column
172+
*/
113173
public String getColumnTitle(int column);
174+
/**
175+
* @webref tablerow:method
176+
* @brief Get the all column titles.
177+
* @return list of all column titles
178+
*/
114179
public String[] getColumnTitles();
115180
}

‎java/keywords.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -866,9 +866,18 @@ TableRow KEYWORD5 TableRow
866866
getFloat FUNCTION2 TableRow_getFloat_
867867
getInt FUNCTION2 TableRow_getInt_
868868
getString FUNCTION2 TableRow_getString_
869+
getLong FUNCTION2 TableRow_getLong_
870+
getDouble FUNCTION2 TableRow_getDouble_
869871
setFloat FUNCTION2 TableRow_setFloat_
870872
setInt FUNCTION2 TableRow_setInt_
871873
setString FUNCTION2 TableRow_setString_
874+
setLong FUNCTION2 TableRow_setLong_
875+
setDouble FUNCTION2 TableRow_setDouble_
876+
getColumnCount FUNCTION2 TableRow_getColumnCount_
877+
getColumnType FUNCTION2 TableRow_getColumnType_
878+
getColumnTypes FUNCTION2 TableRow_getColumnTypes_
879+
getColumnTitle FUNCTION2 TableRow_getColumnTitle_
880+
getColumnTitles FUNCTION2 TableRow_getColumnTitles_
872881
tan FUNCTION1 tan_
873882
TAU LITERAL2 TAU
874883
text FUNCTION1 text_

0 commit comments

Comments
 (0)