rlzxdoc 0.0.1
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/History.txt +4 -0
- data/License.txt +21 -0
- data/Manifest.txt +36 -0
- data/README.txt +8 -0
- data/Rakefile +4 -0
- data/bin/rlzxdoc +54 -0
- data/config/hoe.rb +70 -0
- data/config/requirements.rb +17 -0
- data/lib/rlzxdoc/lzxclass.rb +65 -0
- data/lib/rlzxdoc/lzxfile.rb +73 -0
- data/lib/rlzxdoc/version.rb +9 -0
- data/lib/rlzxdoc.rb +98 -0
- data/lib/templates/class.rhtml +194 -0
- data/lib/templates/class_list.rhtml +28 -0
- data/lib/templates/index.html +24 -0
- data/lib/templates/nav.rhtml +35 -0
- data/lib/templates/styles.css +151 -0
- data/log/debug.log +0 -0
- data/script/destroy +14 -0
- data/script/generate +14 -0
- data/script/txt2html +74 -0
- data/setup.rb +1585 -0
- data/tasks/deployment.rake +34 -0
- data/tasks/environment.rake +7 -0
- data/tasks/website.rake +17 -0
- data/test/lzx/main.lzx +4 -0
- data/test/lzx/test1/class1.lzx +37 -0
- data/test/lzx/test1/class2.lzx +37 -0
- data/test/lzx/test1/library.lzx +3 -0
- data/test/test_helper.rb +2 -0
- data/test/test_rlzxdoc.rb +57 -0
- data/website/index.html +94 -0
- data/website/index.txt +37 -0
- data/website/javascripts/rounded_corners_lite.inc.js +285 -0
- data/website/stylesheets/screen.css +138 -0
- data/website/template.rhtml +48 -0
- metadata +95 -0
data/History.txt
ADDED
data/License.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2008 togawamanabu<togawamanabu@gmail.com>
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
data/Manifest.txt
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
History.txt
|
|
2
|
+
License.txt
|
|
3
|
+
Manifest.txt
|
|
4
|
+
README.txt
|
|
5
|
+
Rakefile
|
|
6
|
+
bin/rlzxdoc
|
|
7
|
+
config/hoe.rb
|
|
8
|
+
config/requirements.rb
|
|
9
|
+
lib/rlzxdoc.rb
|
|
10
|
+
lib/rlzxdoc/lzxclass.rb
|
|
11
|
+
lib/rlzxdoc/lzxfile.rb
|
|
12
|
+
lib/rlzxdoc/version.rb
|
|
13
|
+
lib/templates/class.rhtml
|
|
14
|
+
lib/templates/class_list.rhtml
|
|
15
|
+
lib/templates/index.html
|
|
16
|
+
lib/templates/nav.rhtml
|
|
17
|
+
lib/templates/styles.css
|
|
18
|
+
log/debug.log
|
|
19
|
+
script/destroy
|
|
20
|
+
script/generate
|
|
21
|
+
script/txt2html
|
|
22
|
+
setup.rb
|
|
23
|
+
tasks/deployment.rake
|
|
24
|
+
tasks/environment.rake
|
|
25
|
+
tasks/website.rake
|
|
26
|
+
test/lzx/main.lzx
|
|
27
|
+
test/lzx/test1/class1.lzx
|
|
28
|
+
test/lzx/test1/class2.lzx
|
|
29
|
+
test/lzx/test1/library.lzx
|
|
30
|
+
test/test_helper.rb
|
|
31
|
+
test/test_rlzxdoc.rb
|
|
32
|
+
website/index.html
|
|
33
|
+
website/index.txt
|
|
34
|
+
website/javascripts/rounded_corners_lite.inc.js
|
|
35
|
+
website/stylesheets/screen.css
|
|
36
|
+
website/template.rhtml
|
data/README.txt
ADDED
data/Rakefile
ADDED
data/bin/rlzxdoc
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
$:.unshift "#{File.dirname(__FILE__)}/../lib"
|
|
4
|
+
|
|
5
|
+
require 'optparse'
|
|
6
|
+
require 'rlzxdoc'
|
|
7
|
+
|
|
8
|
+
OptionParser.new do |opts|
|
|
9
|
+
opts.on("-H", "--help", "Displays this help info") do
|
|
10
|
+
puts "Usage: rlzxdoc basedir [options]"
|
|
11
|
+
puts opts
|
|
12
|
+
exit 0
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
opts.on("-V", "--version", "Display version") do
|
|
16
|
+
require 'rlzxdoc/version'
|
|
17
|
+
puts "#{File.basename($0)} #{Rlzxdoc::VERSION::STRING}"
|
|
18
|
+
exit(0)
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
opts.on("-O", "--output-dir") do |str|
|
|
22
|
+
@outputdir = str
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
opts.on("-E", "--except-dirs") do |str|
|
|
26
|
+
@exceptdirs = str.split(",")
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
opts.on("-L", "--locale") do |str|
|
|
30
|
+
@locale = str
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
opts.on("-P", "--output-private-keywords") do |str|
|
|
34
|
+
@output_private_keywords = str
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
@outputdir ||= "doc"
|
|
38
|
+
@exceptdirs ||= ["doc", "test"]
|
|
39
|
+
@locale ||= "ja"
|
|
40
|
+
@output_private_keywords = false
|
|
41
|
+
|
|
42
|
+
begin
|
|
43
|
+
opts.parse!(ARGV)
|
|
44
|
+
rescue OptionParser::ParseError => e
|
|
45
|
+
warn e.message
|
|
46
|
+
puts opts
|
|
47
|
+
exit 1
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
basedir = ARGV[0]
|
|
52
|
+
basedir ||= "."
|
|
53
|
+
|
|
54
|
+
Rlzxdoc.execute(basedir, @outputdir, @exceptdirs, @locale, @output_private_keywords)
|
data/config/hoe.rb
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
require 'rlzxdoc/version'
|
|
2
|
+
|
|
3
|
+
AUTHOR = 'togawa manabu'
|
|
4
|
+
EMAIL = "togawamanabu@gmail.com"
|
|
5
|
+
DESCRIPTION = "lzxdoc tool by"
|
|
6
|
+
GEM_NAME = 'rlzxdoc' # what ppl will type to install your gem
|
|
7
|
+
RUBYFORGE_PROJECT = 'rlzxdoc' # The unix name for your project
|
|
8
|
+
HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
|
|
9
|
+
DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
|
|
10
|
+
|
|
11
|
+
@config_file = "~/.rubyforge/user-config.yml"
|
|
12
|
+
@config = nil
|
|
13
|
+
RUBYFORGE_USERNAME = "unknown"
|
|
14
|
+
def rubyforge_username
|
|
15
|
+
unless @config
|
|
16
|
+
begin
|
|
17
|
+
@config = YAML.load(File.read(File.expand_path(@config_file)))
|
|
18
|
+
rescue
|
|
19
|
+
puts <<-EOS
|
|
20
|
+
ERROR: No rubyforge config file found: #{@config_file}
|
|
21
|
+
Run 'rubyforge setup' to prepare your env for access to Rubyforge
|
|
22
|
+
- See http://newgem.rubyforge.org/rubyforge.html for more details
|
|
23
|
+
EOS
|
|
24
|
+
exit
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
RUBYFORGE_USERNAME.replace @config["username"]
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
REV = nil
|
|
32
|
+
# UNCOMMENT IF REQUIRED:
|
|
33
|
+
# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
|
|
34
|
+
VERS = Rlzxdoc::VERSION::STRING + (REV ? ".#{REV}" : "")
|
|
35
|
+
RDOC_OPTS = ['--quiet', '--title', 'rlzxdoc documentation',
|
|
36
|
+
"--opname", "index.html",
|
|
37
|
+
"--line-numbers",
|
|
38
|
+
"--main", "README",
|
|
39
|
+
"--inline-source"]
|
|
40
|
+
|
|
41
|
+
class Hoe
|
|
42
|
+
def extra_deps
|
|
43
|
+
@extra_deps.reject! { |x| Array(x).first == 'hoe' }
|
|
44
|
+
@extra_deps
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# Generate all the Rake tasks
|
|
49
|
+
# Run 'rake -T' to see list of generated tasks (from gem root directory)
|
|
50
|
+
hoe = Hoe.new(GEM_NAME, VERS) do |p|
|
|
51
|
+
p.developer(AUTHOR, EMAIL)
|
|
52
|
+
p.description = DESCRIPTION
|
|
53
|
+
p.summary = DESCRIPTION
|
|
54
|
+
p.url = HOMEPATH
|
|
55
|
+
p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
|
|
56
|
+
p.test_globs = ["test/**/test_*.rb"]
|
|
57
|
+
p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store'] #An array of file patterns to delete on clean.
|
|
58
|
+
|
|
59
|
+
# == Optional
|
|
60
|
+
p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
|
|
61
|
+
#p.extra_deps = [] # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
|
|
62
|
+
|
|
63
|
+
#p.spec_extras = {} # A hash of extra values to set in the gemspec.
|
|
64
|
+
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
|
|
68
|
+
PATH = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
|
|
69
|
+
hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
|
|
70
|
+
hoe.rsync_args = '-av --delete --ignore-errors'
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
require 'fileutils'
|
|
2
|
+
include FileUtils
|
|
3
|
+
|
|
4
|
+
require 'rubygems'
|
|
5
|
+
%w[rake hoe newgem rubigen].each do |req_gem|
|
|
6
|
+
begin
|
|
7
|
+
require req_gem
|
|
8
|
+
rescue LoadError
|
|
9
|
+
puts "This Rakefile requires the '#{req_gem}' RubyGem."
|
|
10
|
+
puts "Installation: gem install #{req_gem} -y"
|
|
11
|
+
exit
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
|
|
16
|
+
|
|
17
|
+
require 'rlzxdoc'
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
#
|
|
2
|
+
# this class is created from a lzx class it includes classname, attributes, methods, events, views, comments, extends, category and is_private
|
|
3
|
+
#
|
|
4
|
+
#--
|
|
5
|
+
# author togawa manabu (togawamanabu@gmail.com)
|
|
6
|
+
module Rlzxdoc
|
|
7
|
+
class LzxClass
|
|
8
|
+
attr_reader :classname, :attribute_list, :method_list, :event_list, :view_list, :classcomment, :extends, :category, :private
|
|
9
|
+
attr_accessor :doc, :hierarchy_depths
|
|
10
|
+
|
|
11
|
+
def initialize(classname, comment, extends)
|
|
12
|
+
@private_keyword = "@keywords private"
|
|
13
|
+
|
|
14
|
+
@attribute_list = Array.new
|
|
15
|
+
@method_list = Array.new
|
|
16
|
+
@event_list = Array.new
|
|
17
|
+
@view_list = Array.new
|
|
18
|
+
@private = false
|
|
19
|
+
@private = comment.include?(@private_keyword) unless comment.nil?
|
|
20
|
+
|
|
21
|
+
@classname = classname
|
|
22
|
+
@classcomment = comment.strip
|
|
23
|
+
@extends = extends
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def private?
|
|
27
|
+
@private
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
def add_method(name, args, comment)
|
|
31
|
+
private = false
|
|
32
|
+
private = comment.include?(@private_keyword) unless comment.nil?
|
|
33
|
+
|
|
34
|
+
if args.nil?
|
|
35
|
+
args = { }
|
|
36
|
+
else
|
|
37
|
+
args = args.split(/\s*,\s*/)
|
|
38
|
+
end
|
|
39
|
+
@method_list << {:name => name, :args => args, :comment => comment.strip, :private => private}
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
def add_attribute(name, type, value, comment, private = false)
|
|
43
|
+
private = comment.include?(@private_keyword) unless comment.nil?
|
|
44
|
+
@attribute_list << {:name => name, :type => type, :value => value, :comment => comment.strip, :private => private}
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
def add_event(name, comment)
|
|
48
|
+
private = false
|
|
49
|
+
private = comment.include?(@private_keyword) unless comment.nil?
|
|
50
|
+
@event_list << {:name => name, :comment => comment.strip, :private => private}
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def add_view(name, comment)
|
|
54
|
+
private = false
|
|
55
|
+
private = comment.include?(@private_keyword) unless comment.nil?
|
|
56
|
+
@view_list << {:name => name, :comment => comment.strip, :private => private}
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
def get_depths_string
|
|
60
|
+
rtn = ""
|
|
61
|
+
(hierarchy_depths - 1).times{rtn += "../"}
|
|
62
|
+
return rtn
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
#
|
|
2
|
+
# this class is created from a lzx file, includes classes.
|
|
3
|
+
#
|
|
4
|
+
#--
|
|
5
|
+
# author togawa manabu (togawamanabu@gmail.com)
|
|
6
|
+
require "rexml/document"
|
|
7
|
+
require "rexml/parsers/pullparser"
|
|
8
|
+
|
|
9
|
+
module Rlzxdoc
|
|
10
|
+
class LzxFile
|
|
11
|
+
include REXML
|
|
12
|
+
|
|
13
|
+
attr_reader :class_list
|
|
14
|
+
@locale
|
|
15
|
+
|
|
16
|
+
def initialize(path, locale, get_private_keywords = true)
|
|
17
|
+
@class_list = Array.new
|
|
18
|
+
@locale = locale
|
|
19
|
+
|
|
20
|
+
createlist(path)
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
def createlist(path)
|
|
24
|
+
source = File.read path
|
|
25
|
+
parser = Parsers::PullParser.new(source)
|
|
26
|
+
|
|
27
|
+
docsource_path = "#{File.dirname(File.expand_path(path))}/doc/lzx/#{@locale}/#{File.basename(path, ".*")}_doc.xml"
|
|
28
|
+
if File.exist?(docsource_path)
|
|
29
|
+
docxml = Document.new(File.new(docsource_path))
|
|
30
|
+
else
|
|
31
|
+
docxml = nil
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
lzxclass = nil
|
|
35
|
+
pre_comment = ""
|
|
36
|
+
|
|
37
|
+
while parser.has_next?
|
|
38
|
+
res = parser.pull
|
|
39
|
+
|
|
40
|
+
case res.event_type
|
|
41
|
+
when :comment
|
|
42
|
+
pre_comment = res[0].strip
|
|
43
|
+
if pre_comment[0, 1] == "-"
|
|
44
|
+
pre_comment = pre_comment[1..-1].strip
|
|
45
|
+
else
|
|
46
|
+
pre_comment = ""
|
|
47
|
+
end
|
|
48
|
+
when :start_element
|
|
49
|
+
tag = res[0]
|
|
50
|
+
name = res[1]["name"]
|
|
51
|
+
|
|
52
|
+
case tag
|
|
53
|
+
when "class"
|
|
54
|
+
@class_list << lzxclass = LzxClass.new(name, pre_comment, res[1]["extends"])
|
|
55
|
+
lzxclass.doc = XPath.first(docxml, "/rlzxdoc/class[@name='#{lzxclass.classname}']/doc") unless docxml.nil?
|
|
56
|
+
when "method"
|
|
57
|
+
lzxclass.add_method(name, res[1]["args"], pre_comment) unless lzxclass.nil?
|
|
58
|
+
#p lzxclass
|
|
59
|
+
when "attribute"
|
|
60
|
+
lzxclass.add_attribute(name, res[1]["type"], res[1]["value"], pre_comment) unless lzxclass.nil?
|
|
61
|
+
when "view"
|
|
62
|
+
lzxclass.add_view(name, pre_comment) unless lzxclass.nil?
|
|
63
|
+
when "event"
|
|
64
|
+
lzxclass.add_event(name, pre_comment) unless lzxclass.nil?
|
|
65
|
+
end
|
|
66
|
+
pre_comment = ""
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
@class_list
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
data/lib/rlzxdoc.rb
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
$:.unshift File.dirname(__FILE__)
|
|
2
|
+
|
|
3
|
+
# == Synopsis
|
|
4
|
+
#
|
|
5
|
+
# Create lzxdoc from lzx files reflexively from basedir.
|
|
6
|
+
#
|
|
7
|
+
# == Usage
|
|
8
|
+
#
|
|
9
|
+
# ruby lzxdoc.rb basedir [ -h | --help] [ -o | -- output-dir doc] [ -e | --except-dirs doc,test] [ -l | --locale ja]
|
|
10
|
+
#
|
|
11
|
+
# == Author
|
|
12
|
+
# Togawa Manabu (togawamanabu@gmail.com)
|
|
13
|
+
#
|
|
14
|
+
# == Copyleft
|
|
15
|
+
# MIT license
|
|
16
|
+
|
|
17
|
+
require "fileutils"
|
|
18
|
+
require "erb"
|
|
19
|
+
require "optparse"
|
|
20
|
+
require "rdoc/usage"
|
|
21
|
+
|
|
22
|
+
require "rlzxdoc/lzxclass"
|
|
23
|
+
require "rlzxdoc/lzxfile"
|
|
24
|
+
|
|
25
|
+
module Rlzxdoc
|
|
26
|
+
# main
|
|
27
|
+
def Rlzxdoc.execute(basedir, outputdir, exceptdirs, locale, output_private_keywords)
|
|
28
|
+
@basedir = basedir
|
|
29
|
+
@outputdir = outputdir
|
|
30
|
+
@exceptdirs = exceptdirs
|
|
31
|
+
@locale = locale
|
|
32
|
+
@output_private_keywords = output_private_keywords
|
|
33
|
+
|
|
34
|
+
@rlzxdoc_root = File.dirname(File.expand_path(__FILE__))
|
|
35
|
+
|
|
36
|
+
@lzx_classes = Array.new
|
|
37
|
+
|
|
38
|
+
expand_outputdir = File.expand_path(@outputdir)
|
|
39
|
+
|
|
40
|
+
#cleanup
|
|
41
|
+
FileUtils.rm_r(expand_outputdir) if File.exist?(expand_outputdir)
|
|
42
|
+
Dir.mkdir(expand_outputdir)
|
|
43
|
+
|
|
44
|
+
FileUtils.cp("#{@rlzxdoc_root}/templates/styles.css", expand_outputdir)
|
|
45
|
+
FileUtils.cp("#{@rlzxdoc_root}/templates/index.html", expand_outputdir)
|
|
46
|
+
|
|
47
|
+
Dir::chdir(@basedir)
|
|
48
|
+
|
|
49
|
+
Dir::glob("*.lzx").each{ |lzxfile| add_class_from_lzx(lzxfile) }
|
|
50
|
+
|
|
51
|
+
Dir::glob("**/").each { |dir|
|
|
52
|
+
unless @exceptdirs.include?(File.dirname(dir).split("/").last)
|
|
53
|
+
Dir::glob("#{dir}*.lzx").each {|lzxfile|
|
|
54
|
+
Rlzxdoc.add_class_from_lzx(lzxfile)
|
|
55
|
+
}
|
|
56
|
+
end
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
@nav = Hash.new
|
|
60
|
+
|
|
61
|
+
class_erb = File.open(@rlzxdoc_root + '/templates/class.rhtml') {|f| ERB.new(f.read)}
|
|
62
|
+
|
|
63
|
+
@lzx_classes.each{ |lzxclass|
|
|
64
|
+
html_output_dir = "#{expand_outputdir}/#{File.dirname(lzxclass[:path])}"
|
|
65
|
+
FileUtils.mkdir_p(html_output_dir) unless File.exist?(html_output_dir)
|
|
66
|
+
|
|
67
|
+
@lzxclass = lzxclass[:class]
|
|
68
|
+
unless @lzxclass.nil?
|
|
69
|
+
unless @lzxclass.private?
|
|
70
|
+
File.open("#{html_output_dir}/#{@lzxclass.classname}.html", "w"){ |file| file.puts class_erb.result(binding) }
|
|
71
|
+
|
|
72
|
+
url = "#{File.dirname(lzxclass[:path])}/#{@lzxclass.classname}.html"
|
|
73
|
+
category = File.dirname(lzxclass[:path])
|
|
74
|
+
@nav.store(category, Array.new) unless @nav.key?(category)
|
|
75
|
+
@nav[category] << {:title => @lzxclass.classname, :url => url}
|
|
76
|
+
puts "create: #{lzxclass[:path]}"
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
#create nav html
|
|
82
|
+
nav_erb = File.open(@rlzxdoc_root + '/templates/nav.rhtml') {|f| ERB.new(f.read)}
|
|
83
|
+
File.open("#{expand_outputdir}/nav.html", "w"){ |file| file.puts nav_erb.result(binding)}
|
|
84
|
+
|
|
85
|
+
#create class list html
|
|
86
|
+
class_list_erb = File.open(@rlzxdoc_root + '/templates/class_list.rhtml') { |f| ERB.new(f.read)}
|
|
87
|
+
File.open("#{expand_outputdir}/classlist.html", "w"){ |file| file.puts class_list_erb.result(binding)}
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
private
|
|
91
|
+
def Rlzxdoc.add_class_from_lzx(lzxfile_path)
|
|
92
|
+
p = LzxFile.new(lzxfile_path, @locale)
|
|
93
|
+
p.class_list.each{ |lzxclass|
|
|
94
|
+
lzxclass.hierarchy_depths = lzxfile_path.split("/").length
|
|
95
|
+
@lzx_classes << { :path => lzxfile_path, :class => lzxclass}
|
|
96
|
+
}
|
|
97
|
+
end
|
|
98
|
+
end
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
<html xmlns:exslt="http://exslt.org/common">
|
|
2
|
+
<head>
|
|
3
|
+
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
4
|
+
<title><%= @lzxclass.classname %></title>
|
|
5
|
+
<link href="<%= @lzxclass.get_depths_string %>styles.css" rel="stylesheet" type="text/css" />
|
|
6
|
+
</head>
|
|
7
|
+
<body>
|
|
8
|
+
<a name="element" shape="rect"></a>
|
|
9
|
+
<div class="head">
|
|
10
|
+
<div class="left">
|
|
11
|
+
<h1><<%= @lzxclass.classname %>></h1>
|
|
12
|
+
<p class="summary"><%= @lzxclass.classcomment %></p>
|
|
13
|
+
<% unless @lzxclass.doc.nil? %>
|
|
14
|
+
<p class="externaldoc"><%= @lzxclass.doc %></p>
|
|
15
|
+
<% end %>
|
|
16
|
+
</div>
|
|
17
|
+
<div class="right">
|
|
18
|
+
<div>
|
|
19
|
+
<% unless @lzxclass.extends.nil? %>
|
|
20
|
+
<i>Extends</i><a href="#"> <%= @lzxclass.extends %></a>
|
|
21
|
+
<% end %>
|
|
22
|
+
</div>
|
|
23
|
+
</div>
|
|
24
|
+
</div>
|
|
25
|
+
<div class="wrapper-description">
|
|
26
|
+
</div>
|
|
27
|
+
<% unless @lzxclass.attribute_list.empty? %>
|
|
28
|
+
<a name="attributes" shape="rect"></a>
|
|
29
|
+
<table summary="" width="100%" border="0" cellspacing="2" cellpadding="2">
|
|
30
|
+
<tr bgcolor="#5B607C">
|
|
31
|
+
<td colspan="6" rowspan="1"><span class="docTableTitle"><a href="info-attributes.html" shape="rect">Attributes</a></span></td>
|
|
32
|
+
</tr>
|
|
33
|
+
<tr bgcolor="#e6e6e6">
|
|
34
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading"><a href="info-attribinfo.html#name" shape="rect">Name</a></span></td>
|
|
35
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading"><a href="info-attribinfo.html#usage" shape="rect">Usage</a></span></td>
|
|
36
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading"><a href="info-attribinfo.html#typetag" shape="rect">Type (Tag)</a></span></td>
|
|
37
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading"><a href="info-attribinfo.html#typejs" shape="rect">Type (JS)</a></span></td>
|
|
38
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading"><a href="info-attribinfo.html#typejs" shape="rect">Default</a></span></td>
|
|
39
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading"><a href="info-attribinfo.html#category" shape="rect">Category</a></span></td>
|
|
40
|
+
</tr>
|
|
41
|
+
<% @lzxclass.attribute_list.each do |atr| %>
|
|
42
|
+
<% unless atr[:private] %>
|
|
43
|
+
<tr>
|
|
44
|
+
<td rowspan="1" colspan="1"><span class="docParam"><a name="attr-name" shape="rect"></a><%= atr[:name] %></span></td>
|
|
45
|
+
<td rowspan="1" colspan="1"><span class="smaller"></span></td>
|
|
46
|
+
<td rowspan="1" colspan="1"><span class="smaller"><%= atr[:type] %></span></td>
|
|
47
|
+
<td rowspan="1" colspan="1"><span class="smaller"></span></td>
|
|
48
|
+
<td rowspan="1" colspan="1"><span class="smaller"></span><%= atr[:value] %></td>
|
|
49
|
+
<td rowspan="1" colspan="1"><span class="smaller"><a href="info-attributes.html#final" shape="rect"></a></span></td>
|
|
50
|
+
</tr>
|
|
51
|
+
<tr>
|
|
52
|
+
<td rowspan="1" colspan="1"> </td>
|
|
53
|
+
<td colspan="5" rowspan="1"><span class="smaller">
|
|
54
|
+
<p><%= atr[:comment] %></p>
|
|
55
|
+
</span></td>
|
|
56
|
+
</tr>
|
|
57
|
+
<tr>
|
|
58
|
+
<td colspan="6" rowspan="1">
|
|
59
|
+
<hr size="1" bgcolor="#e5e5e5">
|
|
60
|
+
</td>
|
|
61
|
+
</tr>
|
|
62
|
+
<% end %>
|
|
63
|
+
<% end %>
|
|
64
|
+
</table>
|
|
65
|
+
<br clear="none">
|
|
66
|
+
<% if(false) %>
|
|
67
|
+
<div class="lfcInherited">
|
|
68
|
+
<div class="title">
|
|
69
|
+
</div>
|
|
70
|
+
<p>
|
|
71
|
+
</p>
|
|
72
|
+
</div>
|
|
73
|
+
<% end %>
|
|
74
|
+
<% end %>
|
|
75
|
+
<% unless @lzxclass.method_list.empty? %>
|
|
76
|
+
<a name="methods" shape="rect"></a>
|
|
77
|
+
<h3>Methods</h3>
|
|
78
|
+
<% @lzxclass.method_list.each do |method| %>
|
|
79
|
+
<a name="<%= method[:name] %>" shape="rect"></a>
|
|
80
|
+
<table summary="" width="100%" border="0" cellspacing="2" cellpadding="2">
|
|
81
|
+
<tr bgcolor="#e5e5e5">
|
|
82
|
+
<td colspan="3" rowspan="1"><span class="docTableTitleGray"><%= method[:name] %></span></td>
|
|
83
|
+
</tr>
|
|
84
|
+
<tr>
|
|
85
|
+
<td colspan="3" rowspan="1">
|
|
86
|
+
<span class="docPrototype"><span class="classname"><%= @lzxclass.classname %></span>.<span class="methodname"><%= method[:name] %></span></span>
|
|
87
|
+
</td>
|
|
88
|
+
</tr>
|
|
89
|
+
<tr>
|
|
90
|
+
<td colspan="3" rowspan="1">
|
|
91
|
+
<p class="smaller"><%= method[:comment] %></p>
|
|
92
|
+
</td>
|
|
93
|
+
</tr>
|
|
94
|
+
<% unless method[:args].empty? %>
|
|
95
|
+
<% unless method[:private] %>
|
|
96
|
+
<tr bgcolor="#e6e6e6">
|
|
97
|
+
<td colspan="3" rowspan="1"><span class="docTableSubTitle">Parameters</span></td>
|
|
98
|
+
</tr>
|
|
99
|
+
<tr bgcolor="#e6e6e6">
|
|
100
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading">Name</span></td>
|
|
101
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading">Type</span></td>
|
|
102
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading">Desc</span></td>
|
|
103
|
+
</tr>
|
|
104
|
+
<% method[:args].each do |param| %>
|
|
105
|
+
<tr>
|
|
106
|
+
<td rowspan="1" colspan="1"><span class="docParam"><%= param %></span></td>
|
|
107
|
+
<td rowspan="1" colspan="1"><span class="smaller"></span></td>
|
|
108
|
+
<td rowspan="1" colspan="1"><span class="smaller"></span></td>
|
|
109
|
+
</tr>
|
|
110
|
+
<% end %>
|
|
111
|
+
<% end %>
|
|
112
|
+
<% end %>
|
|
113
|
+
<tr>
|
|
114
|
+
<td colspan="3" rowspan="1">
|
|
115
|
+
<hr size="1" bgcolor="#e5e5e5">
|
|
116
|
+
</td>
|
|
117
|
+
</tr>
|
|
118
|
+
</table>
|
|
119
|
+
<br clear="none">
|
|
120
|
+
<% if(false) %>
|
|
121
|
+
<div class="lfcInherited">
|
|
122
|
+
<div class="title">
|
|
123
|
+
</div>
|
|
124
|
+
<p>
|
|
125
|
+
</p>
|
|
126
|
+
</div>
|
|
127
|
+
<% end %>
|
|
128
|
+
<% end %>
|
|
129
|
+
<% end %>
|
|
130
|
+
<% unless @lzxclass.event_list.empty? %>
|
|
131
|
+
<a name="events" shape="rect"></a>
|
|
132
|
+
<hr/>
|
|
133
|
+
<table summary="" width="100%" border="0" cellspacing="2" cellpadding="2">
|
|
134
|
+
<tr bgcolor="#5B607C">
|
|
135
|
+
<td colspan="2" rowspan="1"><span class="docTableTitle">Events</span></td>
|
|
136
|
+
</tr>
|
|
137
|
+
<tr bgcolor="#e6e6e6">
|
|
138
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading">Name</span></td>
|
|
139
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading">Description</span></td>
|
|
140
|
+
</tr>
|
|
141
|
+
<% @lzxclass.event_list.each do |event| %>
|
|
142
|
+
<% unless event[:private] %>
|
|
143
|
+
<tr>
|
|
144
|
+
<td rowspan="1" colspan="1"><a name="event-onaddsubresource" shape="rect"></a><span class="docParam"><%= event[:name] %></span></td>
|
|
145
|
+
<td rowspan="1" colspan="1"><span class="smaller"><%= event[:comment] %></span></td>
|
|
146
|
+
</tr>
|
|
147
|
+
<% end %>
|
|
148
|
+
<% end %>
|
|
149
|
+
</table>
|
|
150
|
+
<br clear="none">
|
|
151
|
+
<% if(false) %>
|
|
152
|
+
<div class="lfcInherited">
|
|
153
|
+
<div class="title">
|
|
154
|
+
</div>
|
|
155
|
+
<p>
|
|
156
|
+
</p>
|
|
157
|
+
</div>
|
|
158
|
+
<% end %>
|
|
159
|
+
<br clear="none">
|
|
160
|
+
<% end %>
|
|
161
|
+
<% unless @lzxclass.view_list.empty? %>
|
|
162
|
+
<a name="events" shape="rect"></a>
|
|
163
|
+
<hr/>
|
|
164
|
+
<table summary="" width="100%" border="0" cellspacing="2" cellpadding="2">
|
|
165
|
+
<tr bgcolor="#5B607C">
|
|
166
|
+
<td colspan="2" rowspan="1"><span class="docTableTitle">Events</span></td>
|
|
167
|
+
</tr>
|
|
168
|
+
<tr bgcolor="#e6e6e6">
|
|
169
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading">Name</span></td>
|
|
170
|
+
<td rowspan="1" colspan="1"><span class="docTableColHeading">Description</span></td>
|
|
171
|
+
</tr>
|
|
172
|
+
<% @lzxclass.view_list.each do |view| %>
|
|
173
|
+
<% unless view[:private] %>
|
|
174
|
+
<tr>
|
|
175
|
+
<td rowspan="1" colspan="1"><a name="event-onaddsubresource" shape="rect"></a><span class="docParam"><%= view[:name] %></span></td>
|
|
176
|
+
<td rowspan="1" colspan="1"><span class="smaller"><%= view[:comment] %></span></td>
|
|
177
|
+
</tr>
|
|
178
|
+
<% end %>
|
|
179
|
+
<% end %>
|
|
180
|
+
</table>
|
|
181
|
+
<br clear="none">
|
|
182
|
+
<% if(false) %>
|
|
183
|
+
<div class="lfcInherited">
|
|
184
|
+
<div class="title">
|
|
185
|
+
</div>
|
|
186
|
+
<p>
|
|
187
|
+
</p>
|
|
188
|
+
</div>
|
|
189
|
+
<% end %>
|
|
190
|
+
<br clear="none">
|
|
191
|
+
<% end %>
|
|
192
|
+
<p class="copyright">Copyright ©</p>
|
|
193
|
+
</body>
|
|
194
|
+
</html>
|