malloc 0.2.2 → 0.2.3

data/.document

@@ -0,0 +1 @@
+lib/**/*.rb

data/Makefile

@@ -2,7 +2,7 @@
 .SUFFIXES: .gem .o .cc .hh .rb .tar .gz .bz2
 
 RUBY_VERSION = 1.8
-MALLOC_VERSION = 0.2.2
+MALLOC_VERSION = 0.2.3
 
 CP = cp
 RM = rm -Rf
@@ -15,7 +15,7 @@ GIT = git
 SITELIBDIR = $(shell $(RUBY) -r mkmf -e "puts \"\#{Config::CONFIG['sitelibdir']}\"")
 SITEARCHDIR = $(shell $(RUBY) -r mkmf -e "puts \"\#{Config::CONFIG['sitearchdir']}\"")
 
-MAIN = Makefile source.gemspec binary.gemspec README COPYING
+MAIN = Makefile source.gemspec binary.gemspec README COPYING .document
 EXT = ext/extconf.rb $(wildcard ext/*.cc) $(wildcard ext/*.hh)
 LIB = $(wildcard lib/*.rb)
 TEST = $(wildcard test/*.rb)
@@ -48,7 +48,7 @@ uninstall-gem::
 	$(GEM) uninstall malloc || echo Nothing to uninstall
 
 yardoc:: README $(LIB)
-	$(YARDOC)
+	$(YARDOC) --no-private
 
 check:: ext/malloc.so $(LIB) $(TEST)
 	$(RUBY) -rrubygems -Iext -Ilib -Itest test/ts_malloc.rb

data/README

@@ -1 +1,2 @@
 This Ruby extension defines the class Hornetseye::Malloc. Hornetseye::Malloc#new allows you to allocate memory, using Hornetseye::Malloc#+ one can do pointer manipulation, and Hornetseye::Malloc#read and Hornetseye::Malloc#write provide reading Ruby strings from memory and writing Ruby strings to memory.
+

data/binary.gemspec

@@ -1,7 +1,7 @@
 require 'date'
 Gem::Specification.new do |s|
   s.name = %q{malloc}
-  s.version = '0.2.2'
+  s.version = '0.2.3'
   s.platform = Gem::Platform::CURRENT
   s.date = Date.today.to_s
   s.summary = %q{Object for raw memory allocation and pointer operations}
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.author = %q{Jan Wedekind}
   s.email = %q{jan@wedesoft.de}
   s.homepage = %q{http://wedesoft.github.com/malloc/}
-  s.files = [ 'README', 'COPYING' ] +
+  s.files = [ 'README', 'COPYING', '.document' ] +
             Dir.glob( 'lib/*.rb' ) +
             [ 'ext/malloc.so' ] +
             Dir.glob( 'test/*.rb' )
@@ -17,6 +17,6 @@ Gem::Specification.new do |s|
   s.require_paths = [ 'lib', 'ext' ]
   s.rubyforge_project = %q{hornetseye}
   s.has_rdoc = 'yard'
-  # s.extra_rdoc_files = [ 'README' ]
-  # s.rdoc_options = %w{--exclude=/Makefile|.*\.(cc|hh|rb)/ --main README}
+  s.extra_rdoc_files = []
+  s.rdoc_options = %w{--no-private}
 end

data/ext/error.hh

@@ -11,21 +11,6 @@
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
-   You should have received a copy of the GNU General Public License
-   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
-/* HornetsEye - Computer Vision with Ruby
-   Copyright (C) 2006, 2007   Jan Wedekind
-   
-   This program is free software: you can redistribute it and/or modify
-   it under the terms of the GNU General Public License as published by
-   the Free Software Foundation, either version 3 of the License, or
-   (at your option) any later version.
-   
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   GNU General Public License for more details.
-   
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 #ifndef ERROR_HH

data/lib/malloc_ext.rb

@@ -1,12 +1,12 @@
 # Namespace of the Hornetseye project.
 module Hornetseye
 
-  # Class for allocating raw memory and for doing pointer operations.
+  # Class for allocating raw memory and for doing pointer operations
   class Malloc
 
     class << self
 
-      # Create new Malloc object.
+      # Create new Malloc object
       #
       # @param [size] Number of bytes to allocate.
       # @return [Malloc] A new Malloc object.
@@ -20,10 +20,12 @@ module Hornetseye
 
     end
 
-    # Number of bytes allocated.
+    # Number of bytes allocated
+    #
+    # @return [Integer] Size of allocated memory.
     attr_reader :size
 
-    # Operator for doing pointer arithmetic.
+    # Operator for doing pointer arithmetic
     #
     # @param [offset] Non-negative offset for pointer.
     # @return [Malloc] A new Malloc object.
@@ -39,7 +41,7 @@ module Hornetseye
 
     private :orig_plus
 
-    # Read data from memory.
+    # Read data from memory
     #
     # @param [length] Number of bytes to read.
     # @return [String] A string containing the data.
@@ -51,7 +53,7 @@ module Hornetseye
 
     private :orig_read
 
-    # Write data to memory.
+    # Write data to memory
     #
     # @param [string] A string with the data.
     # @return [String] Returns the parameter `string`.
@@ -69,14 +71,18 @@ module Hornetseye
 
 end
 
-# The string class of the standard library.
+# The string class of the standard library
+#
+# @private
 class String
 
   unless method_defined? :bytesize
 
-    # This method won't be overriden if it is defined already.
+    # This method won't be overriden if it is defined already
     #
     # Provided for compatibility with Ruby 1.8.6. Same as #size.
+    #
+    # @private
     def bytesize
       size
     end

data/source.gemspec

@@ -1,7 +1,7 @@
 require 'date'
 Gem::Specification.new do |s|
   s.name = %q{malloc}
-  s.version = '0.2.2'
+  s.version = '0.2.3'
   s.platform = Gem::Platform::RUBY
   s.date = Date.today.to_s
   s.summary = %q{Object for raw memory allocation and pointer operations}
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email = %q{jan@wedesoft.de}
   s.homepage = %q{http://wedesoft.github.com/malloc/}
   s.files = [ 'source.gemspec', 'binary.gemspec', 'Makefile', 'README',
-              'COPYING' ] +
+              'COPYING', '.document' ] +
             Dir.glob( 'lib/*.rb' ) +
             Dir.glob( 'ext/*.cc' ) +
             Dir.glob( 'ext/*.hh' ) +
@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{hornetseye}
   s.extensions = %w{ext/extconf.rb}
   s.has_rdoc = 'yard'
-  # s.extra_rdoc_files = [ 'README' ]
-  # s.rdoc_options = %w{--exclude=/Makefile|.*\.(cc|hh|rb)/ --main README}
+  s.extra_rdoc_files = []
+  s.rdoc_options = %w{--no-private}
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: malloc
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jan Wedekind
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-10 00:00:00 +00:00
+date: 2009-12-11 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -27,6 +27,7 @@ files:
 - Makefile
 - README
 - COPYING
+- .document
 - lib/malloc_ext.rb
 - ext/error.cc
 - ext/malloc.cc
@@ -41,8 +42,8 @@ homepage: http://wedesoft.github.com/malloc/
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --no-private
 require_paths: 
 - lib
 - ext