Skip to content

Commit

Permalink
update function docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lostbard committed Oct 12, 2022
1 parent 2eacdb8 commit 5e043eb
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
1 change: 1 addition & 0 deletions inst/@octave_sqlite/fetch.m
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

## -*- texinfo -*-
## @deftypefn {} {@var{data} =} fetch (@var{db}, @var{sqlquery})
## @deftypefnx {} {@var{data} =} fetch (@var{db}, @var{sqlquery}, @var{propertyname}, @var{propertyvalue} @dots{})
## Return rows of data after runnning a sql query on a sqlite database.
##
## @subsubheading Inputs
Expand Down
16 changes: 15 additions & 1 deletion inst/sqlite.m
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,20 @@
## a opened SQLITE database as a octave_sqlite object
## @end table
##
## @subsubheading Object Properties
## The octave_sqlite object has the following properties:
##
## @table @asis
## @item Database
## The name of the opened database file (readonly)
## @item IsOpen
## Boolean field for if the database is currently open (readonly)
## @item IsReadOnly
## Boolean field for if the database was opened in readonly mode. (readonly)
## @item AutoCommit
## String flag field for whether database is in auto commit mode. "on" (default) or "off".
## @end table
##
## @subsubheading Examples
## Open a sqlite database, failing if it doesnt exist.
## @example
Expand All @@ -41,7 +55,7 @@
## }
## @end example
##
## Open a sqlite database, creating it if it doesnt exist.
## Open a sqlite database, creating it if it does not exist.
## @example
## @code {
## db = sqlite("mytest.db", "create");
Expand Down

0 comments on commit 5e043eb

Please sign in to comment.