darkfish-rdoc 1.1.1 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/ChangeLog +52 -0
- data/README +14 -8
- data/Rakefile +18 -4
- data/lib/darkfish-rdoc.rb +1 -1
- data/lib/rdoc/generator/darkfish.rb +23 -6
- data/lib/rdoc/generator/template/darkfish/classpage.rhtml +276 -0
- data/lib/rdoc/generator/template/darkfish/filepage.rhtml +52 -0
- data/lib/rdoc/generator/template/darkfish/images/brick.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/brick_link.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/bullet_black.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/date.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/package.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/page_green.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/page_white_width.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/plugin.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/ruby.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/tag_green.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/wrench.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/wrench_orange.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/zoom.png +0 -0
- data/lib/rdoc/generator/template/darkfish/index.rhtml +48 -0
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +80 -0
- data/lib/rdoc/generator/template/darkfish/js/jquery.js +32 -0
- data/lib/rdoc/generator/template/darkfish/js/quicksearch.js +113 -0
- data/lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js +10 -0
- data/lib/rdoc/generator/template/darkfish/rdoc.css +658 -0
- data/rake/helpers.rb +33 -1
- data/rake/publishing.rb +38 -36
- data/rake/rdoc.rb +2 -2
- data/rake/svn.rb +26 -6
- data/spec/rdoc/generator/darkfish_spec.rb +54 -0
- metadata +29 -6
data/ChangeLog
CHANGED
@@ -1,3 +1,55 @@
|
|
1
|
+
-- Thu, 14 Aug 2008 00:59:07 -0000 by deveiant (r24) -----
|
2
|
+
Changed: /trunk
|
3
|
+
lib/rdoc/generator/darkfish.rb
|
4
|
+
Rakefile
|
5
|
+
lib/darkfish-rdoc.rb
|
6
|
+
|
7
|
+
* Updated build system
|
8
|
+
|
9
|
+
|
10
|
+
-- Sat, 09 Aug 2008 01:14:22 -0000 by deveiant (r23) -----
|
11
|
+
Added: spec/rdoc/generator (new)
|
12
|
+
spec/rdoc/generator/darkfish_spec.rb (new)
|
13
|
+
spec/rdoc (new)
|
14
|
+
spec (new)
|
15
|
+
Changed: project.yml
|
16
|
+
lib/rdoc/generator/template/darkfish/rdoc.css
|
17
|
+
lib/rdoc/generator/darkfish.rb
|
18
|
+
Rakefile
|
19
|
+
ChangeLog
|
20
|
+
Deleted: lib/rdoc/generator/template/darkfish/images/bullet_go.png
|
21
|
+
lib/rdoc/generator/template/darkfish/images/lightbulb.png
|
22
|
+
lib/rdoc/generator/template/darkfish/images/page_white_ruby.png
|
23
|
+
lib/rdoc/generator/template/darkfish/images/tag_blue.png
|
24
|
+
lib/rdoc/generator/template/darkfish/images/tag_blue_edit.png
|
25
|
+
lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png (and 12 other/s)
|
26
|
+
|
27
|
+
* Updated build system.
|
28
|
+
* Fixed distributions, which didn't have the static files included with them.
|
29
|
+
* Removed a bunch of unused static files
|
30
|
+
* Fixed the path to the bg hack for Thickbox on Macs
|
31
|
+
* Added the beginnings of a test suite. Don't know yet how to test the generator in isolation.
|
32
|
+
|
33
|
+
|
34
|
+
-- Fri, 08 Aug 2008 13:15:20 -0000 by deveiant (r22) -----
|
35
|
+
Changed: /trunk
|
36
|
+
Rakefile
|
37
|
+
project.yml
|
38
|
+
Deleted: misc/rake
|
39
|
+
|
40
|
+
Checkpoint commit
|
41
|
+
|
42
|
+
|
43
|
+
-- Fri, 08 Aug 2008 02:47:22 -0000 by deveiant (r21) -----
|
44
|
+
Changed: README
|
45
|
+
lib/rdoc/generator/template/darkfish/classpage.rhtml
|
46
|
+
Rakefile
|
47
|
+
ChangeLog
|
48
|
+
lib/rdoc/generator/template/darkfish/js/darkfish.js
|
49
|
+
|
50
|
+
Checkpoint commit
|
51
|
+
|
52
|
+
|
1
53
|
-- Thu, 07 Aug 2008 06:56:40 -0000 by deveiant (r18) -----
|
2
54
|
Added: lib/rdoc/generator/darkfish.rb
|
3
55
|
-> renamed from /trunk/lib/rdoc/generator/darkfish_generator.rb@r16
|
data/README
CHANGED
@@ -15,8 +15,8 @@ I created it with a few goals in mind:
|
|
15
15
|
modified Allison template (<URL:http://www.superalloy.nl/blog/?p=7>) Eloy
|
16
16
|
Duran came up with.
|
17
17
|
|
18
|
-
* Implemented using ERB
|
19
|
-
templating.
|
18
|
+
* Implemented using separate ERB template files instead of Rdoc's
|
19
|
+
constants-in-a-module style templating.
|
20
20
|
|
21
21
|
I think I mostly succeeded, and it's nice enough that I wanted to use it for all
|
22
22
|
my documentation, and I thought you might want to, too. Or at least be able to
|
@@ -38,16 +38,22 @@ Or download the source and do:
|
|
38
38
|
|
39
39
|
== Usage
|
40
40
|
|
41
|
-
|
42
|
-
|
41
|
+
Because of the way Rdoc and Rubygems work, there's currently no way to make the
|
42
|
+
Darkfish generator available to Rdoc from the command line 'rdoc' tool if you
|
43
|
+
have it installed as a gem, but if you install it as a regular Ruby library
|
44
|
+
(via 'rake install'), you can do this:
|
43
45
|
|
44
46
|
$ rdoc -w 4 -SHN -f darkfish -m README README lib
|
45
47
|
|
46
|
-
|
48
|
+
I'm trying to figure out how to resolve this for the gem. Suggestions welcomed.
|
49
|
+
|
50
|
+
You can, however, load the formatter as a gem from a Rakefile before you define
|
51
|
+
the RDocTask:
|
47
52
|
|
48
53
|
### Task: rdoc
|
49
54
|
require 'rake/rdoctask'
|
50
|
-
gem 'darkfish-rdoc'
|
55
|
+
gem 'darkfish-rdoc' # Omit this if it's installed as a regular library
|
56
|
+
require 'darkfish-rdoc'
|
51
57
|
|
52
58
|
Rake::RDocTask.new do |rdoc|
|
53
59
|
rdoc.title = "My Awesome SnoCone Library"
|
@@ -68,8 +74,8 @@ That's it.
|
|
68
74
|
|
69
75
|
== Feedback
|
70
76
|
|
71
|
-
I'd be happy to have feedback via email <URL: mailto:ged at FaerieMUD dot org>
|
72
|
-
the project's Trac:
|
77
|
+
I'd be happy to have feedback via email <URL: mailto:ged at FaerieMUD dot org>
|
78
|
+
or a ticket on the project's Trac:
|
73
79
|
|
74
80
|
http://deveiate.org/projects/Darkfish-Rdoc/
|
75
81
|
|
data/Rakefile
CHANGED
@@ -63,7 +63,17 @@ RAKE_TASKLIBS = Pathname.glob( RAKE_TASKDIR + '*.rb' )
|
|
63
63
|
|
64
64
|
LOCAL_RAKEFILE = BASEDIR + 'Rakefile.local'
|
65
65
|
|
66
|
-
|
66
|
+
EXTRA_PKGFILES = []
|
67
|
+
EXTRA_PKGFILES.concat Pathname.glob( BASEDIR + 'lib/rdoc/generator/**/*.{css,rhtml,png,js}' ).delete_if {|item| item =~ /\.svn/ }
|
68
|
+
|
69
|
+
RELEASE_FILES = TEXT_FILES +
|
70
|
+
SPEC_FILES +
|
71
|
+
TEST_FILES +
|
72
|
+
LIB_FILES +
|
73
|
+
EXT_FILES +
|
74
|
+
RAKE_TASKLIBS +
|
75
|
+
EXTRA_PKGFILES
|
76
|
+
|
67
77
|
RELEASE_FILES << LOCAL_RAKEFILE if LOCAL_RAKEFILE.exist?
|
68
78
|
|
69
79
|
COVERAGE_MINIMUM = ENV['COVERAGE_MINIMUM'] ? Float( ENV['COVERAGE_MINIMUM'] ) : 85.0
|
@@ -114,7 +124,8 @@ SMTP_PORT = 465 # SMTP + SSL
|
|
114
124
|
PROJECT_HOST = 'deveiate.org'
|
115
125
|
PROJECT_PUBDIR = "/usr/local/www/public/code"
|
116
126
|
PROJECT_DOCDIR = "#{PROJECT_PUBDIR}/#{PKG_NAME}"
|
117
|
-
|
127
|
+
PROJECT_SCPPUBURL = "#{PROJECT_HOST}:#{PROJECT_PUBDIR}"
|
128
|
+
PROJECT_SCPDOCURL = "#{PROJECT_HOST}:#{PROJECT_DOCDIR}"
|
118
129
|
|
119
130
|
# Rubyforge stuff
|
120
131
|
RUBYFORGE_GROUP = 'deveiate'
|
@@ -122,7 +133,7 @@ RUBYFORGE_PROJECT = 'darkfish-rdoc'
|
|
122
133
|
|
123
134
|
# Gem dependencies: gemname => version
|
124
135
|
DEPENDENCIES = {
|
125
|
-
'rdoc
|
136
|
+
'rdoc' => '>= 2.1.0',
|
126
137
|
}
|
127
138
|
|
128
139
|
# Non-gem requirements: packagename => version
|
@@ -192,7 +203,10 @@ import LOCAL_RAKEFILE if LOCAL_RAKEFILE.exist?
|
|
192
203
|
#####################################################################
|
193
204
|
|
194
205
|
### Default task
|
195
|
-
task :default => [:clean, :spec, :rdoc, :package]
|
206
|
+
task :default => [:clean, :local, :spec, :rdoc, :package]
|
207
|
+
|
208
|
+
### Task the local Rakefile can append to -- no-op by default
|
209
|
+
task :local
|
196
210
|
|
197
211
|
|
198
212
|
### Task: clean
|
data/lib/darkfish-rdoc.rb
CHANGED
@@ -8,7 +8,7 @@ require 'pathname'
|
|
8
8
|
require 'rdoc/rdoc' unless defined?( RDoc ) && defined?( RDoc::RDoc )
|
9
9
|
|
10
10
|
### Version for the Rakefile (update this in rdoc/generator/darkfish.rb too)
|
11
|
-
# VERSION = '1.1.
|
11
|
+
# VERSION = '1.1.2'
|
12
12
|
|
13
13
|
begin
|
14
14
|
generator_dir = Pathname.new( __FILE__ ).dirname + 'rdoc/generator'
|
@@ -1,7 +1,7 @@
|
|
1
1
|
#!ruby
|
2
2
|
#
|
3
3
|
# Darkfish RDoc HTML Generator
|
4
|
-
# $Id: darkfish.rb
|
4
|
+
# $Id: darkfish.rb 24 2008-08-14 00:59:07Z deveiant $
|
5
5
|
#
|
6
6
|
# Author: Michael Granger <ged@FaerieMUD.org>
|
7
7
|
#
|
@@ -48,18 +48,22 @@ class RDoc::Generator::Darkfish < RDoc::Generator::XML
|
|
48
48
|
include ERB::Util
|
49
49
|
|
50
50
|
# Subversion rev
|
51
|
-
SVNRev = %$Rev:
|
51
|
+
SVNRev = %$Rev: 24 $
|
52
52
|
|
53
53
|
# Subversion ID
|
54
|
-
SVNId = %$Id: darkfish.rb
|
54
|
+
SVNId = %$Id: darkfish.rb 24 2008-08-14 00:59:07Z deveiant $
|
55
55
|
|
56
56
|
# Path to this file's parent directory. Used to find templates and other
|
57
57
|
# resources.
|
58
58
|
GENERATOR_DIR = Pathname.new( __FILE__ ).expand_path.dirname
|
59
59
|
|
60
60
|
# Darkfish Version (update this in )
|
61
|
-
VERSION = '1.1.
|
62
|
-
|
61
|
+
VERSION = '1.1.2'
|
62
|
+
|
63
|
+
|
64
|
+
#################################################################
|
65
|
+
### C L A S S M E T H O D S
|
66
|
+
#################################################################
|
63
67
|
|
64
68
|
### Standard generator factory method
|
65
69
|
def self::for( options )
|
@@ -67,6 +71,10 @@ class RDoc::Generator::Darkfish < RDoc::Generator::XML
|
|
67
71
|
end
|
68
72
|
|
69
73
|
|
74
|
+
#################################################################
|
75
|
+
### I N S T A N C E M E T H O D S
|
76
|
+
#################################################################
|
77
|
+
|
70
78
|
### Initialize a few instance variables before we start
|
71
79
|
def initialize( *args )
|
72
80
|
@template = nil
|
@@ -82,6 +90,14 @@ class RDoc::Generator::Darkfish < RDoc::Generator::XML
|
|
82
90
|
end
|
83
91
|
|
84
92
|
|
93
|
+
######
|
94
|
+
public
|
95
|
+
######
|
96
|
+
|
97
|
+
# The output directory
|
98
|
+
attr_reader :outputdir
|
99
|
+
|
100
|
+
|
85
101
|
### Output progress information if debugging is enabled
|
86
102
|
def debug_msg( *msg )
|
87
103
|
return unless $DEBUG
|
@@ -120,6 +136,7 @@ class RDoc::Generator::Darkfish < RDoc::Generator::XML
|
|
120
136
|
|
121
137
|
rescue StandardError => err
|
122
138
|
debug_msg "%s: %s\n %s" % [ err.class.name, err.message, err.backtrace.join("\n ") ]
|
139
|
+
raise
|
123
140
|
end
|
124
141
|
|
125
142
|
|
@@ -275,7 +292,7 @@ class RDoc::Generator::Darkfish < RDoc::Generator::XML
|
|
275
292
|
end
|
276
293
|
|
277
294
|
|
278
|
-
# %q$Id: darkfish.rb
|
295
|
+
# %q$Id: darkfish.rb 24 2008-08-14 00:59:07Z deveiant $"
|
279
296
|
SVNID_PATTERN = /
|
280
297
|
\$Id:\s
|
281
298
|
(\S+)\s # filename
|
@@ -0,0 +1,276 @@
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
+
<head>
|
6
|
+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
|
7
|
+
|
8
|
+
<title><%= classinfo['classmod'] %>: <%= classinfo['full_name'] %></title>
|
9
|
+
|
10
|
+
<link rel="stylesheet" href="<%= rel_prefix %>/rdoc.css" type="text/css" media="screen" />
|
11
|
+
|
12
|
+
<script src="<%= rel_prefix %>/js/jquery.js" type="text/javascript"
|
13
|
+
charset="utf-8"></script>
|
14
|
+
<script src="<%= rel_prefix %>/js/thickbox-compressed.js" type="text/javascript"
|
15
|
+
charset="utf-8"></script>
|
16
|
+
<script src="<%= rel_prefix %>/js/quicksearch.js" type="text/javascript"
|
17
|
+
charset="utf-8"></script>
|
18
|
+
<script src="<%= rel_prefix %>/js/darkfish.js" type="text/javascript"
|
19
|
+
charset="utf-8"></script>
|
20
|
+
|
21
|
+
<script type="text/javascript" charset="utf-8">
|
22
|
+
$(document).ready( function() {
|
23
|
+
hookSourceViews();
|
24
|
+
hookQuickSearch();
|
25
|
+
highlightLocationTarget();
|
26
|
+
|
27
|
+
$('ul.link-list a').bind( "click", highlightClickTarget );
|
28
|
+
});
|
29
|
+
</script>
|
30
|
+
|
31
|
+
</head>
|
32
|
+
<body class="<%= classinfo['classmod'].downcase %>">
|
33
|
+
|
34
|
+
<div id="metadata">
|
35
|
+
<div id="file-metadata">
|
36
|
+
<div id="file-list-section" class="section">
|
37
|
+
<h3 class="section-header">In Files</h3>
|
38
|
+
<div class="section-body">
|
39
|
+
<ul>
|
40
|
+
<% classinfo['infiles'].each do |file| %>
|
41
|
+
<li><a href="<%= rel_prefix %>/<%= file['full_path'] %>.html?TB_iframe=true&height=400&width=600"
|
42
|
+
class="thickbox" title="<%= file['full_path'] %>"><%= file['full_path'] %></a></li>
|
43
|
+
<% end %>
|
44
|
+
</ul>
|
45
|
+
</div>
|
46
|
+
</div>
|
47
|
+
|
48
|
+
<% if !svninfo.empty? %>
|
49
|
+
<div id="file-svninfo-section" class="section">
|
50
|
+
<h3 class="section-header">Subversion Info</h3>
|
51
|
+
<div class="section-body">
|
52
|
+
<dl class="svninfo">
|
53
|
+
<dt>Rev</dt>
|
54
|
+
<dd><%= svninfo[:rev] %></dd>
|
55
|
+
|
56
|
+
<dt>Last Checked In</dt>
|
57
|
+
<dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
|
58
|
+
(<%= svninfo[:commitdelta] %> ago)</dd>
|
59
|
+
|
60
|
+
<dt>Checked in by</dt>
|
61
|
+
<dd><%= svninfo[:committer] %></dd>
|
62
|
+
</dl>
|
63
|
+
</div>
|
64
|
+
</div>
|
65
|
+
<% end %>
|
66
|
+
</div>
|
67
|
+
|
68
|
+
<div id="class-metadata">
|
69
|
+
|
70
|
+
<!-- Parent Class -->
|
71
|
+
<% if classinfo['classmod'] == 'Class' %>
|
72
|
+
<div id="parent-class-section" class="section">
|
73
|
+
<h3 class="section-header">Parent</h3>
|
74
|
+
<% if classinfo['par_url'] %>
|
75
|
+
<p class="link"><a href="<%= classinfo['par_url'] %>"><%= classinfo['parent'] %></a></p>
|
76
|
+
<% else %>
|
77
|
+
<p class="link"><%= classinfo['parent'] %></p>
|
78
|
+
<% end %>
|
79
|
+
</div>
|
80
|
+
<% end %>
|
81
|
+
|
82
|
+
<!-- Namespace Contents -->
|
83
|
+
<% if classinfo['sections'].first.key?( 'classlist' ) %>
|
84
|
+
<div id="namespace-list-section" class="section">
|
85
|
+
<h3 class="section-header">Namespace</h3>
|
86
|
+
<ul class="link-list">
|
87
|
+
<% classinfo['sections'].first['classlist'].each do |desc| %>
|
88
|
+
<!-- Desc is: <%= desc.inspect %> -->
|
89
|
+
<li><%= desc.sub(/^(\w+)/, %Q{<span class="type">\\1</span>}) %></li>
|
90
|
+
<% end %>
|
91
|
+
</ul>
|
92
|
+
</div>
|
93
|
+
<% end %>
|
94
|
+
|
95
|
+
<!-- Method Quickref -->
|
96
|
+
<% if classinfo.key?( 'methods' ) %>
|
97
|
+
<div id="method-list-section" class="section">
|
98
|
+
<h3 class="section-header">Methods</h3>
|
99
|
+
<ul class="link-list">
|
100
|
+
<% classinfo['methods'].each do |meth| %>
|
101
|
+
<li><a href="#<%= meth['name'] %>"><%= meth['name']
|
102
|
+
%></a></li>
|
103
|
+
<% end %>
|
104
|
+
</ul>
|
105
|
+
</div>
|
106
|
+
<% end %>
|
107
|
+
|
108
|
+
<!-- Included Modules -->
|
109
|
+
<% if classinfo['includes'] %>
|
110
|
+
<div id="includes-section" class="section">
|
111
|
+
<h3 class="section-header">Included Modules</h3>
|
112
|
+
<ul class="link-list">
|
113
|
+
<% classinfo['includes'].each do |inc| %>
|
114
|
+
<% if inc['aref'].nil? %>
|
115
|
+
<li><span class="include"><%= inc['name'] %></span></li>
|
116
|
+
<% else %>
|
117
|
+
<li><a class="include" href="<%= inc['aref'] %>"><%= inc['name'] %></a></li>
|
118
|
+
<% end %>
|
119
|
+
<% end %>
|
120
|
+
</ul>
|
121
|
+
</div>
|
122
|
+
<% end %>
|
123
|
+
</div>
|
124
|
+
|
125
|
+
<div id="project-metadata">
|
126
|
+
<div id="classindex-section" class="section project-section">
|
127
|
+
<h3 class="section-header">Class Index</h3>
|
128
|
+
<ul class="link-list">
|
129
|
+
<% modsort.each do |cname| %>
|
130
|
+
<% cinfo = classes[cname] %>
|
131
|
+
<li><a href="<%= rel_prefix %>/<%= cinfo[:outfile] %>"><%= cname %></a></li>
|
132
|
+
<% end %>
|
133
|
+
</ul>
|
134
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
135
|
+
|
136
|
+
<form action="#" method="get" accept-charset="utf-8">
|
137
|
+
<fieldset>
|
138
|
+
<legend>Quicksearch</legend>
|
139
|
+
<input type="text" name="quicksearch" value=""
|
140
|
+
class="quicksearch-field" />
|
141
|
+
</fieldset>
|
142
|
+
</form>
|
143
|
+
</div>
|
144
|
+
</div>
|
145
|
+
</div>
|
146
|
+
|
147
|
+
<div id="documentation">
|
148
|
+
<% if classinfo['classmod'] == 'Class' %>
|
149
|
+
<h1 class="class"><%= classinfo['full_name'] %></h1>
|
150
|
+
<% else %>
|
151
|
+
<h1 class="module"><%= classinfo['full_name'] %></h1>
|
152
|
+
<% end %>
|
153
|
+
|
154
|
+
<div id="description">
|
155
|
+
<%= classinfo['description'] %>
|
156
|
+
</div>
|
157
|
+
|
158
|
+
|
159
|
+
<!-- Constants -->
|
160
|
+
<% if classinfo['sections'].first['constants'] %>
|
161
|
+
<div id="constants-list" class="section">
|
162
|
+
<h3 class="section-header">Constants</h3>
|
163
|
+
<dl>
|
164
|
+
<% classinfo['sections'].first['constants'].each do |const| %>
|
165
|
+
<dt><a name="<%= const['name'] %>"><%= const['name'] %></a></dt>
|
166
|
+
<% if const['desc'] %>
|
167
|
+
<dd class="description"><%= const['desc'].strip %></dd>
|
168
|
+
<% else %>
|
169
|
+
<dd class="description missing-docs">(Not documented)</dd>
|
170
|
+
<% end %>
|
171
|
+
<% end %>
|
172
|
+
</dl>
|
173
|
+
</div>
|
174
|
+
<% end %>
|
175
|
+
|
176
|
+
<!-- Attributes -->
|
177
|
+
<% if classinfo['sections'].first['attributes'] %>
|
178
|
+
<div id="attribute-method-details" class="method-section section">
|
179
|
+
<h3 class="section-header">Attributes</h3>
|
180
|
+
|
181
|
+
<% classinfo['sections'].first['attributes'].each do |attrib| %>
|
182
|
+
<div id="<%= attrib['name'].downcase.gsub(/[^a-z]+/, '-') %>-attribute-method" class="method-detail">
|
183
|
+
<a name="<%= attrib['name'] %>"></a>
|
184
|
+
<% if attrib['rw'] =~ /w/i %>
|
185
|
+
<a name="<%= attrib['name'] %>="></a>
|
186
|
+
<% end %>
|
187
|
+
<div class="method-heading attribute-method-heading">
|
188
|
+
<span class="method-name"><%= h attrib['name'] %></span><span
|
189
|
+
class="attribute-access-type">[<%= attrib['rw'] %>]</span>
|
190
|
+
</div>
|
191
|
+
|
192
|
+
<div class="method-description">
|
193
|
+
<% if attrib['a_desc'] && !attrib['a_desc'].empty? %>
|
194
|
+
<%= attrib['a_desc'].strip %>
|
195
|
+
<% else %>
|
196
|
+
<p class="missing-docs">(Not documented)</p>
|
197
|
+
<% end %>
|
198
|
+
</div>
|
199
|
+
</div>
|
200
|
+
<% end %>
|
201
|
+
</div>
|
202
|
+
<% end %>
|
203
|
+
|
204
|
+
<!-- Methods -->
|
205
|
+
<% if classinfo['sections'].first['method_list'] %>
|
206
|
+
<% classinfo['sections'].first['method_list'].each do |methodlist| %>
|
207
|
+
<div id="<%= methodlist['type'].downcase %>-<%= methodlist['category'].downcase %>-method-details" class="method-section section">
|
208
|
+
<h3 class="section-header"><%= methodlist['type'] %> <%= methodlist['category'] %> Methods</h3>
|
209
|
+
|
210
|
+
<% methodlist['methods'].each do |methodinfo| %>
|
211
|
+
<% if methodinfo['m_desc'] =~ /Alias for/ %>
|
212
|
+
<div id="<%= methodinfo['name'].gsub( /[^a-z]+/, '-' ) %>-method" class="method-detail method-alias">
|
213
|
+
<% else %>
|
214
|
+
<div id="<%= methodinfo['name'].gsub( /[^a-z]+/, '-' ) %>-method" class="method-detail">
|
215
|
+
<% end %>
|
216
|
+
<a name="<%= methodinfo['name'] %>"></a>
|
217
|
+
|
218
|
+
<div class="method-heading">
|
219
|
+
<span class="method-name"><%= methodinfo['name'] %></span><span
|
220
|
+
class="method-args"><%= methodinfo['params'] %></span>
|
221
|
+
<span class="method-click-advice">click to toggle source</span>
|
222
|
+
</div>
|
223
|
+
|
224
|
+
<div class="method-description">
|
225
|
+
<% if methodinfo['m_desc'] %>
|
226
|
+
<p><%= methodinfo['m_desc'].strip %></p>
|
227
|
+
<% else %>
|
228
|
+
<p class="missing-docs">(Not documented)</p>
|
229
|
+
<% end %>
|
230
|
+
|
231
|
+
<% if methodinfo['sourcecode'] %>
|
232
|
+
<div class="method-source-code"
|
233
|
+
id="<%= methodinfo['name'].gsub( /[^a-z]+/, '-' ) %>-source">
|
234
|
+
<pre>
|
235
|
+
<%= methodinfo['sourcecode'] %>
|
236
|
+
</pre>
|
237
|
+
</div>
|
238
|
+
<% end %>
|
239
|
+
</div>
|
240
|
+
|
241
|
+
<% if methodinfo['aka'] %>
|
242
|
+
<div class="aliases">
|
243
|
+
Also aliased as: <%= methodinfo['aka'].collect do |aliasinfo|
|
244
|
+
%{<a href="#{aliasinfo['aref']}">#{aliasinfo['name']}</a>}
|
245
|
+
end.join(", ") %>
|
246
|
+
</div>
|
247
|
+
<% end %>
|
248
|
+
</div>
|
249
|
+
<% end %>
|
250
|
+
</div>
|
251
|
+
<% end %>
|
252
|
+
<% end %>
|
253
|
+
|
254
|
+
</div>
|
255
|
+
</div>
|
256
|
+
|
257
|
+
|
258
|
+
<div id="rdoc-debugging-section-dump">
|
259
|
+
<% classinfo['sections'].first.keys.each do |section| %>
|
260
|
+
<div class="section">
|
261
|
+
<h2 class="section-header"><%= section %></h2>
|
262
|
+
|
263
|
+
<pre><%= h classinfo['sections'].first[section].to_yaml %></pre>
|
264
|
+
</div>
|
265
|
+
<% end %>
|
266
|
+
</div>
|
267
|
+
|
268
|
+
<div id="validator-badges">
|
269
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
270
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
271
|
+
Rdoc Generator</a></small>.</p>
|
272
|
+
</div>
|
273
|
+
|
274
|
+
</body>
|
275
|
+
</html>
|
276
|
+
|