SQLite Docs -- <classsynopsis> issues
| From: | Kenneth Schwartz | Date: | Fri, 14 Jan 2005 23:00:59 +0000 |
| Subject: | SQLite Docs -- <classsynopsis> issues | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969365982@lists.php.net to get a copy of this message | ||
Hello all,
I've ran into an issue in the SQLite docs with regards to
<classsynopsis>. If you take a look at
http://php.net/sqlite_fetch_array (use a mirror with
the recent build of
the manual), note the two class/method definitions.
The current stylesheets do not render this very pretty ;) SQLite uses
two classes for result sets, SQLiteResult (for buffered, seekable result
sets) and SQLiteUnbuffered. About a half-dozen or so functions are
implemented in both these classes; the usage of these functions are
*exactly* the same across both classes and are simply method mappings in
the underlying code.
Should I stick with the current use of two <classsynopsis> nodes? or
could I combine them with something like this,
<classsynopsis>
<ooclass>
<classname>SQLiteResult</classname>,
<classname>SQLiteUnbuffered</classname>
</ooclass>
<methodsynopsis>
<type>array</type><methodname>fetch</methodname>
<methodparam
choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
<methodparam
choice="opt"><type>bool</type><parameter>decode_binary</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
The current markup in the docs is more verbose, while the above is more
compact. Any ideas would be appreciated.
Kenneth