Skip to content
Browse files

Adding documentation infrastructure.

  • Loading branch information...
1 parent 3030acf commit a827ce3cd68ddba44829e4f4078d080642d526ca @JEG2 committed Jan 1, 2010
View
1 .gitignore
@@ -0,0 +1 @@
+doc
View
1 AUTHORS.rdoc
@@ -0,0 +1 @@
+<b>James Edward Gray II</b>:: {james@graysoftinc.com}[mailto:james@graysoftinc.com]
View
7 CHANGELOG.rdoc
@@ -0,0 +1,7 @@
+= Change Log
+
+Below is a complete listing of changes for each revision of Oklahoma Mixer.
+
+== 0.1.0
+
+* Initial public release with Hash Database support
View
22 INSTALL.rdoc
@@ -0,0 +1,22 @@
+= Installing Oklahoma Mixer
+
+RubyGems is the preferred install method for Oklahoma Mixer.
+
+== Installing the Gem
+
+Oklahoma Mixer is intended to be installed via the
+RubyGems[http://rubyforge.org/projects/rubygems/] system. To get the latest
+version, simply enter the following into your command prompt:
+
+ $ sudo gem install oklahoma_mixer
+
+You must have RubyGems[http://rubyforge.org/projects/rubygems/] installed for
+the above to work.
+
+== Running the Tests
+
+If you would like to run Oklahoma Mixer's test suite on your system and you have
+Rake installed, just issue the following command from the root of the project
+directory:
+
+ $ rake
View
19 MIT-LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2010 James Edward Gray II
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
25 Rakefile
@@ -1,13 +1,22 @@
require "rake/testtask"
+require "rake/rdoctask"
desc "Default task: run all tests"
-task :default => "test:unit"
+task :default => :test
-namespace :test do
- Rake::TestTask.new(:unit) do |test|
- test.libs << "test"
- test.pattern = "test/**/*_test.rb"
- test.warning = true
- test.verbose = true
- end
+Rake::TestTask.new do |test|
+ test.libs << "test"
+ test.pattern = "test/**/*_test.rb"
+ test.warning = true
+ test.verbose = true
+end
+
+Rake::RDocTask.new do |rdoc|
+ rdoc.main = "README.rdoc"
+ rdoc.rdoc_dir = "doc/html"
+ rdoc.title = "Oklahoma Mixer Documentation"
+ rdoc.rdoc_files.include *%w[ README.rdoc INSTALL.rdoc
+ TODO.rdoc CHANGELOG.rdoc
+ AUTHORS.rdoc MIT-LICENSE
+ lib/ ]
end
View
11 TODO.rdoc
@@ -0,0 +1,11 @@
+= To Do List
+
+The following is a list of planned expansions for Oklahoma Mixer in the order I
+intend to address them.
+
+1. Add support for B+Tree and Fixed-length Databases
+2. Add support for Table Databases
+3. Ensure Ruby 1.9 compatibility
+4. Add support for Tokyo Tyrant
+5. Add support for Tokyo Dystopia
+6. Include some higher level abstractions like mixed tables, queues, and shards
View
2 lib/oklahoma_mixer/array_list.rb
@@ -1,5 +1,5 @@
module OklahomaMixer
- class ArrayList
+ class ArrayList # :nodoc:
def initialize(pointer = C.new)
@pointer = pointer
end
View
2 lib/oklahoma_mixer/array_list/c.rb
@@ -1,6 +1,6 @@
module OklahomaMixer
class ArrayList
- module C
+ module C # :nodoc:
extend OklahomaMixer::Utilities::FFIDSL
prefix :tclist
View
2 lib/oklahoma_mixer/extensible_string.rb
@@ -1,5 +1,5 @@
module OklahomaMixer
- class ExtensibleString
+ class ExtensibleString # :nodoc:
def initialize(pointer = C.new)
@pointer = pointer
end
View
2 lib/oklahoma_mixer/extensible_string/c.rb
@@ -1,6 +1,6 @@
module OklahomaMixer
class ExtensibleString
- module C
+ module C # :nodoc:
extend OklahomaMixer::Utilities::FFIDSL
prefix :tcxstr
View
2 lib/oklahoma_mixer/hash_database/c.rb
@@ -1,6 +1,6 @@
module OklahomaMixer
class HashDatabase
- module C
+ module C # :nodoc:
extend OklahomaMixer::Utilities::FFIDSL
MODES = enum :HDBOREADER, 1 << 0,
View
4 lib/oklahoma_mixer/utilities.rb
@@ -1,6 +1,6 @@
module OklahomaMixer
- module Utilities
- module FFIDSL
+ module Utilities # :nodoc:
+ module FFIDSL # :nodoc:
def self.extended(ffi_interface)
ffi_interface.extend(FFI::Library)
ffi_interface.ffi_lib(

0 comments on commit a827ce3

Please sign in to comment.
Something went wrong with that request. Please try again.