Skip to content

Commit 5c20251

Browse files
committed
* inst/dbtable.m: add docs on dbtable object properties
1 parent 02967fe commit 5c20251

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

inst/dbtable.m

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,25 @@
4343
## @item @var{table}
4444
## a dbtable object
4545
## @end table
46+
##
47+
## @subsubheading Object Properties
48+
## A dbtable object has the following properties:
49+
## @table @asis
50+
## @item Properties
51+
## A table properties struct.
52+
##
53+
## The table struct includes fields:
54+
## @table @asis
55+
## @item Description
56+
## Text table description
57+
## @item DimensionNames
58+
## Cell array of Row and Variable dimension names
59+
## @item VariableNames
60+
## Cell array of variable (column) names
61+
## @item UserData
62+
## User data value
63+
## @end table
64+
## @end table
4665
## @end deftypefn
4766

4867
properties (Access = private)
@@ -51,14 +70,15 @@
5170
endproperties
5271

5372
properties (Access = public)
73+
5474
Properties = struct ( ...
5575
'Description', "", ...
5676
'DimensionNames', {{'Row' 'Variables'}}, ...
5777
'VariableNames', {{}}, ...
5878
'VariableDescriptions', {{}}, ...
5979
'VariableUnits', {{}}, ...
6080
'RowNames', {{}}, ...
61-
'UserData', {{}} ...
81+
'UserData', [] ...
6282
);
6383
endproperties
6484

0 commit comments

Comments
 (0)