svn commit: r1529971 - in /db/derby/docs/trunk/src/ref: rrefcrsrgpc1.dita rrefpgc1.dita

[ch...@apache.org]

Author: chaase3
Date: Mon Oct  7 15:22:56 2013
New Revision: 1529971

URL: http://svn.apache.org/r1529971
Log:
DERBY-6369  Make bullet lists into tables in two Reference Manual topics

Modified 2 topics in Reference Manual.

Patch: DERBY-6369.diff

Modified:
    db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita
    db/derby/docs/trunk/src/ref/rrefpgc1.dita

Modified: db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita?rev=1529971&r1=1529970&r2=1529971&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita Mon Oct  7 15:22:56 2013
@@ -21,41 +21,109 @@ limitations under the License.
 <title>Columns in the ResultSet returned by getProcedureColumns</title>
 <refbody>
 <section><p>Columns in the <i>ResultSet</i> returned by <i>getProcedureColumns</i> are
-as described by the API. Further details for some specific columns:   <ul>
-<li>PROCEDURE_CAT   <p>Always "null" in
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></li>
-<li>PROCEDURE_SCHEM   <p>Schema for a Java procedure.</p></li>
-<li>PROCEDURE_NAME   <p>The name of the procedure.</p></li>
-<li>COLUMN_NAME   <p>The name of the parameter (see
-<i><xref href="rrefpgc1.dita#rrefpgc1/i1024753">columnNamePattern</xref></i>).</p></li>
-<li>COLUMN_TYPE   <p><i>short</i> indicating what the row describes. Always is
-<i>DatabaseMetaData.procedureColumnIn</i> for
-method parameters, unless the parameter is an array. If so, it is <i>DatabaseMetaData.procedureColumnInOut</i>.
+as described by the API. Further details for some specific columns are shown
+in the following table.</p>
+<table frame="all"><title>Columns in the <i>ResultSet</i> returned by
+<i>getProcedureColumns</i></title>
+<desc>This table lists and describes the columns in the <i>ResultSet</i> returned by the <i>getProcedureColumns</i> method.</desc>
+<tgroup cols="2" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="30*"/>
+<colspec colname="2" colnum="2" colwidth="70*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column</entry>
+<entry colname="2">Description</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">PROCEDURE_CAT</entry>
+<entry colname="2">Always "null" in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</entry>
+</row>
+<row>
+<entry colname="1">PROCEDURE_SCHEM</entry>
+<entry colname="2">Schema for a Java procedure.</entry>
+</row>
+<row>
+<entry colname="1">PROCEDURE_NAME</entry>
+<entry colname="2">The name of the procedure.</entry>
+</row>
+<row>
+<entry colname="1">COLUMN_NAME</entry>
+<entry colname="2">The name of the parameter (see <i>columnNamePattern</i> in
+<xref href="rrefpgc1.dita#rrefpgc1"></xref>).</entry>
+</row>
+<row>
+<entry colname="1">COLUMN_TYPE</entry>
+<entry colname="2"><i>short</i> indicating what the row describes. Is always
+<i>DatabaseMetaData.procedureColumnIn</i> for method parameters, unless the
+parameter is an array. If so, it is <i>DatabaseMetaData.procedureColumnInOut</i>.
 It always returns <i>DatabaseMetaData.procedureColumnReturn</i> for return
-values.</p></li>
-<li>TYPE_NAME   <p><ph conref="../conrefs.dita#prod/productshortname"></ph>-specific
-name for the type.</p></li>
-<li>NULLABLE   <p>Always returns <i>DatabaseMetaData.procedureNoNulls</i> for
+values.</entry>
+</row>
+<row>
+<entry colname="1">TYPE_NAME</entry>
+<entry colname="2"><ph conref="../conrefs.dita#prod/productshortname"></ph>-specific
+name for the type.</entry>
+</row>
+<row>
+<entry colname="1">NULLABLE</entry>
+<entry colname="2">Always returns <i>DatabaseMetaData.procedureNoNulls</i> for
 primitive parameters and <i>DatabaseMetaData.procedureNullable</i> for object
-parameters.</p></li>
-<li>REMARKS   <p>A <i>String</i> describing the Java type of the method
-parameter.</p></li>
-<li>COLUMN_DEF   <p>A <i>String</i> describing the default value for the
-column (may be null).</p></li>
-<li>SQL_DATA_TYPE   <p>Reserved by JDBC spec for future use.</p></li>
-<li>SQL_DATETIME_SUB   <p>Reserved by JDBC spec for future use.</p></li>
-<li>CHAR_OCTET_LENGTH   <p>The maximum length of binary and character
-based columns (or any other datatype the returned value is a NULL).</p></li>
-<li>ORDINAL_POSITION   <p>The ordinal position, starting from 1, for the input
-and output parameters for a procedure.</p></li>
-<li>IS_NULLABLE   <p>A <i>String</i> describing the parameter's nullability
-(YES means parameter can include NULLs, NO means it cannot).</p></li>
-<li>SPECIFIC_NAME   <p>The name which uniquely identifies this procedure within
-its schema.</p></li>
-<li>METHOD_ID   <p>A <ph conref="../conrefs.dita#prod/productshortname"></ph>-specific
-column.</p></li>
-<li>PARAMETER_ID  <p>A <ph conref="../conrefs.dita#prod/productshortname"></ph>-specific
-column.</p></li>
-</ul></p></section>
+parameters.</entry>
+</row>
+<row>
+<entry colname="1">REMARKS</entry>
+<entry colname="2">A <i>String</i> which describes the Java type of the method
+parameter.</entry>
+</row>
+<row>
+<entry colname="1">COLUMN_DEF</entry>
+<entry colname="2">A <i>String</i> which describes the default value for the
+column (may be null).</entry>
+</row>
+<row>
+<entry colname="1">SQL_DATA_TYPE</entry>
+<entry colname="2">Reserved by the JDBC specification for future use.</entry>
+</row>
+<row>
+<entry colname="1">SQL_DATETIME_SUB</entry>
+<entry colname="2">Reserved by the JDBC specification for future use.</entry>
+</row>
+<row>
+<entry colname="1">CHAR_OCTET_LENGTH</entry>
+<entry colname="2">The maximum length of binary and character based columns (for
+any other data type, the returned value is a NULL).</entry>
+</row>
+<row>
+<entry colname="1">ORDINAL_POSITION</entry>
+<entry colname="2">The ordinal position, starting from 1, for the input
+and output parameters for a procedure.</entry>
+</row>
+<row>
+<entry colname="1">IS_NULLABLE</entry>
+<entry colname="2">A <i>String</i> describing the parameter's nullability
+(YES means the parameter can include NULLs, NO means it cannot).</entry>
+</row>
+<row>
+<entry colname="1">SPECIFIC_NAME</entry>
+<entry colname="2">The name which uniquely identifies this procedure within
+its schema.</entry>
+</row>
+<row>
+<entry colname="1">METHOD_ID</entry>
+<entry colname="2">A <ph conref="../conrefs.dita#prod/productshortname"></ph>-specific
+column.</entry>
+</row>
+<row>
+<entry colname="1">PARAMETER_ID</entry>
+<entry colname="2">A <ph conref="../conrefs.dita#prod/productshortname"></ph>-specific
+column.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/ref/rrefpgc1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefpgc1.dita?rev=1529971&r1=1529970&r2=1529971&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefpgc1.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefpgc1.dita Mon Oct  7 15:22:56 2013
@@ -21,18 +21,47 @@ limitations under the License.
 <reference id="rrefpgc1" xml:lang="en-us">
 <title>Parameters to getProcedureColumns</title>
 <refbody>
-<section><p>The JDBC API defines the following parameters for this method
-call:</p></section>
-<section> <ul>
-<li><i>catalog</i>   <p>Always use <i>null</i> for this parameter in <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></li>
-<li><i>schemaPattern</i>   <p>Java procedures have a schema.</p></li>
-<li><i>procedureNamePattern</i>   <p>A <i>String</i> object representing a procedure
-name pattern.</p></li>
-<li id="i1024753"><i id="jdbc95532">columnNamePattern</i>   <p>A <i>String</i>
-object representing the name pattern of the parameter names or return value
-names. Java procedures have parameter names matching those defined in the
-CREATE PROCEDURE statement. Use "%" to find all parameter names.</p></li>
-</ul></section>
+<section><p>For the <i>getProcedureColumns</i> method, the JDBC API defines the
+parameters shown in the following table.</p></section>
+<section> 
+<table frame="all"><title><i>getProcedureColumns</i> method parameters</title>
+<desc>This table lists and describes the parameters of the <i>getProcedureColumns</i> method.</desc>
+<tgroup cols="2" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="30*"/>
+<colspec colname="2" colnum="2" colwidth="70*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Parameter</entry>
+<entry colname="2">Description</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1"><i>catalog</i></entry>
+<entry colname="2">Always use <i>null</i> for this parameter in 
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</entry>
+</row>
+<row>
+<entry colname="1"><i>schemaPattern</i></entry>
+<entry colname="2">A <i>String</i> object representing the name pattern of the
+procedure's schema. Java procedures have a schema.</entry>
+</row>
+<row>
+<entry colname="1"><i>procedureNamePattern</i></entry>
+<entry colname="2">A <i>String</i> object representing the name pattern of the
+procedure.</entry>
+</row>
+<row>
+<entry colname="1"><i id="jdbc95532">columnNamePattern</i></entry>
+<entry colname="2">A <i>String</i> object representing the name pattern of the
+parameter names or return value names. Java procedures have parameter names
+matching those defined in the CREATE PROCEDURE statement. Use "%" to find all
+parameter names.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</section>
 </refbody>
 </reference>