[ruby-oci8-commit] [501] trunk/ruby-oci8: revise rdoc comments.

nobody at rubyforge.org nobody at rubyforge.org
Fri Apr 6 12:26:57 UTC 2012


Revision: 501
Author:   kubo
Date:     2012-04-06 12:26:57 +0000 (Fri, 06 Apr 2012)
Log Message:
-----------
revise rdoc comments.

Modified Paths:
--------------
    trunk/ruby-oci8/ChangeLog
    trunk/ruby-oci8/ext/oci8/error.c
    trunk/ruby-oci8/ext/oci8/ocihandle.c
    trunk/ruby-oci8/ext/oci8/oradate.c
    trunk/ruby-oci8/lib/oci8/encoding-init.rb
    trunk/ruby-oci8/lib/oci8/oci8.rb
    trunk/ruby-oci8/lib/oci8/ocihandle.rb

Modified: trunk/ruby-oci8/ChangeLog
===================================================================
--- trunk/ruby-oci8/ChangeLog	2012-04-05 13:36:06 UTC (rev 500)
+++ trunk/ruby-oci8/ChangeLog	2012-04-06 12:26:57 UTC (rev 501)
@@ -1,3 +1,8 @@
+2012-04-06  KUBO Takehiro  <kubo at jiubao.org>
+	* ext/oci8/error.c, ext/oci8/ocihandle.c, ext/oci8/oradate.c,
+	  lib/oci8/encoding-init.rb, lib/oci8/oci8.rb, lib/oci8/ocihandle.rb:
+	    revise rdoc comments.
+
 2012-04-05  KUBO Takehiro  <kubo at jiubao.org>
 	* ext/oci8/ocinumber.c, lib/oci8/oci8.rb: revise OraNumber's comments.
 

Modified: trunk/ruby-oci8/ext/oci8/error.c
===================================================================
--- trunk/ruby-oci8/ext/oci8/error.c	2012-04-05 13:36:06 UTC (rev 500)
+++ trunk/ruby-oci8/ext/oci8/error.c	2012-04-06 12:26:57 UTC (rev 501)
@@ -2,7 +2,7 @@
 /*
   error.c - part of ruby-oci8
 
-  Copyright (C) 2002-2011 KUBO Takehiro <kubo at jiubao.org>
+  Copyright (C) 2002-2012 KUBO Takehiro <kubo at jiubao.org>
 
 */
 #include "oci8.h"
@@ -162,9 +162,13 @@
 
 /*
  * call-seq:
- *    OCI8.new(message, code = nil, sql = nil, parse_error_offset = nil)
+ *    initialize(message, code = nil, sql = nil, parse_error_offset = nil)
  *
  * Creates a new OCIError object.
+ *
+ * @example
+ *   OCIError.new("ORA-00001: unique constraint (%s.%s) violated", 1)
+ *   # => #<OCIError: ORA-00001: unique constraint (%s.%s) violated>
  */
 static VALUE oci8_error_initialize(int argc, VALUE *argv, VALUE self)
 {
@@ -211,6 +215,10 @@
     eOCISuccessWithInfo = rb_define_class("OCISuccessWithInfo", eOCIError);
 
     rb_define_method(eOCIError, "initialize", oci8_error_initialize, -1);
+
+    /*
+     * @attr_reader [Integer] code  error code
+     */
     rb_define_attr(eOCIError, "code", 1, 0);
     rb_define_attr(eOCIError, "sql", 1, 0);
     rb_define_attr(eOCIError, "parse_error_offset", 1, 0);
@@ -296,14 +304,11 @@
  * These exceptions are raised when Oracle Call Interface functions
  * return with an error status.
  *
- * - OCIBreak
- * - OCIContinue
- * - OCIError
- *   - OCISuccessWithInfo
- *   - OCINoData (It had been a subclass of OCIException, not OCIError, until ruby-oci8 2.0)
- * - OCIInvalidHandle
- * - OCINeedData
- * - OCIStillExecuting
+ * - {OCIBreak}
+ * - {OCIError}
+ *   - {OCISuccessWithInfo}
+ *   - {OCINoData} (It had been a subclass of OCIException, not OCIError, until ruby-oci8 2.0)
+ * - {OCIInvalidHandle}
  */
 
 /*
@@ -311,7 +316,7 @@
  *
  * Subclass of OCIException
  *
- * Raised when a SQL execution is cancelled by OCI8#break.
+ * Raised when a SQL execution is cancelled by {OCI8#break}.
  */
 
 /*
@@ -335,6 +340,10 @@
  *
  * Raised when underlying Oracle Call Interface failed with an Oracle error code
  * such as ORA-00001.
+ *
+ * @attr_reader [Integer] code  error code
+ * @attr_reader [String] sql    SQL statement
+ * @attr_reader [Integer] parse_error_offset position
  */
 
 /*
@@ -352,6 +361,8 @@
  * Subclass of OCIException
  *
  * Report to the ruby-oci8 author if it is raised.
+ *
+ * @private
  */
 
 /*
@@ -360,6 +371,8 @@
  * Subclass of OCIError
  *
  * Report to the ruby-oci8 author if it is raised.
+ *
+ * @private
  */
 
 /*
@@ -368,6 +381,8 @@
  * Subclass of OCIException
  *
  * Report to the ruby-oci8 author if it is raised.
+ *
+ * @private
  */
 
 /*

Modified: trunk/ruby-oci8/ext/oci8/ocihandle.c
===================================================================
--- trunk/ruby-oci8/ext/oci8/ocihandle.c	2012-04-05 13:36:06 UTC (rev 500)
+++ trunk/ruby-oci8/ext/oci8/ocihandle.c	2012-04-06 12:26:57 UTC (rev 501)
@@ -2,7 +2,7 @@
 /*
  * ocihandle.c
  *
- * Copyright (C) 2009-2010 KUBO Takehiro <kubo at jiubao.org>
+ * Copyright (C) 2009-2012 KUBO Takehiro <kubo at jiubao.org>
  *
  * implement OCIHandle
  *
@@ -38,12 +38,10 @@
 }
 
 /*
- * call-seq:
- *   free()
+ * Clears the object internal structure and its dependents.
  *
- * <b>(new in 2.0.0)</b>
- *
- * Clears the object internal structure and its dependents.
+ * @since 2.0.0
+ * @private
  */
 static VALUE oci8_handle_free(VALUE self)
 {
@@ -107,11 +105,15 @@
 
 /*
  * call-seq:
- *   attr_get_ub1(attr_type) -> fixnum
+ *   attr_get_ub1(attr_type)
  *
- * <b>(new in 2.0.4)</b>
+ * Gets the value of an attribute as `ub1' datatype.
  *
- * Gets the value of an attribute as `ub1' datatype.
+ * @param [Fixnum] attr_type
+ * @return [Fixnum]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_ub1(VALUE self, VALUE attr_type)
 {
@@ -129,11 +131,15 @@
 
 /*
  * call-seq:
- *   attr_get_ub2(attr_type) -> fixnum
+ *   attr_get_ub2(attr_type)
  *
- * <b>(new in 2.0.4)</b>
+ * Gets the value of an attribute as `ub2' datatype.
  *
- * Gets the value of an attribute as `ub2' datatype.
+ * @param [Fixnum] attr_type
+ * @return [Fixnum]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_ub2(VALUE self, VALUE attr_type)
 {
@@ -151,11 +157,15 @@
 
 /*
  * call-seq:
- *   attr_get_ub4(attr_type) -> integer
+ *   attr_get_ub4(attr_type)
  *
- * <b>(new in 2.0.4)</b>
+ * Gets the value of an attribute as `ub4' datatype.
  *
- * Gets the value of an attribute as `ub4' datatype.
+ * @param [Fixnum] attr_type
+ * @return [Integer]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_ub4(VALUE self, VALUE attr_type)
 {
@@ -173,11 +183,15 @@
 
 /*
  * call-seq:
- *   attr_get_ub8(attr_type) -> integer
+ *   attr_get_ub8(attr_type)
  *
- * <b>(new in 2.0.4)</b>
+ * Gets the value of an attribute as `ub8' datatype.
  *
- * Gets the value of an attribute as `ub8' datatype.
+ * @param [Fixnum] attr_type
+ * @return [Integer]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_ub8(VALUE self, VALUE attr_type)
 {
@@ -195,11 +209,15 @@
 
 /*
  * call-seq:
- *   attr_get_sb1(attr_type) -> fixnum
+ *   attr_get_sb1(attr_type)
  *
- * <b>(new in 2.0.4)</b>
+ * Gets the value of an attribute as `sb1' datatype.
  *
- * Gets the value of an attribute as `sb1' datatype.
+ * @param [Fixnum] attr_type
+ * @return [Fixnum]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_sb1(VALUE self, VALUE attr_type)
 {
@@ -217,11 +235,15 @@
 
 /*
  * call-seq:
- *   attr_get_sb2(attr_type) -> fixnum
+ *   attr_get_sb2(attr_type)
  *
- * <b>(new in 2.0.4)</b>
+ * Gets the value of an attribute as `sb2' datatype.
  *
- * Gets the value of an attribute as `sb2' datatype.
+ * @param [Fixnum] attr_type
+ * @return [Fixnum]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_sb2(VALUE self, VALUE attr_type)
 {
@@ -239,11 +261,15 @@
 
 /*
  * call-seq:
- *   attr_get_sb4(attr_type) -> integer
+ *   attr_get_sb4(attr_type)
  *
- * <b>(new in 2.0.4)</b>
+ * Gets the value of an attribute as `sb4' datatype.
  *
- * Gets the value of an attribute as `sb4' datatype.
+ * @param [Fixnum] attr_type
+ * @return [Integer]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_sb4(VALUE self, VALUE attr_type)
 {
@@ -261,11 +287,15 @@
 
 /*
  * call-seq:
- *   attr_get_sb8(attr_type) -> integer
+ *   attr_get_sb8(attr_type)
  *
- * <b>(new in 2.0.4)</b>
+ * Gets the value of an attribute as `sb8' datatype.
  *
- * Gets the value of an attribute as `sb8' datatype.
+ * @param [Fixnum] attr_type
+ * @return [Integer]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_sb8(VALUE self, VALUE attr_type)
 {
@@ -283,11 +313,15 @@
 
 /*
  * call-seq:
- *   attr_get_boolean(attr_type) -> true or false
+ *   attr_get_boolean(attr_type)
  *
- * <b>(new in 2.0.4)</b>
+ * Gets the value of an attribute as `boolean' datatype.
  *
- * Gets the value of an attribute as `boolean' datatype.
+ * @param [Fixnum] attr_type
+ * @return [true of false]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_boolean(VALUE self, VALUE attr_type)
 {
@@ -305,16 +339,20 @@
 
 /*
  * call-seq:
- *   attr_get_string(attr_type) -> string
+ *   attr_get_string(attr_type)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Gets the value of an attribute as `oratext *' datatype.
  * The return value is converted to Encoding.default_internal or
- * tagged with OCI8.encoding when the ruby version is 1.9.
+ * tagged with {OCI8.encoding} when the ruby version is 1.9.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is not a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is not a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @return [String]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_string(VALUE self, VALUE attr_type)
 {
@@ -333,15 +371,19 @@
 
 /*
  * call-seq:
- *   attr_get_binary(attr_type) -> string
+ *   attr_get_binary(attr_type)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Gets the value of an attribute as `ub1 *' datatype.
  * The return value is tagged with ASCII-8BIT when the ruby version is 1.9.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is not a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is not a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @return [String]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_binary(VALUE self, VALUE attr_type)
 {
@@ -362,13 +404,17 @@
  * call-seq:
  *   attr_get_integer(attr_type) -> integer
  *
- * <b>(new in 2.0.4)</b>
- *
  * Gets the value of an attribute as `ub1 *' datatype.
  * The return value is converted to Integer from internal Oracle NUMBER format.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is not a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is not a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @return [Fixnum]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_integer(VALUE self, VALUE attr_type)
 {
@@ -389,13 +435,17 @@
  * call-seq:
  *   attr_get_oradate(attr_type) -> an OraDate
  *
- * <b>(new in 2.1.0)</b>
- *
  * Gets the value of an attribute as `ub1 *' datatype.
  * The return value is converted to OraDate.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is not a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is not a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @return [OraDate]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_get_oradate(VALUE self, VALUE attr_type)
 {
@@ -425,12 +475,17 @@
  * call-seq:
  *   attr_set_ub1(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `ub1' datatype.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @param [Fixnum] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_ub1(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -449,12 +504,17 @@
  * call-seq:
  *   attr_set_ub2(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `ub2' datatype.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @param [Fixnum] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_ub2(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -473,12 +533,17 @@
  * call-seq:
  *   attr_set_ub4(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `ub4' datatype.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @param [Integer] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_ub4(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -497,12 +562,17 @@
  * call-seq:
  *   attr_set_ub8(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `ub8' datatype.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @param [Integer] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_ub8(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -521,12 +591,17 @@
  * call-seq:
  *   attr_set_sb1(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `sb1' datatype.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @param [Fixnum] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_sb1(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -545,12 +620,17 @@
  * call-seq:
  *   attr_set_sb2(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `sb2' datatype.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is a
+ *  pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @param [Fixnum] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_sb2(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -569,12 +649,17 @@
  * call-seq:
  *   attr_set_sb4(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `sb4' datatype.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @param [Integer] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_sb4(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -593,12 +678,17 @@
  * call-seq:
  *   attr_set_sb8(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `sb8' datatype.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @param [Integer] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_sb8(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -617,12 +707,17 @@
  * call-seq:
  *   attr_set_boolean(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `boolean' datatype.
  *
- * <b>Caution:</b> If the specified attr_type's datatype is a
- * pointer type, it causes a segmentation fault.
+ * @note If the specified attr_type's datatype is a
+ *   pointer type, it causes a segmentation fault.
+ *
+ * @param [Fixnum] attr_type
+ * @param [true or false] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_boolean(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -639,13 +734,18 @@
 
 /*
  * call-seq:
- *   attr_set_string(attr_type, string_value)
+ *   attr_set_string(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `oratext *' datatype.
- * +string_value+ is converted to OCI8.encoding before it is set
+ * +attr_value+ is converted to {OCI8.encoding} before it is set
  * when the ruby version is 1.9.
+ *
+ * @param [Fixnum] attr_type
+ * @param [String] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_string(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -661,11 +761,16 @@
 
 /*
  * call-seq:
- *   attr_set_binary(attr_type, string_value)
+ *   attr_set_binary(attr_type, attr_value)
  *
- * <b>(new in 2.0.4)</b>
+ * Sets the value of an attribute as `ub1 *' datatype.
  *
- * Sets the value of an attribute as `ub1 *' datatype.
+ * @param [Fixnum] attr_type
+ * @param [String] attr_value
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_binary(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -683,11 +788,16 @@
  * call-seq:
  *   attr_set_integer(attr_type, number)
  *
- * <b>(new in 2.0.4)</b>
- *
  * Sets the value of an attribute as `ub1 *' datatype.
  * +number+ is converted to internal Oracle NUMBER format before
  * it is set.
+ *
+ * @param [Fixnum] attr_type
+ * @param [Numeric] number
+ * @return [self]
+ *
+ * @since 2.0.4
+ * @private
  */
 static VALUE attr_set_integer(VALUE self, VALUE attr_type, VALUE val)
 {
@@ -707,11 +817,11 @@
     VALUE obj;
 
     /*
-     * <b>(new in 2.0.0)</b>
-     *
      * OCIHandle is the abstract base class of OCI handles and
      * OCI descriptors; opaque data types of Oracle Call Interface.
      * Don't use constants and methods defined in the class.
+     *
+     * @since 2.0.0
      */
     oci8_cOCIHandle = rb_define_class("OCIHandle", rb_cObject);
     rb_define_alloc_func(oci8_cOCIHandle, oci8_s_allocate);

Modified: trunk/ruby-oci8/ext/oci8/oradate.c
===================================================================
--- trunk/ruby-oci8/ext/oci8/oradate.c	2012-04-05 13:36:06 UTC (rev 500)
+++ trunk/ruby-oci8/ext/oci8/oradate.c	2012-04-06 12:26:57 UTC (rev 501)
@@ -2,7 +2,7 @@
 /*
  *  oradate.c
  *
- * Copyright (C) 2002-2008 KUBO Takehiro <kubo at jiubao.org>
+ * Copyright (C) 2002-2012 KUBO Takehiro <kubo at jiubao.org>
  *
  * date and time between 4712 B.C. and 9999 A.D.
  */
@@ -14,9 +14,8 @@
 /*
  * Document-class: OraDate
  *
- * ruby class compatible with Oracle <tt>DATE</tt> data type.
- * Date and time between 4712 B.C. and 9999 A.D.
- *
+ * OraDate is the ruby class compatible with Oracle <tt>DATE</tt> data type.
+ * The range is between 4712 B.C. and 9999 A.D.
  */
 struct ora_date {
     unsigned char century;
@@ -79,10 +78,15 @@
 }
 
 /*
- * call-seq:
- *   OraDate.new(year = 1, month = 1, day = 1, hour = 0, min = 0, sec = 0) -> oradate
+ *  call-seq:
+ *   initialize(year = 1, month = 1, day = 1, hour = 0, min = 0, sec = 0)
  *
- * Returns an <code>OraDate</code> object initialized to the specified date and time.
+ *  Returns an <code>OraDate</code> object initialized to the specified date and time.
+ *
+ *  @example
+ *    OraDate.new              # => 0001-01-01 00:00:00
+ *    OraDate.new(2012)        # => 2012-01-01 00:00:00
+ *    OraDate.new(2012, 3, 4)  # => 2012-03-04 00:00:00
  */
 static VALUE ora_date_initialize(int argc, VALUE *argv, VALUE self)
 {
@@ -138,7 +142,9 @@
     return Qnil;
 }
 
-/* :nodoc: */
+/*
+ *  @private
+ */
 static VALUE ora_date_initialize_copy(VALUE lhs, VALUE rhs)
 {
     ora_date_t *l, *r;
@@ -151,11 +157,10 @@
 }
 
 /*
- * call-seq:
- *   OraDate.now() -> oradate
+ *  Returns an <code>OraDate</code> object initialized to the
+ *  current local time.
  *
- * Returns an <code>OraDate</code> object initialized to the
- * current local time.
+ *  @return [OraDate]
  */
 static VALUE ora_date_s_now(int argc, VALUE *argv, VALUE klass)
 {
@@ -183,11 +188,10 @@
 }
 
 /*
- * call-seq:
- *   oradate.to_s -> string
+ *  Returns a string representing <i>self</i>.
+ *  The string format is 'yyyy/mm/dd hh:mi:ss'.
  *
- * Returns a string representing <i>oradate</i>.
- * The string format is 'yyyy/mm/dd hh:mi:ss'.
+ *  @return [OraDate]
  */
 static VALUE ora_date_to_s(VALUE self)
 {
@@ -201,11 +205,9 @@
 }
 
 /*
- * call-seq:
- *   oradate.to_a -> array
+ *  Returns a 6-element <i>array</i> of year, month, day, hour, minute and second.
  *
- * Returns a 6-element <i>array</i> of values for <i>oradate</i>:
- * {<code>[year, month, day, hour, minute, second]</code>}.
+ *  @return [Array]
  */
 static VALUE ora_date_to_a(VALUE self)
 {
@@ -223,10 +225,9 @@
 }
 
 /*
- * call-seq:
- *   oradate.year -> fixnum
+ *  Returns the year field of <i>self</i>.
  *
- * Returns the year (-4712..9999) for <i>oradate</i>.
+ *  @return [Fixnum]
  */
 static VALUE ora_date_year(VALUE self)
 {
@@ -237,10 +238,12 @@
 }
 
 /*
- * call-seq:
- *   oradate.year = fixnum
+ *  call-seq:
+ *    year = num
  *
- * Sets the year (-4712..9999) for <i>oradate</i>.
+ *  Assigns <i>num</i> to the year field of <i>self</i>.
+ *
+ *  @param [Fixnum] number between -4712 and 9999
  */
 static VALUE ora_date_set_year(VALUE self, VALUE val)
 {
@@ -255,10 +258,10 @@
 }
 
 /*
- * call-seq:
- *   oradate.month -> fixnum
+ *  Returns the month field of <i>self</i>.
+ *  The month starts with one.
  *
- * Returns the month of the year (1..12) for <i>oradate</i>.
+ *  @return [Fixnum]
  */
 static VALUE ora_date_month(VALUE self)
 {
@@ -269,10 +272,13 @@
 }
 
 /*
- * call-seq:
- *   oradate.month = fixnum
+ *  call-seq:
+ *    month = num
  *
- * Sets the month of the year (1..12) for <i>oradate</i>.
+ *  Assigns <i>num</i> to the month field of <i>self</i>.
+ *  The month starts with one.
+ *
+ *  @param [Fixnum] number between 1 and 12
  */
 static VALUE ora_date_set_month(VALUE self, VALUE val)
 {
@@ -287,10 +293,9 @@
 }
 
 /*
- * call-seq:
- *   oradate.day -> fixnum
+ *  Returns the day of month field of <i>self</i>.
  *
- * Returns the day of the month (1..31) for <i>oradate</i>.
+ *  @return [Fixnum]
  */
 static VALUE ora_date_day(VALUE self)
 {
@@ -301,10 +306,12 @@
 }
 
 /*
- * call-seq:
- *   oradate.day = fixnum
+ *  call-seq:
+ *    day = num
  *
- * Sets the day of the month (1..31) for <i>oradate</i>.
+ *  Assigns <i>num</i> to the day of month field of <i>self</i>.
+ *
+ *  @param [Fixnum] number between 1 and 31
  */
 static VALUE ora_date_set_day(VALUE self, VALUE val)
 {
@@ -319,10 +326,9 @@
 }
 
 /*
- * call-seq:
- *   oradate.hour -> fixnum
+ *  Returns the hour field of <i>self</i>.
  *
- * Returns the hour of the day (0..23) for <i>oradate</i>.
+ *  @return [Fixnum]
  */
 static VALUE ora_date_hour(VALUE self)
 {
@@ -333,10 +339,12 @@
 }
 
 /*
- * call-seq:
- *   oradate.hour = fixnum
+ *  call-seq:
+ *    hour = num
  *
- * Sets the hour of the day (0..23) for <i>oradate</i>.
+ *  Assigns <i>num</i> to the hour field of <i>self</i>.
+ *
+ *  @param [Fixnum] number between 0 and 23
  */
 static VALUE ora_date_set_hour(VALUE self, VALUE val)
 {
@@ -351,10 +359,9 @@
 }
 
 /*
- * call-seq:
- *   oradate.minute -> fixnum
+ *  Returns the minute field of <i>self</i>.
  *
- * Returns the minute of the hour (0..59) for <i>oradate</i>.
+ *  @return [Fixnum]
  */
 static VALUE ora_date_minute(VALUE self)
 {
@@ -365,10 +372,12 @@
 }
 
 /*
- * call-seq:
- *   oradate.minute = fixnum
+ *  call-seq:
+ *    minute = num
  *
- * Sets the minute of the hour (0..59) for <i>oradate</i>.
+ *  Assigns <i>num</i> to the minute field of <i>self</i>.
+ *
+ *  @param [Fixnum] number between 0 and 59
  */
 static VALUE ora_date_set_minute(VALUE self, VALUE val)
 {
@@ -383,10 +392,9 @@
 }
 
 /*
- * call-seq:
- *   oradate.second -> fixnum
+ *  Returns the second field of <i>self</i>.
  *
- * Returns the second of the minute (0..59) for <i>oradate</i>.
+ *  @return [Fixnum]
  */
 static VALUE ora_date_second(VALUE self)
 {
@@ -397,10 +405,12 @@
 }
 
 /*
- * call-seq:
- *   oradate.second = fixnum
+ *  call-seq:
+ *    second = num
  *
- * Sets the second of the minute (0..59) for <i>oradate</i>.
+ *  Assigns <i>num</i> to the second field of <i>self</i>.
+ *
+ *  @param [Fixnum] number between 0 and 59
  */
 static VALUE ora_date_set_second(VALUE self, VALUE val)
 {
@@ -415,13 +425,13 @@
 }
 
 /*
- * call-seq:
- *   oradate.trunc
+ *  Truncates hour, minute and second fields to zero.
  *
- * Truncates hour, minute and second to zero for <i>oradate</i>.
+ *  @example
+ *    oradate = OraDate.now  # => 2008/07/17 11:07:30
+ *    oradate.trunc          # => 2008/07/17 00:00:00
  *
- *   oradate = OraDate.now   # 2008/07/17 11:07:30
- *   oradate.trunc           # 2008/07/17 00:00:00
+ *  @return [OraDate]
  */
 static VALUE ora_date_trunc(VALUE self)
 {
@@ -435,12 +445,11 @@
 }
 
 /*
- * call-seq:
- *   oradate1 <=> oradate2 -> -1, 0, +1
+ *  call-seq:
+ *     self <=> other
  *
- * Comparison---Compares <i>oradate1</i> with <i>oradate2</i>.
- * Other comparison operators are available because
- * <code>Comparable</code> module is included.
+ *  Returns -1, 0, or +1 depending on whether <i>self</i> is less than,
+ *  equal to, or greater than <i>other</i>.
  */
 static VALUE ora_date_cmp(VALUE self, VALUE val)
 {
@@ -465,7 +474,9 @@
     return INT2FIX(0);
 }
 
-/* :nodoc: */
+/*
+ *  @private
+ */
 static VALUE ora_date_hash(VALUE self)
 {
     ora_date_t *od;
@@ -483,10 +494,11 @@
 }
 
 /*
- * call-seq:
- *   oradate._dump -> string
+ *  Serializes <i>self</i>.
+ *  This method is called by Marshal.dump().
  *
- * Dumps <i>oradate</i> for marshaling.
+ *  @return [String] a byte stream
+ *  @see OraDate._load
  */
 static VALUE ora_date_dump(int argc, VALUE *argv, VALUE self)
 {
@@ -496,10 +508,15 @@
 }
 
 /*
- * call-seq:
- *   OraDate._load(string) -> oradate
+ *  call-seq:
+ *    _load(bytes)
  *
- * Unmarshals a dumped <code>OraDate</code> object.
+ *  Restores a byte stream serialized by {OraDate#_dump}.
+ *  This method is called by Marshal.load() to deserialize a byte stream
+ *  created by Marshal.dump().
+ *
+ *  @param [String] bytes a byte stream
+ *  @return [OraDate] an deserialized object
  */
 static VALUE ora_date_s_load(VALUE klass, VALUE str)
 {
@@ -516,9 +533,9 @@
 }
 
 /*
- * Document-class: OCI8::BindType::OraDate
+ *  Document-class: OCI8::BindType::OraDate
  *
- * This is a helper class to bind OraDate as Oracle's <tt>DATE</tt> datatype.
+ *  This is a helper class to bind OraDate as Oracle's <tt>DATE</tt> datatype.
  *
  */
 static VALUE bind_oradate_get(oci8_bind_t *obind, void *data, void *null_struct)

Modified: trunk/ruby-oci8/lib/oci8/encoding-init.rb
===================================================================
--- trunk/ruby-oci8/lib/oci8/encoding-init.rb	2012-04-05 13:36:06 UTC (rev 500)
+++ trunk/ruby-oci8/lib/oci8/encoding-init.rb	2012-04-06 12:26:57 UTC (rev 501)
@@ -2,6 +2,7 @@
 # setup default OCI encoding from NLS_LANG.
 #
 
+#
 class OCI8
 
   # get the environment variable NLS_LANG.

Modified: trunk/ruby-oci8/lib/oci8/oci8.rb
===================================================================
--- trunk/ruby-oci8/lib/oci8/oci8.rb	2012-04-05 13:36:06 UTC (rev 500)
+++ trunk/ruby-oci8/lib/oci8/oci8.rb	2012-04-06 12:26:57 UTC (rev 501)
@@ -690,6 +690,8 @@
 end # OCI8
 
 class OraDate
+
+  # Returns a Time object which denotes self.
   def to_time
     begin
       Time.local(year, month, day, hour, minute, second)
@@ -699,31 +701,40 @@
     end
   end
 
+  # Returns a Date object which denotes self.
   def to_date
     Date.new(year, month, day)
   end
 
   if defined? DateTime # ruby 1.8.0 or upper
 
-    # get timezone offset.
+    # timezone offset of the time the command started
+    # @private
     @@tz_offset = Time.now.utc_offset.to_r/86400
 
+    # Returns a DateTime object which denotes self.
+    #
+    # Note that this is not daylight saving time aware.
+    # The Time zone offset is that of the time the command started.
     def to_datetime
       DateTime.new(year, month, day, hour, minute, second, @@tz_offset)
     end
   end
 
-  def yaml_initialize(type, val) # :nodoc:
+  # @private
+  def yaml_initialize(type, val)
     initialize(*val.split(/[ -\/:]+/).collect do |i| i.to_i end)
   end
 
-  def to_yaml(opts = {}) # :nodoc:
+  # @private
+  def to_yaml(opts = {})
     YAML.quick_emit(object_id, opts) do |out|
       out.scalar(taguri, self.to_s, :plain)
     end
   end
 
-  def to_json(options=nil) # :nodoc:
+  # @private
+  def to_json(options=nil)
     to_datetime.to_json(options)
   end
 end

Modified: trunk/ruby-oci8/lib/oci8/ocihandle.rb
===================================================================
--- trunk/ruby-oci8/lib/oci8/ocihandle.rb	2012-04-05 13:36:06 UTC (rev 500)
+++ trunk/ruby-oci8/lib/oci8/ocihandle.rb	2012-04-06 12:26:57 UTC (rev 501)
@@ -1,9 +1,9 @@
-#--
 # ocihandle.rb -- Constants in OCIHandle.
 #
-# Copyright (C) 2010 KUBO Takehiro <kubo at jiubao.org>
-#++
+# Copyright (C) 2010-2012 KUBO Takehiro <kubo at jiubao.org>
 
+# The abstract base class to implement common behavior of OCI handle data types and OCI descriptor data types.
+#
 class OCIHandle
 
   #################################
@@ -13,261 +13,393 @@
   #################################
 
   # maximum size of the data
+  # @private
   OCI_ATTR_DATA_SIZE          =   1
 
   # the SQL type of the column/argument
+  # @private
   OCI_ATTR_DATA_TYPE          =   2
   # the name of the column/argument
+  # @private
   OCI_ATTR_NAME               =   4
   # precision if number type
+  # @private
   OCI_ATTR_PRECISION          =   5
   # scale if number type
+  # @private
   OCI_ATTR_SCALE              =   6
   # is it null ?
+  # @private
   OCI_ATTR_IS_NULL            =   7
   # name of the named data type or a package name
+  # @private
   OCI_ATTR_TYPE_NAME          =   8
   # the schema name
+  # @private
   OCI_ATTR_SCHEMA_NAME        =   9
   # type name if package private type
+  # @private
   OCI_ATTR_SUB_NAME           =  10
   # relative position
+  # @private
   OCI_ATTR_POSITION           =  11
   # packed decimal scale
+  # @private
   OCI_ATTR_PDSCL              =  16
   # fs prec for datetime data types
+  # @private
   OCI_ATTR_FSPRECISION        = OCI_ATTR_PDSCL
   # packed decimal format
+  # @private
   OCI_ATTR_PDPRC              =  17
   # fs prec for datetime data types
+  # @private
   OCI_ATTR_LFPRECISION        = OCI_ATTR_PDPRC
   # username attribute
+  # @private
   OCI_ATTR_USERNAME           =  22
   # password attribute
+  # @private
   OCI_ATTR_PASSWORD           =  23
   # Character Set ID
+  # @private
   OCI_ATTR_CHARSET_ID         =  31
   # Character Set Form
+  # @private
   OCI_ATTR_CHARSET_FORM       =  32
   # number of columns
+  # @private
   OCI_ATTR_NUM_COLS           = 102
   # parameter of the column list
+  # @private
   OCI_ATTR_LIST_COLUMNS       = 103
   # DBA of the segment header
+  # @private
   OCI_ATTR_RDBA               = 104
   # whether the table is clustered
+  # @private
   OCI_ATTR_CLUSTERED          = 105
   # whether the table is partitioned
+  # @private
   OCI_ATTR_PARTITIONED        = 106
   # whether the table is index only
+  # @private
   OCI_ATTR_INDEX_ONLY         = 107
   # parameter of the argument list
+  # @private
   OCI_ATTR_LIST_ARGUMENTS     = 108
   # parameter of the subprogram list
+  # @private
   OCI_ATTR_LIST_SUBPROGRAMS   = 109
   # REF to the type descriptor
+  # @private
   OCI_ATTR_REF_TDO            = 110
   # the database link name 
+  # @private
   OCI_ATTR_LINK               = 111
   # minimum value
+  # @private
   OCI_ATTR_MIN                = 112
   # maximum value
+  # @private
   OCI_ATTR_MAX                = 113
   # increment value
+  # @private
   OCI_ATTR_INCR               = 114
   # number of sequence numbers cached
+  # @private
   OCI_ATTR_CACHE              = 115
   # whether the sequence is ordered
+  # @private
   OCI_ATTR_ORDER              = 116
   # high-water mark
+  # @private
   OCI_ATTR_HW_MARK            = 117
   # type's schema name
+  # @private
   OCI_ATTR_TYPE_SCHEMA        = 118
   # timestamp of the object
+  # @private
   OCI_ATTR_TIMESTAMP          = 119
   # number of parameters
+  # @private
   OCI_ATTR_NUM_PARAMS         = 121
   # object id for a table or view
+  # @private
   OCI_ATTR_OBJID              = 122
   # overload ID for funcs and procs
+  # @private
   OCI_ATTR_OVERLOAD_ID        = 125
   # table name space
+  # @private
   OCI_ATTR_TABLESPACE         = 126
   # list type
+  # @private
   OCI_ATTR_LTYPE              = 128
   # whether table is temporary
+  # @private
   OCI_ATTR_IS_TEMPORARY       = 130
   # whether table is typed
+  # @private
   OCI_ATTR_IS_TYPED           = 131
   # duration of temporary table
+  # @private
   OCI_ATTR_DURATION           = 132
   # is invoker rights
+  # @private
   OCI_ATTR_IS_INVOKER_RIGHTS  = 133
   # top level schema obj name
+  # @private
   OCI_ATTR_OBJ_NAME           = 134
   # schema name
+  # @private
   OCI_ATTR_OBJ_SCHEMA         = 135
   # top level schema object id
+  # @private
   OCI_ATTR_OBJ_ID             = 136
 
+  # @private
   OCI_ATTR_CONN_NOWAIT        = 178
+  # @private
   OCI_ATTR_CONN_BUSY_COUNT    = 179
+  # @private
   OCI_ATTR_CONN_OPEN_COUNT    = 180
+  # @private
   OCI_ATTR_CONN_TIMEOUT       = 181
+  # @private
   OCI_ATTR_CONN_MIN           = 183
+  # @private
   OCI_ATTR_CONN_MAX           = 184
+  # @private
   OCI_ATTR_CONN_INCR          = 185
 
   # is this position overloaded
+  # @private
   OCI_ATTR_OVERLOAD           = 210
   # level for structured types
+  # @private
   OCI_ATTR_LEVEL              = 211
   # has a default value
+  # @private
   OCI_ATTR_HAS_DEFAULT        = 212
   # in, out inout
+  # @private
   OCI_ATTR_IOMODE             = 213
   # returns a radix
+  # @private
   OCI_ATTR_RADIX              = 214
   # total number of arguments
+  # @private
   OCI_ATTR_NUM_ARGS           = 215
   # object or collection
+  # @private
   OCI_ATTR_TYPECODE           = 216
   # varray or nested table
+  # @private
   OCI_ATTR_COLLECTION_TYPECODE = 217
   # user assigned version
+  # @private
   OCI_ATTR_VERSION            = 218
   # is this an incomplete type
+  # @private
   OCI_ATTR_IS_INCOMPLETE_TYPE = 219
   # a system type
+  # @private
   OCI_ATTR_IS_SYSTEM_TYPE     = 220
   # a predefined type
+  # @private
   OCI_ATTR_IS_PREDEFINED_TYPE = 221
   # a transient type
+  # @private
   OCI_ATTR_IS_TRANSIENT_TYPE  = 222
   # system generated type
+  # @private
   OCI_ATTR_IS_SYSTEM_GENERATED_TYPE = 223
   # contains nested table attr
+  # @private
   OCI_ATTR_HAS_NESTED_TABLE   = 224
   # has a lob attribute
+  # @private
   OCI_ATTR_HAS_LOB            = 225
   # has a file attribute
+  # @private
   OCI_ATTR_HAS_FILE           = 226
   # has a collection attribute
+  # @private
   OCI_ATTR_COLLECTION_ELEMENT = 227
   # number of attribute types
+  # @private
   OCI_ATTR_NUM_TYPE_ATTRS     = 228
   # list of type attributes
+  # @private
   OCI_ATTR_LIST_TYPE_ATTRS    = 229
   # number of type methods
+  # @private
   OCI_ATTR_NUM_TYPE_METHODS   = 230
   # list of type methods
+  # @private
   OCI_ATTR_LIST_TYPE_METHODS  = 231
   # map method of type
+  # @private
   OCI_ATTR_MAP_METHOD         = 232
   # order method of type 
+  # @private
   OCI_ATTR_ORDER_METHOD       = 233
   # number of elements
+  # @private
   OCI_ATTR_NUM_ELEMS          = 234
   # encapsulation level
+  # @private
   OCI_ATTR_ENCAPSULATION      = 235
   # method selfish
+  # @private
   OCI_ATTR_IS_SELFISH         = 236
   # virtual
+  # @private
   OCI_ATTR_IS_VIRTUAL         = 237
   # inline
+  # @private
   OCI_ATTR_IS_INLINE          = 238
   # constant
+  # @private
   OCI_ATTR_IS_CONSTANT        = 239
   # has result
+  # @private
   OCI_ATTR_HAS_RESULT         = 240
   # constructor
+  # @private
   OCI_ATTR_IS_CONSTRUCTOR     = 241
   # destructor
+  # @private
   OCI_ATTR_IS_DESTRUCTOR      = 242
   # operator
+  # @private
   OCI_ATTR_IS_OPERATOR        = 243
   # a map method
+  # @private
   OCI_ATTR_IS_MAP             = 244
   # order method
+  # @private
   OCI_ATTR_IS_ORDER           = 245
   # read no data state method
+  # @private
   OCI_ATTR_IS_RNDS            = 246
   # read no process state
+  # @private
   OCI_ATTR_IS_RNPS            = 247
   # write no data state method
+  # @private
   OCI_ATTR_IS_WNDS            = 248
   # write no process state
+  # @private
   OCI_ATTR_IS_WNPS            = 249
+  # @private
   OCI_ATTR_IS_SUBTYPE         = 258
+  # @private
   OCI_ATTR_SUPERTYPE_SCHEMA_NAME = 259
+  # @private
   OCI_ATTR_SUPERTYPE_NAME     = 260
   # list of objects in schema
+  # @private
   OCI_ATTR_LIST_OBJECTS       = 261
   # char set id
+  # @private
   OCI_ATTR_NCHARSET_ID        = 262
   # list of schemas
+  # @private
   OCI_ATTR_LIST_SCHEMAS       = 263
   # max procedure length
+  # @private
   OCI_ATTR_MAX_PROC_LEN       = 264
   # max column name length
+  # @private
   OCI_ATTR_MAX_COLUMN_LEN     = 265
   # cursor commit behavior
+  # @private
   OCI_ATTR_CURSOR_COMMIT_BEHAVIOR = 266
   # catalog namelength
+  # @private
   OCI_ATTR_MAX_CATALOG_NAMELEN = 267
   # catalog location
+  # @private
   OCI_ATTR_CATALOG_LOCATION   = 268
   # savepoint support
+  # @private
   OCI_ATTR_SAVEPOINT_SUPPORT  = 269
   # nowait support
+  # @private
   OCI_ATTR_NOWAIT_SUPPORT     = 270
   # autocommit DDL
+  # @private
   OCI_ATTR_AUTOCOMMIT_DDL     = 271
   # locking mode
+  # @private
   OCI_ATTR_LOCKING_MODE       = 272
   # value of client id to set
+  # @private
   OCI_ATTR_CLIENT_IDENTIFIER  = 278
   # is final type ?
+  # @private
   OCI_ATTR_IS_FINAL_TYPE      = 279
   # is instantiable type ?
+  # @private
   OCI_ATTR_IS_INSTANTIABLE_TYPE = 280
   # is final method ?
+  # @private
   OCI_ATTR_IS_FINAL_METHOD    = 281
   # is instantiable method ?
+  # @private
   OCI_ATTR_IS_INSTANTIABLE_METHOD = 282
   # is overriding method ?
+  # @private
   OCI_ATTR_IS_OVERRIDING_METHOD = 283
   # Describe the base object
+  # @private
   OCI_ATTR_DESC_SYNBASE       = 284
   # char length semantics
+  # @private
   OCI_ATTR_CHAR_USED          = 285
   # char length
+  # @private
   OCI_ATTR_CHAR_SIZE          = 286
   # rule condition
+  # @private
   OCI_ATTR_CONDITION          = 342
   # comment
+  # @private
   OCI_ATTR_COMMENT            = 343
   # Anydata value
+  # @private
   OCI_ATTR_VALUE              = 344
   # eval context owner
+  # @private
   OCI_ATTR_EVAL_CONTEXT_OWNER = 345
   # eval context name
+  # @private
   OCI_ATTR_EVAL_CONTEXT_NAME  = 346
   # eval function name
+  # @private
   OCI_ATTR_EVALUATION_FUNCTION = 347
   # variable type
+  # @private
   OCI_ATTR_VAR_TYPE           = 348
   # variable value function
+  # @private
   OCI_ATTR_VAR_VALUE_FUNCTION = 349
   # variable method function
+  # @private
   OCI_ATTR_VAR_METHOD_FUNCTION = 350
   # action context
+  # @private
   OCI_ATTR_ACTION_CONTEXT     = 351
   # list of table aliases
+  # @private
   OCI_ATTR_LIST_TABLE_ALIASES = 352
   # list of variable types
+  # @private
   OCI_ATTR_LIST_VARIABLE_TYPES = 353
   # table name
+  # @private
   OCI_ATTR_TABLE_NAME         = 356
 
   #################################
@@ -277,6 +409,7 @@
   #################################
 
   # the default value for parameters and attributes
+  # @private
   OCI_DEFAULT                 =   0
 
   #################################
@@ -286,8 +419,10 @@
   #################################
 
   # database username/password credentials
+  # @private
   OCI_CRED_RDBMS              =   1
   # externally provided credentials
+  # @private
   OCI_CRED_EXT                =   2
 
   #################################
@@ -297,76 +432,95 @@
   #################################
 
   # for SYSDBA authorization
+  # @private
   OCI_SYSDBA                  = 0x0002
   # for SYSOPER authorization
+  # @private
   OCI_SYSOPER                 = 0x0004
   # for SYSASM authorization
+  # @private
   OCI_SYSASM                  = 0x8000
 
   #################################
   #
-  # Attach Modes
-  #
-  #################################
-
-  # Attach using server handle from pool
-  OCI_CPOOL                   = 0x0200
-
-  #################################
-  #
   # OCI Parameter Types
   #
   #################################
 
   # parameter type for unknown type
+  # @private
   OCI_PTYPE_UNK               =  0
   # parameter type for table
+  # @private
   OCI_PTYPE_TABLE             =  1
   # parameter type for view
+  # @private
   OCI_PTYPE_VIEW              =  2
   # parameter type for procedure
+  # @private
   OCI_PTYPE_PROC              =  3
   # parameter type for function
+  # @private
   OCI_PTYPE_FUNC              =  4
   # parameter type for package
+  # @private
   OCI_PTYPE_PKG               =  5
   # parameter type for user-defined type
+  # @private
   OCI_PTYPE_TYPE              =  6
   # parameter type for synonym
+  # @private
   OCI_PTYPE_SYN               =  7
   # parameter type for sequence
+  # @private
   OCI_PTYPE_SEQ               =  8
   # parameter type for column
+  # @private
   OCI_PTYPE_COL               =  9
   # parameter type for argument
+  # @private
   OCI_PTYPE_ARG               = 10
   # parameter type for list
+  # @private
   OCI_PTYPE_LIST              = 11
   # parameter type for user-defined type's attribute
+  # @private
   OCI_PTYPE_TYPE_ATTR         = 12
   # parameter type for collection type's element
+  # @private
   OCI_PTYPE_TYPE_COLL         = 13
   # parameter type for user-defined type's method
+  # @private
   OCI_PTYPE_TYPE_METHOD       = 14
   # parameter type for user-defined type method's arg
+  # @private
   OCI_PTYPE_TYPE_ARG          = 15
   # parameter type for user-defined type method's result
+  # @private
   OCI_PTYPE_TYPE_RESULT       = 16
   # parameter type for schema
+  # @private
   OCI_PTYPE_SCHEMA            = 17
   # parameter type for database
+  # @private
   OCI_PTYPE_DATABASE          = 18
   # parameter type for rule
+  # @private
   OCI_PTYPE_RULE              = 19
   # parameter type for rule set
+  # @private
   OCI_PTYPE_RULE_SET          = 20
   # parameter type for evaluation context
+  # @private
   OCI_PTYPE_EVALUATION_CONTEXT = 21
   # parameter type for table alias
+  # @private
   OCI_PTYPE_TABLE_ALIAS       = 22
   # parameter type for variable type
+  # @private
   OCI_PTYPE_VARIABLE_TYPE     = 23
   # parameter type for name value pair
+  # @private
   OCI_PTYPE_NAME_VALUE        = 24
 
   #################################
@@ -376,34 +530,49 @@
   #################################
 
   # list type for unknown type
+  # @private
   OCI_LTYPE_UNK                =  0
   # list type for column list
+  # @private
   OCI_LTYPE_COLUMN             =  1
   # list type for procedure argument list
+  # @private
   OCI_LTYPE_ARG_PROC           =  2
   # list type for function argument list
+  # @private
   OCI_LTYPE_ARG_FUNC           =  3
   # list type for subprogram list
+  # @private
   OCI_LTYPE_SUBPRG             =  4
   # list type for type attribute
+  # @private
   OCI_LTYPE_TYPE_ATTR          =  5
   # list type for type method
+  # @private
   OCI_LTYPE_TYPE_METHOD        =  6
   # list type for type method w/o result argument list
+  # @private
   OCI_LTYPE_TYPE_ARG_PROC      =  7
   # list type for type method w/result argument list
+  # @private
   OCI_LTYPE_TYPE_ARG_FUNC      =  8
   # list type for schema object list
+  # @private
   OCI_LTYPE_SCH_OBJ            =  9
   # list type for database schema list
+  # @private
   OCI_LTYPE_DB_SCH             = 10
   # list type for subtype list
+  # @private
   OCI_LTYPE_TYPE_SUBTYPE       = 11
   # list type for table alias list
+  # @private
   OCI_LTYPE_TABLE_ALIAS        = 12
   # list type for variable type list
+  # @private
   OCI_LTYPE_VARIABLE_TYPE      = 13
   # list type for name value list
+  # @private
   OCI_LTYPE_NAME_VALUE         = 14
 
   #################################
@@ -413,15 +582,26 @@
   #################################
 
   #
+  # @private
   OCI_DURATION_INVALID       = 0xFFFF
+  # @private
   OCI_DURATION_BEGIN         = 10
+  # @private
   OCI_DURATION_NULL          = OCI_DURATION_BEGIN - 1
+  # @private
   OCI_DURATION_DEFAULT       = OCI_DURATION_BEGIN - 2
+  # @private
   OCI_DURATION_USER_CALLBACK = OCI_DURATION_BEGIN - 3
+  # @private
   OCI_DURATION_NEXT          = OCI_DURATION_BEGIN - 4
+  # @private
   OCI_DURATION_SESSION       = OCI_DURATION_BEGIN
+  # @private
   OCI_DURATION_TRANS         = OCI_DURATION_BEGIN + 1
+  # @private
   OCI_DURATION_CALL          = OCI_DURATION_BEGIN + 2
+  # @private
   OCI_DURATION_STATEMENT     = OCI_DURATION_BEGIN + 3
+  # @private
   OCI_DURATION_CALLOUT       = OCI_DURATION_BEGIN + 4
 end



More information about the ruby-oci8-commit mailing list