173 lines
3.5 KiB
HTML
173 lines
3.5 KiB
HTML
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||
|
|
<head>
|
||
|
|
<title>File: README.txt</title>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
||
|
|
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
||
|
|
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
|
||
|
|
<script type="text/javascript">
|
||
|
|
// <![CDATA[
|
||
|
|
|
||
|
|
function popupCode( url ) {
|
||
|
|
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
||
|
|
}
|
||
|
|
|
||
|
|
function toggleCode( id ) {
|
||
|
|
if ( document.getElementById )
|
||
|
|
elem = document.getElementById( id );
|
||
|
|
else if ( document.all )
|
||
|
|
elem = eval( "document.all." + id );
|
||
|
|
else
|
||
|
|
return false;
|
||
|
|
|
||
|
|
elemStyle = elem.style;
|
||
|
|
|
||
|
|
if ( elemStyle.display != "block" ) {
|
||
|
|
elemStyle.display = "block"
|
||
|
|
} else {
|
||
|
|
elemStyle.display = "none"
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Make codeblocks hidden by default
|
||
|
|
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
||
|
|
|
||
|
|
// ]]>
|
||
|
|
</script>
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div id="fileHeader">
|
||
|
|
<h1>README.txt</h1>
|
||
|
|
<table class="header-table">
|
||
|
|
<tr class="top-aligned-row">
|
||
|
|
<td><strong>Path:</strong></td>
|
||
|
|
<td>README.txt
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="top-aligned-row">
|
||
|
|
<td><strong>Last Update:</strong></td>
|
||
|
|
<td>Mon Mar 13 06:08:02 JST 2006</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- banner header -->
|
||
|
|
|
||
|
|
<div id="bodyContent">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div id="contextContent">
|
||
|
|
|
||
|
|
<div id="description">
|
||
|
|
<h1>README</h1>
|
||
|
|
<table>
|
||
|
|
<tr><td valign="top">revision:</td><td>$Rev: 1 $
|
||
|
|
|
||
|
|
</td></tr>
|
||
|
|
<tr><td valign="top">release:</td><td>$Release: 1.0.0 $
|
||
|
|
|
||
|
|
</td></tr>
|
||
|
|
<tr><td valign="top">copyright:</td><td>copyright© 2006 kuwata-lab.com all rights reserved.
|
||
|
|
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
<h2>Introduction</h2>
|
||
|
|
<p>
|
||
|
|
‘abstract.rb’ is a library which enable you to define abstract
|
||
|
|
method in Ruby.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
The followings are examples:
|
||
|
|
</p>
|
||
|
|
<pre>
|
||
|
|
## example1. (shorter notation)
|
||
|
|
require 'rubygems' # if installed with 'gem install'
|
||
|
|
require 'abstract'
|
||
|
|
class Foo
|
||
|
|
abstract_method 'arg1, arg2=""', :method1, :method2, :method3
|
||
|
|
end
|
||
|
|
|
||
|
|
## example2. (RDoc friendly notation)
|
||
|
|
require 'rubygems' # if installed with 'gem install'
|
||
|
|
require 'abstract'
|
||
|
|
class Bar
|
||
|
|
# ... method1 description ...
|
||
|
|
def method1(arg1, arg2="")
|
||
|
|
not_implemented
|
||
|
|
end
|
||
|
|
# ... method2 description ...
|
||
|
|
def method2(arg1, arg2="")
|
||
|
|
not_implemented
|
||
|
|
end
|
||
|
|
end
|
||
|
|
</pre>
|
||
|
|
<p>
|
||
|
|
Abstract method makes your code more descriptive. It is useful even for
|
||
|
|
dynamic language such as Ruby.
|
||
|
|
</p>
|
||
|
|
<h2>Installation</h2>
|
||
|
|
<ul>
|
||
|
|
<li>Type ‘gem install -r abstract’ with root account if you have
|
||
|
|
installed RubyGems.
|
||
|
|
|
||
|
|
</li>
|
||
|
|
<li>Or type ‘ruby setup.rb’ with root account if you can be root
|
||
|
|
account.
|
||
|
|
|
||
|
|
</li>
|
||
|
|
<li>Or copy lib/abstract.rb into proper directory such as
|
||
|
|
’/usr/local/lib/ruby/site_ruby’.
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h2>License</h2>
|
||
|
|
<p>
|
||
|
|
Ruby’s
|
||
|
|
</p>
|
||
|
|
<h2>Copyright</h2>
|
||
|
|
<p>
|
||
|
|
copyright© 2006 kuwata-lab.com all rights reserved.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- if includes -->
|
||
|
|
|
||
|
|
<div id="section">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- if method_list -->
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="validator-badges">
|
||
|
|
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|