[ruby-oci8-commit] [352] trunk/ruby-oci8: * Makefile: check rdoc version when making rdoc documentation.

nobody at rubyforge.org nobody at rubyforge.org
Fri Jun 5 00:39:28 EDT 2009


Revision: 352
Author:   kubo
Date:     2009-06-05 00:39:28 -0400 (Fri, 05 Jun 2009)

Log Message:
-----------
* Makefile: check rdoc version when making rdoc documentation.
    The rdoc version must be 2.4.
* ext/oci8/.document, ext/oci8/oci8.c, lib/.document,
  lib/oci8/.document, lib/oci8/oci8.rb: fix rdoc comments a bit.

Modified Paths:
--------------
    trunk/ruby-oci8/ChangeLog
    trunk/ruby-oci8/Makefile
    trunk/ruby-oci8/ext/oci8/.document
    trunk/ruby-oci8/ext/oci8/oci8.c
    trunk/ruby-oci8/lib/.document
    trunk/ruby-oci8/lib/oci8/.document
    trunk/ruby-oci8/lib/oci8/oci8.rb

Modified: trunk/ruby-oci8/ChangeLog
===================================================================
--- trunk/ruby-oci8/ChangeLog	2009-05-24 10:44:58 UTC (rev 351)
+++ trunk/ruby-oci8/ChangeLog	2009-06-05 04:39:28 UTC (rev 352)
@@ -1,3 +1,9 @@
+2009-06-05  KUBO Takehiro  <kubo at jiubao.org>
+	* Makefile: check rdoc version when making rdoc documentation.
+	    The rdoc version must be 2.4.
+	* ext/oci8/.document, ext/oci8/oci8.c, lib/.document,
+	  lib/oci8/.document, lib/oci8/oci8.rb: fix rdoc comments a bit.
+
 2009-05-24  KUBO Takehiro  <kubo at jiubao.org>
 	* ext/oci8/object.c, lib/oci8/datetime.rb, lib/oci8/object.rb:
 	    add DATE datatype support in object types.

Modified: trunk/ruby-oci8/Makefile
===================================================================
--- trunk/ruby-oci8/Makefile	2009-05-24 10:44:58 UTC (rev 351)
+++ trunk/ruby-oci8/Makefile	2009-06-05 04:39:28 UTC (rev 352)
@@ -1,5 +1,6 @@
 VERSION = `cat VERSION`
 RUBY = ruby -w
+RDOC = rdoc
 
 all: build
 
@@ -30,11 +31,17 @@
 	astyle --options=none --style=linux --indent=spaces=4 --brackets=linux --suffix=none ext/oci8/*.[ch]
 
 # internal use only
-.PHONY: rdoc
+.PHONY: rdoc check-rdoc-version run-rdoc
 
-rdoc:
-	$(RUBY) custom-rdoc.rb -o rdoc -U README ext/oci8 lib
+rdoc: check-rdoc-version run-rdoc
 
+check-rdoc-version:
+	@echo check rdoc version
+	@expr match "`$(RDOC) --version`" '^rdoc 2\.4' > /dev/null || (echo 'rdoc version is not 2.4.'; exit 1)
+
+run-rdoc:
+	TZ= $(RDOC) -o rdoc -c us-ascii --threads=1 -W http://ruby-oci8.rubyforge.org/svn/trunk/ruby-oci8/ ext/oci8 lib
+
 dist:
 	-rm -rf ruby-oci8-$(VERSION)
 	mkdir ruby-oci8-$(VERSION)

Modified: trunk/ruby-oci8/ext/oci8/.document
===================================================================
--- trunk/ruby-oci8/ext/oci8/.document	2009-05-24 10:44:58 UTC (rev 351)
+++ trunk/ruby-oci8/ext/oci8/.document	2009-06-05 04:39:28 UTC (rev 352)
@@ -1 +1,16 @@
-*.c
+#attr.c
+#oci8lib.c
+#env.c
+
+oci8.c
+bind.c
+stmt.c
+encoding.c
+error.c
+metadata.c
+
+lob.c
+ocinumber.c
+ocidatetime.c
+oradate.c
+object.c

Modified: trunk/ruby-oci8/ext/oci8/oci8.c
===================================================================
--- trunk/ruby-oci8/ext/oci8/oci8.c	2009-05-24 10:44:58 UTC (rev 351)
+++ trunk/ruby-oci8/ext/oci8/oci8.c	2009-06-05 04:39:28 UTC (rev 352)
@@ -21,24 +21,6 @@
 #define OCI_ATTR_CLIENT_IDENTIFIER 278
 #endif
 
-/*
- * Document-class: OCI8
- *
- * The class to access Oracle database server.
- *
- * example:
- *   # output the emp table's content as CSV format.
- *   conn = OCI8.new(username, password)
- *   conn.exec('select * from emp') do |row|
- *     puts row.join(',')
- *   end
- *
- *   # execute PL/SQL block with bind variables.
- *   conn = OCI8.new(username, password)
- *   conn.exec('BEGIN procedure_name(:1, :2); END;',
- *              value_for_the_first_parameter,
- *              value_for_the_second_parameter)
- */
 static VALUE cOCI8;
 
 static void oci8_svcctx_free(oci8_base_t *base)
@@ -830,6 +812,14 @@
 
 VALUE Init_oci8(void)
 {
+#if 0
+    /*
+     * OCIHandle is the abstract base class for all OCI handles and
+     * descriptors which are opaque data types of Oracle Call Interface.
+     */
+    oci8_cOCIHandle = rb_define_class("OCIHandle", rb_cObject);
+    cOCI8 = rb_define_class("OCI8", oci8_cOCIHandle);
+#endif
     cOCI8 = oci8_define_class("OCI8", &oci8_svcctx_class);
 
     oracle_client_vernum = INT2FIX(oracle_client_version);

Modified: trunk/ruby-oci8/lib/.document
===================================================================
--- trunk/ruby-oci8/lib/.document	2009-05-24 10:44:58 UTC (rev 351)
+++ trunk/ruby-oci8/lib/.document	2009-06-05 04:39:28 UTC (rev 352)
@@ -1,2 +1 @@
 oci8
-oci8.rb

Modified: trunk/ruby-oci8/lib/oci8/.document
===================================================================
--- trunk/ruby-oci8/lib/oci8/.document	2009-05-24 10:44:58 UTC (rev 351)
+++ trunk/ruby-oci8/lib/oci8/.document	2009-06-05 04:39:28 UTC (rev 352)
@@ -1,5 +1,4 @@
-oci8.rb
 object.rb
 metadata.rb
 oracle_version.rb
-
+oci8.rb

Modified: trunk/ruby-oci8/lib/oci8/oci8.rb
===================================================================
--- trunk/ruby-oci8/lib/oci8/oci8.rb	2009-05-24 10:44:58 UTC (rev 351)
+++ trunk/ruby-oci8/lib/oci8/oci8.rb	2009-06-05 04:39:28 UTC (rev 352)
@@ -1,16 +1,28 @@
-#--
-# oci8.rb -- OCI8 and OCI8::Cursor
+# oci8.rb -- implements OCI8 and OCI8::Cursor
 #
 # Copyright (C) 2002-2009 KUBO Takehiro <kubo at jiubao.org>
 #
 # Original Copyright is:
 #   Oracle module for Ruby
 #   1998-2000 by yoshidam
-#++
+#
 
 require 'date'
 
-# The database connection class.
+# A connection to a Oracle database server.
+#
+# example:
+#   # output the emp table's content as CSV format.
+#   conn = OCI8.new(username, password)
+#   conn.exec('select * from emp') do |row|
+#     puts row.join(',')
+#   end
+#
+#   # execute PL/SQL block with bind variables.
+#   conn = OCI8.new(username, password)
+#   conn.exec('BEGIN procedure_name(:1, :2); END;',
+#              value_for_the_first_parameter,
+#              value_for_the_second_parameter)
 class OCI8
   # Executes the sql statement. The type of return value depends on
   # the type of sql statement: select; insert, update and delete;




More information about the ruby-oci8-commit mailing list