@@ -1,74 +1,72 @@ = Changelog == Version 0.4.1 2008-09-28 -* Minor Enhancement - * update to SQLite3 version 3.6.3 +=== Minor Enhancement +* update to SQLite3 version 3.6.3 +* change rdoc template to darkfish == Version 0.4.0 2008-09-14 -* Major Enhancements - * update to SQLite3 version 3.6.2 and enable the RTree option by default - * Amalgalite::Requires module allowing ruby code to be 'required' from columns - in an SQLite database - * Amagalite::Requires::Bootstrap extension module enabling low level boot - strapping of the pure ruby Amalgalite code from an sqlite database - -* Minor Enhancements - * more indepth information about indexes is available via the Index class - * add support for sqlite3_status and sqlite3_db_status information - -* Bugfixes - * fix nil exception when using a declared_data_type on primary key column that - has no declared_data_type - * when Database#transaction is passed a block, the return value is the return - value of the block - * nested transactions are 'faked'. Calling Database#transaction while - Databased#in_transaction? is true does not result in an exception, but - continues on in the current transaction. - * raise LoadError if required in the same program as sqlite3-ruby. These - libraries conflict with each other. +=== Major Enhancements +* update to SQLite3 version 3.6.2 and enable the RTree option by default +* Amalgalite::Requires module allowing ruby code to be 'required' from columns + in an SQLite database +* Amagalite::Requires::Bootstrap extension module enabling low level boot + strapping of the pure ruby Amalgalite code from an sqlite database + +=== Minor Enhancements +* more indepth information about indexes is available via the Index class +* add support for sqlite3_status and sqlite3_db_status information + +=== Bugfixes +* fix nil exception when using a declared_data_type on primary key column that + has no declared_data_type +* when Database#transaction is passed a block, the return value is the return + value of the block +* nested transactions are 'faked'. Calling Database#transaction while + Databased#in_transaction? is true does not result in an exception, but + continues on in the current transaction. +* raise LoadError if required in the same program as sqlite3-ruby. These + libraries conflict with each other. == Version 0.2.4 2008-07-13 -* Bugfixes - * fix compilation when ruby is compiled without pthreads using +=== Bugfixes +* fix compilation when ruby is compiled without pthreads using == Version 0.2.3 2008-07-12 -* Bugfixes - * make sure file permissions are all read before shipping gem +=== Bugfixes +* make sure file permissions are all read before shipping gem == Version 0.2.2 2008-07-12 -* Bugfixes - * Database#pragma should accept a block just like Database#execute does - -* compatibility fix - * convert to using extconf.rb instead of mkrf to enable compilation as a - direct ruby extension in the ruby source tree +=== Bugfixes +* Database#pragma should accept a block just like Database#execute does +* convert to using extconf.rb instead of mkrf to enable compilation as a + direct ruby extension in the ruby source tree == Version 0.2.1 - 2008-07-05 -* Bugfixes - * make sure that the pthread support in sqlite3 matches that of ruby - * fix schema reloading in the example scripts +=== Bugfixes +* make sure that the pthread support in sqlite3 matches that of ruby +* fix schema reloading in the example scripts == Version 0.2.0 - 2008-07-04 -* Major Enhancements - * blob support, both incremental access and normal access +=== Major Enhancements +* blob support, both incremental access and normal access -* Minor Enhancements - * added examples/gem_db.rb script demonstrating taps and prepared statements - * added examples/schema-info.rb script demonstrating meta information - * added examples/blob.rb demonstrating incremental blob IO - * added access to the SQLite3 errcode and errmsg api +=== Minor Enhancements +* added examples/gem_db.rb script demonstrating taps and prepared statements +* added examples/schema-info.rb script demonstrating meta information +* added examples/blob.rb demonstrating incremental blob IO +* added access to the SQLite3 errcode and errmsg api -* Bugfixes - * added taps.rb for requiring - * fixed prepared statement reset - * caught an error in executing prepared statements earlier in the process so - the correct error is reported +=== Bugfixes +* added taps.rb for requiring +* fixed prepared statement reset +* caught an error in executing prepared statements earlier in the process so the correct error is reported == Version 0.1.0 - 2008-06-21 HISTORY @@ -5,18 +5,16 @@ All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the - distribution. +* Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. - * Neither the name of Jeremy Hinegardner nor the - names of its contributors may be used to endorse or promote - products derived from this software without specific prior written - permission. +* Neither the name of Jeremy Hinegardner nor the names of its contributors + may be used to endorse or promote products derived from this software without + specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED LICENSE @@ -151,7 +151,10 @@ VALUE am_sqlite3_libversion_number(VALUE self) } /** - * The Amalgalite ruby extension + * Document-class: Amalgalite::SQLite3 + * + * The SQLite ruby extension inside Amalgalite. + * */ void Init_amalgalite3() @@ -161,9 +164,6 @@ void Init_amalgalite3() */ mA = rb_define_module("Amalgalite"); - /* - * module encapsulating the SQLite C extension - */ mAS = rb_define_module_under(mA, "SQLite3"); rb_define_module_function(mAS, "threadsafe?", am_sqlite3_threadsafe, 0); rb_define_module_function(mAS, "complete?", am_sqlite3_complete, -2); @@ -178,7 +178,7 @@ void Init_amalgalite3() /* * Base class of all SQLite3 errors */ - eAS_Error = rb_define_class_under(mAS, "Error", rb_eStandardError); + eAS_Error = rb_define_class_under(mAS, "Error", rb_eStandardError); /* in amalgalite.c */ /** * Encapsulation of the SQLite C library version ext/amalgalite3.c @@ -6,7 +6,8 @@ * vim: shiftwidth=4 */ -VALUE cAS_Blob; /* class Amalgliate::SQLite3::Blob */ +/* class Amalgliate::SQLite3::Blob */ +VALUE cAS_Blob; /** * call-seq: @@ -212,6 +213,13 @@ VALUE am_sqlite3_blob_alloc(VALUE klass) } +/** + * Document-class: Amalgalite::SQLite3::Blob + * + * The Blob class enables incremental IO on blob items. If you do not need + * incremental IO on a binary object, then you do not need to use Blob. + */ + void Init_amalgalite3_blob( ) { ext/amalgalite3_blob.c @@ -1,6 +1,11 @@ /* Generated by gen_constants.rb -- do not edit */ #include "amalgalite3.h"; +/** + * Document-class: Amalgalite::SQLite3::Constants + * + * class holding constants in the sqlite extension + */ void Init_amalgalite3_constants( ) { ext/amalgalite3_constants.c @@ -509,7 +509,10 @@ VALUE am_sqlite3_database_alloc(VALUE klass) } /** - * Amalgalite Database + * Document-class: Amalgalite::SQLite3::Database + * + * The ruby extension wrapper around the core sqlite3 database object. + * */ void Init_amalgalite3_database( ) { ext/amalgalite3_database.c @@ -5,9 +5,6 @@ require 'amalgalite3' module Amalgalite::SQLite3 - ## - # module containing all constants used from the SQLite C extension - # module Constants module Helpers # lib/amalgalite/sqlite3/constants.rb @@ -85,7 +85,7 @@ Configuration.for('rdoc') { files Configuration.for('packaging').files.rdoc main_page files.first title Configuration.for('project').name - options %w[ --line-numbers --inline-source ] + options %w[ --line-numbers --inline-source -f darkfish ] output_dir "doc" } tasks/config.rb @@ -9,11 +9,13 @@ if rdoc_config = Configuration.for_if_exist?('rdoc') then namespace :doc do require 'rake/rdoctask' + gem 'darkfish-rdoc' + require 'darkfish-rdoc' # generating documentation locally Rake::RDocTask.new do |rdoc| rdoc.rdoc_dir = rdoc_config.output_dir - rdoc.options = rdoc_config.options + rdoc.options = rdoc_config.options rdoc.rdoc_files = rdoc_config.files rdoc.title = rdoc_config.title rdoc.main = rdoc_config.main_page tasks/documentation.rake f16060b331cce2fa38e2caa78b97c0db506e729e Jeremy Hinegardner jeremy@hinegardner.org http://github.com/copiousfreetime/amalgalite/commit/ab2063b5b6b52c190489bedc7107ce62b1016fa7 ab2063b5b6b52c190489bedc7107ce62b1016fa7 2008-09-28T21:36:25-07:00 2008-09-28T21:36:25-07:00 documentation fixes for darkfish template 3735e11f05b94b06b3a7dc58bb7d201c7ad86f9f Jeremy Hinegardner jeremy@hinegardner.org