From f4c75aeee3cdc7b2d554caab33a44f0de628c59f Mon Sep 17 00:00:00 2001
From: Tilman Sauerbeck <tilman@code-monkey.de>
Date: Sat, 26 Mar 2005 20:23:02 +0000
Subject: [PATCH] Added some RDoc documentation modifiers.

---
 ChangeLog            |  4 +++-
 lib/redact/part.rb   |  4 ++--
 lib/redact/redact.rb | 26 +++++++++++++-------------
 3 files changed, 18 insertions(+), 16 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 89df5f7..0c09547 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,5 @@
 --
-$Id: ChangeLog 4 2005-03-26 19:26:56Z tilman $
+$Id: ChangeLog 5 2005-03-26 20:23:02Z tilman $
 ++
 
 2005-03-26 Tilman Sauerbeck (tilman at code-monkey de)
@@ -7,6 +7,8 @@ $Id: ChangeLog 4 2005-03-26 19:26:56Z tilman $
           amx code
         * lib/redact/app.rb: Abort compilation if embryo_cc fails
         * lib/redact/app.rb: Use Kernel#raise instead of Kernel#fail
+        * lib/redact/{redact,part}.rb: Added some RDoc documentation
+          modifiers
 
 2005-03-22 Tilman Sauerbeck (tilman at code-monkey de)
         * lib/redact/app.rb: The default extension for Edje files is
diff --git a/lib/redact/part.rb b/lib/redact/part.rb
index 6b0b536..71f9823 100644
--- a/lib/redact/part.rb
+++ b/lib/redact/part.rb
@@ -1,5 +1,5 @@
 #--
-# $Id: part.rb 1 2005-03-26 01:32:38Z tilman $
+# $Id: part.rb 5 2005-03-26 20:23:02Z tilman $
 #
 # Copyright (c) 2005 Tilman Sauerbeck (tilman at code-monkey de)
 #
@@ -69,7 +69,7 @@ module Redact
 			end
 		end
 
-		def description(name = "default", value = 0.0)
+		def description(name = "default", value = 0.0) # :yields: desc
 			d = @descriptions[desc_key(name, value)]
 
 			block_given? ? (yield d) : d
diff --git a/lib/redact/redact.rb b/lib/redact/redact.rb
index 59740f7..078a63f 100644
--- a/lib/redact/redact.rb
+++ b/lib/redact/redact.rb
@@ -1,5 +1,5 @@
 #--
-# $Id: redact.rb 1 2005-03-26 01:32:38Z tilman $
+# $Id: redact.rb 5 2005-03-26 20:23:02Z tilman $
 #
 # Copyright (c) 2005 Tilman Sauerbeck (tilman at code-monkey de)
 #
@@ -27,7 +27,7 @@ require "imlib2"
 require "redact/part"
 require "redact/program"
 
-class Object
+class Object # :nodoc:
 	undef :id
 end
 
@@ -84,7 +84,7 @@ module Redact
 			@data = DataHash.new
 		end
 
-		def collection(name)
+		def collection(name) # :yields: collection
 			c = @collections[name]
 
 			block_given? ? (yield c) : c
@@ -105,7 +105,7 @@ module Redact
 		end
 	end
 
-	class DataHash < Hash
+	class DataHash < Hash # :nodoc:
 		def [](key)
 			super.value
 		end
@@ -115,7 +115,7 @@ module Redact
 		end
 	end
 
-	class HashEntry
+	class HashEntry # :nodoc:
 		attr_reader :key, :value
 
 		def initialize(key, value)
@@ -128,7 +128,7 @@ module Redact
 		end
 	end
 
-	class FontDirectory < Array
+	class FontDirectory < Array # :nodoc:
 		def to_eet_name
 			"Edje_Font_Directory"
 		end
@@ -138,7 +138,7 @@ module Redact
 		end
 	end
 
-	class FontDirectoryEntry
+	class FontDirectoryEntry # :nodoc:
 		attr_reader :filename
 
 		def initialize(filename)
@@ -154,7 +154,7 @@ module Redact
 		end
 	end
 
-	class ImageDirectory < Array
+	class ImageDirectory < Array # :nodoc:
 		def <<(entry)
 			super
 
@@ -170,7 +170,7 @@ module Redact
 		end
 	end
 
-	class ImageDirectoryEntry
+	class ImageDirectoryEntry # :nodoc:
 		attr_reader :filename, :image, :id
 
 		def initialize(filename)
@@ -203,7 +203,7 @@ module Redact
 		end
 	end
 
-	class CollectionDirectory < Array
+	class CollectionDirectory < Array # :nodoc:
 		def to_eet_name
 			"Edje_Part_Collection_Directory"
 		end
@@ -213,7 +213,7 @@ module Redact
 		end
 	end
 
-	class CollectionDirectoryEntry
+	class CollectionDirectoryEntry # :nodoc:
 		def initialize(col)
 			@name = col.name.to_str.dup.freeze
 			@id = col.id
@@ -247,7 +247,7 @@ module Redact
 			@script = nil
 		end
 
-		def part(name, type = :invalid)
+		def part(name, type = :invalid) # :yields: part
 			p = @parts[name]
 			if p.nil?
 				klass = case type
@@ -271,7 +271,7 @@ module Redact
 			block_given? ? (yield p) : p
 		end
 
-		def program(name, type = :invalid)
+		def program(name, type = :invalid) # :yields: program
 			p = @programs[name]
 			if p.nil?
 				klass = case type
-- 
2.30.2