yard 0.5.8 → 0.6.0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of yard might be problematic. Click here for more details.
- data/.yardopts +2 -0
- data/ChangeLog +1064 -0
- data/README.md +103 -42
- data/Rakefile +3 -2
- data/benchmarks/parsing.rb +2 -1
- data/bin/yard +4 -0
- data/bin/yard-graph +1 -1
- data/bin/yard-server +4 -0
- data/docs/GettingStarted.md +8 -8
- data/docs/Handlers.md +5 -5
- data/docs/Overview.md +5 -5
- data/docs/Parser.md +1 -1
- data/docs/Tags.md +1 -1
- data/docs/Templates.md +27 -6
- data/docs/WhatsNew.md +222 -2
- data/lib/rubygems_plugin.rb +1 -0
- data/lib/yard.rb +7 -1
- data/lib/yard/autoload.rb +46 -6
- data/lib/yard/cli/{base.rb → command.rb} +20 -6
- data/lib/yard/cli/command_parser.rb +87 -0
- data/lib/yard/cli/diff.rb +176 -0
- data/lib/yard/cli/gems.rb +74 -0
- data/lib/yard/cli/{yard_graph.rb → graph.rb} +9 -8
- data/lib/yard/cli/help.rb +18 -0
- data/lib/yard/cli/server.rb +137 -0
- data/lib/yard/cli/stats.rb +210 -0
- data/lib/yard/cli/yardoc.rb +315 -116
- data/lib/yard/cli/yri.rb +45 -4
- data/lib/yard/code_objects/base.rb +73 -30
- data/lib/yard/code_objects/class_object.rb +9 -1
- data/lib/yard/code_objects/method_object.rb +11 -0
- data/lib/yard/code_objects/namespace_object.rb +8 -2
- data/lib/yard/code_objects/proxy.rb +2 -2
- data/lib/yard/core_ext/array.rb +3 -49
- data/lib/yard/core_ext/file.rb +7 -0
- data/lib/yard/core_ext/insertion.rb +60 -0
- data/lib/yard/docstring.rb +34 -7
- data/lib/yard/globals.rb +2 -2
- data/lib/yard/handlers/base.rb +101 -20
- data/lib/yard/handlers/processor.rb +23 -7
- data/lib/yard/handlers/ruby/alias_handler.rb +1 -0
- data/lib/yard/handlers/ruby/attribute_handler.rb +8 -0
- data/lib/yard/handlers/ruby/base.rb +71 -2
- data/lib/yard/handlers/ruby/class_condition_handler.rb +10 -0
- data/lib/yard/handlers/ruby/class_handler.rb +7 -4
- data/lib/yard/handlers/ruby/class_variable_handler.rb +1 -0
- data/lib/yard/handlers/ruby/constant_handler.rb +1 -0
- data/lib/yard/handlers/ruby/exception_handler.rb +1 -0
- data/lib/yard/handlers/ruby/extend_handler.rb +2 -3
- data/lib/yard/handlers/ruby/legacy/alias_handler.rb +1 -0
- data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +2 -0
- data/lib/yard/handlers/ruby/legacy/base.rb +15 -2
- data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +5 -0
- data/lib/yard/handlers/ruby/legacy/class_handler.rb +7 -4
- data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +1 -0
- data/lib/yard/handlers/ruby/legacy/constant_handler.rb +1 -0
- data/lib/yard/handlers/ruby/legacy/exception_handler.rb +1 -0
- data/lib/yard/handlers/ruby/legacy/extend_handler.rb +1 -3
- data/lib/yard/handlers/ruby/legacy/method_handler.rb +7 -3
- data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +2 -1
- data/lib/yard/handlers/ruby/legacy/module_handler.rb +1 -0
- data/lib/yard/handlers/ruby/legacy/process_handler.rb +1 -0
- data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +1 -0
- data/lib/yard/handlers/ruby/legacy/yield_handler.rb +1 -0
- data/lib/yard/handlers/ruby/method_condition_handler.rb +1 -0
- data/lib/yard/handlers/ruby/method_handler.rb +5 -1
- data/lib/yard/handlers/ruby/mixin_handler.rb +2 -1
- data/lib/yard/handlers/ruby/module_handler.rb +1 -0
- data/lib/yard/handlers/ruby/process_handler.rb +7 -1
- data/lib/yard/handlers/ruby/struct_handler_methods.rb +3 -0
- data/lib/yard/handlers/ruby/visibility_handler.rb +8 -2
- data/lib/yard/handlers/ruby/yield_handler.rb +1 -0
- data/lib/yard/logging.rb +7 -1
- data/lib/yard/parser/base.rb +1 -0
- data/lib/yard/parser/c_parser.rb +2 -0
- data/lib/yard/parser/ruby/ast_node.rb +82 -63
- data/lib/yard/parser/ruby/legacy/ruby_lex.rb +36 -10
- data/lib/yard/parser/ruby/legacy/ruby_parser.rb +1 -0
- data/lib/yard/parser/ruby/legacy/statement.rb +9 -5
- data/lib/yard/parser/ruby/legacy/statement_list.rb +20 -11
- data/lib/yard/parser/ruby/ruby_parser.rb +18 -1
- data/lib/yard/parser/source_parser.rb +6 -1
- data/lib/yard/registry.rb +284 -278
- data/lib/yard/registry_store.rb +4 -2
- data/lib/yard/serializers/base.rb +30 -13
- data/lib/yard/serializers/file_system_serializer.rb +10 -1
- data/lib/yard/server/adapter.rb +51 -0
- data/lib/yard/server/commands/base.rb +98 -0
- data/lib/yard/server/commands/display_file_command.rb +20 -0
- data/lib/yard/server/commands/display_object_command.rb +50 -0
- data/lib/yard/server/commands/frames_command.rb +31 -0
- data/lib/yard/server/commands/library_command.rb +83 -0
- data/lib/yard/server/commands/library_index_command.rb +23 -0
- data/lib/yard/server/commands/list_command.rb +44 -0
- data/lib/yard/server/commands/search_command.rb +67 -0
- data/lib/yard/server/commands/static_file_command.rb +45 -0
- data/lib/yard/server/doc_server_helper.rb +22 -0
- data/lib/yard/server/doc_server_serializer.rb +29 -0
- data/lib/yard/server/library_version.rb +86 -0
- data/lib/yard/server/rack_adapter.rb +38 -0
- data/lib/yard/server/router.rb +110 -0
- data/lib/yard/server/static_caching.rb +16 -0
- data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +78 -0
- data/lib/yard/server/templates/default/fulldoc/html/images/processing.gif +0 -0
- data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +12 -0
- data/lib/yard/server/templates/default/fulldoc/html/js/live.js +32 -0
- data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +46 -0
- data/lib/yard/server/templates/default/layout/html/headers.erb +11 -0
- data/lib/yard/server/templates/doc_server/frames/html/frames.erb +13 -0
- data/lib/yard/server/templates/doc_server/frames/html/setup.rb +3 -0
- data/lib/yard/server/templates/doc_server/full_list/html/full_list.erb +34 -0
- data/lib/yard/server/templates/doc_server/full_list/html/setup.rb +10 -0
- data/lib/yard/server/templates/doc_server/library_list/html/contents.erb +13 -0
- data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +26 -0
- data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +12 -0
- data/lib/yard/server/templates/doc_server/library_list/html/setup.rb +3 -0
- data/lib/yard/server/templates/doc_server/library_list/html/title.erb +2 -0
- data/lib/yard/server/templates/doc_server/processing/html/processing.erb +51 -0
- data/lib/yard/server/templates/doc_server/processing/html/setup.rb +3 -0
- data/lib/yard/server/templates/doc_server/search/html/search.erb +19 -0
- data/lib/yard/server/templates/doc_server/search/html/setup.rb +8 -0
- data/lib/yard/server/webrick_adapter.rb +38 -0
- data/lib/yard/tags/default_factory.rb +0 -5
- data/lib/yard/tags/library.rb +61 -22
- data/lib/yard/tags/tag.rb +26 -4
- data/lib/yard/templates/engine.rb +12 -1
- data/lib/yard/templates/erb_cache.rb +2 -1
- data/lib/yard/templates/helpers/base_helper.rb +96 -3
- data/lib/yard/templates/helpers/filter_helper.rb +5 -0
- data/lib/yard/templates/helpers/html_helper.rb +204 -94
- data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +4 -0
- data/lib/yard/templates/helpers/markup_helper.rb +58 -3
- data/lib/yard/templates/helpers/method_helper.rb +7 -0
- data/lib/yard/templates/helpers/module_helper.rb +5 -0
- data/lib/yard/templates/helpers/text_helper.rb +10 -1
- data/lib/yard/templates/helpers/uml_helper.rb +13 -0
- data/lib/yard/templates/section.rb +106 -0
- data/lib/yard/templates/template.rb +20 -19
- data/lib/yard/verifier.rb +21 -2
- data/spec/cli/command_parser_spec.rb +43 -0
- data/spec/cli/diff_spec.rb +170 -0
- data/spec/cli/help_spec.rb +22 -0
- data/spec/cli/server_spec.rb +140 -0
- data/spec/cli/stats_spec.rb +75 -0
- data/spec/cli/yardoc_spec.rb +438 -182
- data/spec/cli/yri_spec.rb +13 -1
- data/spec/code_objects/base_spec.rb +51 -6
- data/spec/code_objects/class_object_spec.rb +15 -1
- data/spec/code_objects/method_object_spec.rb +29 -0
- data/spec/code_objects/namespace_object_spec.rb +150 -129
- data/spec/core_ext/array_spec.rb +4 -23
- data/spec/core_ext/insertion_spec.rb +37 -0
- data/spec/docstring_spec.rb +63 -0
- data/spec/handlers/attribute_handler_spec.rb +4 -0
- data/spec/handlers/base_spec.rb +98 -26
- data/spec/handlers/class_handler_spec.rb +5 -1
- data/spec/handlers/examples/attribute_handler_001.rb.txt +5 -0
- data/spec/handlers/examples/class_handler_001.rb.txt +4 -0
- data/spec/handlers/examples/module_handler_001.rb.txt +6 -1
- data/spec/handlers/examples/visibility_handler_001.rb.txt +4 -0
- data/spec/handlers/method_handler_spec.rb +5 -0
- data/spec/handlers/module_handler_spec.rb +4 -0
- data/spec/handlers/visibility_handler_spec.rb +6 -0
- data/spec/parser/source_parser_spec.rb +24 -0
- data/spec/registry_spec.rb +44 -8
- data/spec/server/adapter_spec.rb +38 -0
- data/spec/server/commands/base_spec.rb +87 -0
- data/spec/server/commands/static_file_command_spec.rb +67 -0
- data/spec/server/doc_server_serializer_spec.rb +58 -0
- data/spec/server/router_spec.rb +115 -0
- data/spec/server/spec_helper.rb +17 -0
- data/spec/server/static_caching_spec.rb +39 -0
- data/spec/server/webrick_servlet_spec.rb +20 -0
- data/spec/templates/constant_spec.rb +40 -0
- data/spec/templates/engine_spec.rb +9 -5
- data/spec/templates/examples/class002.html +1 -3
- data/spec/templates/examples/constant001.txt +25 -0
- data/spec/templates/examples/constant002.txt +7 -0
- data/spec/templates/examples/constant003.txt +11 -0
- data/spec/templates/examples/module001.txt +1 -1
- data/spec/templates/examples/module002.html +319 -0
- data/spec/templates/helpers/base_helper_spec.rb +2 -2
- data/spec/templates/helpers/html_helper_spec.rb +93 -3
- data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +5 -0
- data/spec/templates/helpers/markup_helper_spec.rb +94 -67
- data/spec/templates/helpers/shared_signature_examples.rb +9 -0
- data/spec/templates/helpers/text_helper_spec.rb +12 -0
- data/spec/templates/module_spec.rb +21 -4
- data/spec/templates/section_spec.rb +146 -0
- data/spec/templates/template_spec.rb +9 -20
- data/templates/default/class/setup.rb +5 -5
- data/templates/default/constant/text/header.erb +11 -0
- data/templates/default/constant/text/setup.rb +3 -0
- data/templates/default/fulldoc/html/css/style.css +29 -3
- data/templates/default/fulldoc/html/js/app.js +67 -1
- data/templates/default/fulldoc/html/js/full_list.js +3 -8
- data/templates/default/fulldoc/html/js/jquery.js +150 -15
- data/templates/default/fulldoc/html/setup.rb +9 -0
- data/templates/default/layout/html/footer.erb +1 -1
- data/templates/default/layout/html/setup.rb +7 -25
- data/templates/default/method_details/html/source.erb +1 -1
- data/templates/default/module/html/attribute_summary.erb +2 -2
- data/templates/default/module/html/method_summary.erb +2 -2
- data/templates/default/module/setup.rb +27 -4
- data/templates/default/onefile/html/files.erb +5 -0
- data/templates/default/onefile/html/layout.erb +22 -0
- data/templates/default/onefile/html/readme.erb +3 -0
- data/templates/default/onefile/html/setup.rb +40 -0
- data/templates/default/root/html/setup.rb +1 -0
- data/templates/default/tags/setup.rb +26 -33
- metadata +80 -10
data/.yardopts
CHANGED
data/ChangeLog
CHANGED
@@ -1,17 +1,1058 @@
|
|
1
|
+
2010-08-29 Loren Segal <lsegal@soen.ca>
|
2
|
+
|
3
|
+
* templates/default/fulldoc/html/css/style.css: Fix positioning for TOC
|
4
|
+
|
5
|
+
* lib/yard/templates/helpers/html_helper.rb: Fix encoding issue where
|
6
|
+
BlueCloth/markup libs might change the encoding if they are not
|
7
|
+
encoding-aware. Force the original encoding.
|
8
|
+
|
9
|
+
* templates/default/fulldoc/html/css/style.css: Show TOC above code examples
|
10
|
+
(TOC should be hidden or code should be manually wrapped in this scenario)
|
11
|
+
|
12
|
+
* docs/Templates.md: Fix reference to YARD::Templates::Section
|
13
|
+
|
14
|
+
2010-08-28 Loren Segal <lsegal@soen.ca>
|
15
|
+
|
16
|
+
* README.md: Fix some typos in readme
|
17
|
+
|
18
|
+
* lib/yard.rb: Update version to 0.6.0
|
19
|
+
|
20
|
+
* README.md: Update README for 0.6.0 release
|
21
|
+
|
22
|
+
* docs/WhatsNew.md: Update WhatsNew.md with new features in 0.6.0
|
23
|
+
|
24
|
+
* docs/Templates.md: Update Templates.md to include documentation about new
|
25
|
+
Section API
|
26
|
+
|
27
|
+
* README.md, docs/GettingStarted.md, docs/Handlers.md, docs/Overview.md,
|
28
|
+
docs/Parser.md, docs/Tags.md, docs/WhatsNew.md: Update file: links to point
|
29
|
+
to docs/ for server compatibility
|
30
|
+
|
31
|
+
* .yardopts, Rakefile, lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Add
|
32
|
+
yardoc --asset to copy over files/directories to output dir after generation
|
33
|
+
|
34
|
+
* lib/yard/cli/stats.rb: Make sure all arguments get recognized.
|
35
|
+
|
36
|
+
* lib/yard/cli/yri.rb: Fix searching for gem paths
|
37
|
+
|
38
|
+
* templates/default/fulldoc/html/css/style.css: Fix notes displaying as
|
39
|
+
blocks (css)
|
40
|
+
|
41
|
+
* templates/default/layout/html/setup.rb: Fix bug in generating index page
|
42
|
+
with --use-cache
|
43
|
+
|
44
|
+
* lib/yard/code_objects/base.rb, lib/yard/code_objects/proxy.rb,
|
45
|
+
lib/yard/globals.rb, lib/yard/registry.rb: Fix broken references to Registry
|
46
|
+
(instance methods are now class methods)
|
47
|
+
|
48
|
+
* lib/yard/cli/yardoc.rb: Deprecate Yardoc#all_objects
|
49
|
+
|
50
|
+
* README.md: Update contributors list
|
51
|
+
|
52
|
+
2010-08-27 Pieter van de Bruggen <pvande@gmail.com>
|
53
|
+
|
54
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
55
|
+
spec/templates/helpers/html_helper_spec.rb,
|
56
|
+
.../helpers/html_syntax_highlight_helper_spec.rb,
|
57
|
+
templates/default/method_details/html/source.erb,
|
58
|
+
templates/default/tags/html/example.erb: Changing #html_syntax_highlight's
|
59
|
+
default type. #html_syntax_highlight should now automatically infer when
|
60
|
+
it's being used in non-Ruby contexts, by inspecting the value of
|
61
|
+
`object.source_type`. This simplifies the syntax highlighting process quite
|
62
|
+
a bit, while still providing the expected default and override mechanisms.
|
63
|
+
|
64
|
+
2010-08-27 Loren Segal <lsegal@soen.ca>
|
65
|
+
|
66
|
+
* templates/default/fulldoc/html/css/style.css: Add margin around TOC
|
67
|
+
|
68
|
+
2010-08-25 Loren Segal <lsegal@soen.ca>
|
69
|
+
|
70
|
+
* lib/yard/handlers/base.rb: Refactor push_state code
|
71
|
+
|
72
|
+
* lib/yard/handlers/base.rb, spec/handlers/base_spec.rb: Fix push_state being
|
73
|
+
unable to push individual state fields and add specs
|
74
|
+
|
75
|
+
* lib/yard/cli/command.rb: Fix -e trying to load a file twice and failing
|
76
|
+
|
77
|
+
* lib/yard/handlers/ruby/base.rb, lib/yard/parser/ruby/ast_node.rb: Update
|
78
|
+
documentation groups
|
79
|
+
|
80
|
+
* lib/yard/server/commands/library_command.rb: Server reloading should use
|
81
|
+
cache
|
82
|
+
|
83
|
+
2010-08-22 Pieter van de Bruggen <pvande@gmail.com>
|
84
|
+
|
85
|
+
* lib/yard/handlers/processor.rb: Providing a hook for registering new
|
86
|
+
handler namespaces. This should make setting up new language handlers more
|
87
|
+
accessible.
|
88
|
+
|
89
|
+
* templates/default/tags/html/example.erb: @example tags should be
|
90
|
+
highlighted in the language of their source object.
|
91
|
+
|
92
|
+
2010-08-22 Loren Segal <lsegal@soen.ca>
|
93
|
+
|
94
|
+
* lib/yard/parser/source_parser.rb, lib/yard/templates/erb_cache.rb: Support
|
95
|
+
`coding=ENC` encoding comment format (previously only supported `coding:ENC`)
|
96
|
+
Closes gh-159
|
97
|
+
|
98
|
+
* templates/default/fulldoc/html/js/full_list.js: Fix inline searching JS
|
99
|
+
Closes gh-161
|
100
|
+
|
101
|
+
* templates/default/fulldoc/html/js/jquery.js: Update jQuery to 1.4.2
|
102
|
+
|
103
|
+
* templates/default/fulldoc/html/js/app.js: Change TOC anchor links to use
|
104
|
+
pretty anchors
|
105
|
+
|
106
|
+
* templates/default/fulldoc/html/css/style.css: Remove webkit gradients on
|
107
|
+
search links
|
108
|
+
|
109
|
+
* templates/default/fulldoc/html/js/app.js: Fix undefined links in TOC
|
110
|
+
Closes gh-160
|
111
|
+
|
112
|
+
* lib/yard/registry.rb: Fix bug in Registry refactoring that broke .yardoc
|
113
|
+
generation
|
114
|
+
|
115
|
+
2010-08-19 Loren Segal <lsegal@soen.ca>
|
116
|
+
|
117
|
+
* spec/registry_spec.rb: Fix spec for 1.8.6
|
118
|
+
|
119
|
+
* lib/yard/registry.rb, spec/cli/yri_spec.rb, spec/registry_spec.rb: Turn
|
120
|
+
Registry into module and remove Singleton class. Instead all methods are
|
121
|
+
defined as singleton methods on the module. This simplifies the Registry
|
122
|
+
interface and removes the distinction between class and instance methods
|
123
|
+
(everything is now a class method). When Registry is refactored to support
|
124
|
+
instances, this will be changed again.
|
125
|
+
|
126
|
+
* lib/yard/registry.rb, spec/registry_spec.rb: Change Registry.load* to
|
127
|
+
return self for chaining
|
128
|
+
|
129
|
+
* lib/yard/handlers/ruby/legacy/base.rb, lib/yard/serializers/base.rb,
|
130
|
+
lib/yard/serializers/file_system_serializer.rb: Fix broken references in
|
131
|
+
documentation
|
132
|
+
|
133
|
+
2010-08-15 Loren Segal <lsegal@soen.ca>
|
134
|
+
|
135
|
+
* lib/yard/cli/diff.rb: Make sure rubygems/package is loaded before running
|
136
|
+
Diff utility
|
137
|
+
|
138
|
+
2010-08-07 Loren Segal <lsegal@soen.ca>
|
139
|
+
|
140
|
+
* spec/templates/helpers/html_helper_spec.rb: Clean up Encoding specs to be
|
141
|
+
dependent on existence of Encoding class, not Ruby 1.9
|
142
|
+
|
143
|
+
* lib/yard/cli/yardoc.rb, lib/yard/templates/helpers/html_helper.rb,
|
144
|
+
spec/templates/helpers/html_helper_spec.rb: Fix specs and Encoding related
|
145
|
+
calls under 1.8.x
|
146
|
+
|
147
|
+
* lib/yard/handlers/ruby/class_handler.rb,
|
148
|
+
lib/yard/handlers/ruby/legacy/class_handler.rb,
|
149
|
+
spec/handlers/class_handler_spec.rb,
|
150
|
+
spec/handlers/examples/class_handler_001.rb.txt: Fix struct handler to allow
|
151
|
+
inheriting of regular Struct (class A < Struct)
|
152
|
+
|
153
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
154
|
+
spec/templates/helpers/html_helper_spec.rb: When parsing `{LINK}` syntax,
|
155
|
+
ignore `{|x| ...}` block syntax.
|
156
|
+
|
157
|
+
2010-08-06 Loren Segal <lsegal@soen.ca>
|
158
|
+
|
159
|
+
* lib/yard/cli/yardoc.rb, lib/yard/templates/helpers/html_helper.rb,
|
160
|
+
spec/templates/helpers/html_helper_spec.rb: Graceful handling of encoding
|
161
|
+
errors in htmlify
|
162
|
+
|
163
|
+
2010-08-05 Loren Segal <lsegal@soen.ca>
|
164
|
+
|
165
|
+
* templates/default/fulldoc/html/js/app.js: Fix bug in TOC generator when
|
166
|
+
nesting headers. Closes gh-154
|
167
|
+
|
168
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
169
|
+
lib/yard/templates/helpers/text_helper.rb,
|
170
|
+
spec/templates/helpers/html_helper_spec.rb,
|
171
|
+
.../templates/helpers/shared_signature_examples.rb: Call #uniq on return
|
172
|
+
types before formatting method signature Closes gh-155
|
173
|
+
|
174
|
+
* lib/yard/cli/diff.rb, lib/yard/cli/server.rb, lib/yard/cli/yri.rb,
|
175
|
+
spec/cli/diff_spec.rb, spec/cli/server_spec.rb, spec/cli/yardoc_spec.rb,
|
176
|
+
spec/templates/examples/class002.html: Fix various specs and make specs pass
|
177
|
+
under 1.8.6/1.9.2
|
178
|
+
|
179
|
+
* spec/templates/constant_spec.rb, spec/templates/examples/constant001.txt,
|
180
|
+
spec/templates/examples/constant002.txt,
|
181
|
+
spec/templates/examples/constant003.txt,
|
182
|
+
templates/default/constant/text/header.erb,
|
183
|
+
templates/default/constant/text/setup.rb: Add text template for constant
|
184
|
+
objects (yri) Closes gh-150
|
185
|
+
|
186
|
+
* lib/yard/cli/yri.rb, spec/cli/yri_spec.rb: Add `YRI::DEFAULT_SEARCH_PATHS`
|
187
|
+
to add extra search paths at runtime to be searched before all other paths.
|
188
|
+
Closes gh-151
|
189
|
+
|
190
|
+
* lib/yard/code_objects/base.rb,
|
191
|
+
lib/yard/handlers/ruby/legacy/method_handler.rb,
|
192
|
+
lib/yard/handlers/ruby/method_handler.rb,
|
193
|
+
spec/handlers/method_handler_spec.rb: Raise undocumentable error for methods
|
194
|
+
defined on object instances (def foo.bar)
|
195
|
+
|
196
|
+
* lib/yard/cli/yardoc.rb: Update docs for Yardoc
|
197
|
+
|
198
|
+
* lib/yard/cli/yardoc.rb: Revert Yardoc caching by default. Yardoc no longer
|
199
|
+
uses the .yardoc cache unless `--cache` is explicitly supplied. `--no-cache`
|
200
|
+
is not removed in this revert.
|
201
|
+
|
202
|
+
2010-07-27 Loren Segal <lsegal@soen.ca>
|
203
|
+
|
204
|
+
* lib/yard/templates/helpers/base_helper.rb,
|
205
|
+
lib/yard/templates/helpers/filter_helper.rb,
|
206
|
+
lib/yard/templates/helpers/html_helper.rb,
|
207
|
+
.../helpers/html_syntax_highlight_helper.rb,
|
208
|
+
lib/yard/templates/helpers/markup_helper.rb,
|
209
|
+
lib/yard/templates/helpers/method_helper.rb,
|
210
|
+
lib/yard/templates/helpers/module_helper.rb,
|
211
|
+
lib/yard/templates/helpers/text_helper.rb: Add documentation for helpers
|
212
|
+
|
213
|
+
* lib/yard/templates/helpers/base_helper.rb,
|
214
|
+
lib/yard/templates/helpers/html_helper.rb: Add documentation for helpers
|
215
|
+
|
216
|
+
2010-07-26 Loren Segal <lsegal@soen.ca>
|
217
|
+
|
218
|
+
* lib/yard/handlers/ruby/base.rb: Update documentation for HandlesExtension
|
219
|
+
|
220
|
+
* lib/yard/handlers/ruby/base.rb: Update documentation for
|
221
|
+
Handlers::Ruby::Base
|
222
|
+
|
223
|
+
* lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Make sure
|
224
|
+
CodeObjects::Base#files returns a unique list of file/line combinations
|
225
|
+
|
226
|
+
2010-07-24 Loren Segal <lsegal@soen.ca>
|
227
|
+
|
228
|
+
* lib/yard/handlers/ruby/visibility_handler.rb,
|
229
|
+
.../examples/visibility_handler_001.rb.txt,
|
230
|
+
spec/handlers/visibility_handler_spec.rb: Ignore expressions in
|
231
|
+
public/private/protected statements Closes gh-153
|
232
|
+
|
233
|
+
2010-07-16 Loren Segal <lsegal@soen.ca>
|
234
|
+
|
235
|
+
* lib/yard/templates/engine.rb: Properly rescue NameError
|
236
|
+
|
237
|
+
* lib/yard/handlers/ruby/process_handler.rb: Add docstring for 'process'
|
238
|
+
methods
|
239
|
+
|
240
|
+
* lib/yard/handlers/base.rb, lib/yard/handlers/ruby/base.rb,
|
241
|
+
lib/yard/handlers/ruby/class_condition_handler.rb,
|
242
|
+
lib/yard/handlers/ruby/class_handler.rb,
|
243
|
+
lib/yard/handlers/ruby/class_variable_handler.rb,
|
244
|
+
lib/yard/handlers/ruby/constant_handler.rb,
|
245
|
+
lib/yard/handlers/ruby/exception_handler.rb,
|
246
|
+
lib/yard/handlers/ruby/extend_handler.rb,
|
247
|
+
lib/yard/handlers/ruby/legacy/alias_handler.rb,
|
248
|
+
lib/yard/handlers/ruby/legacy/attribute_handler.rb,
|
249
|
+
.../ruby/legacy/class_condition_handler.rb,
|
250
|
+
lib/yard/handlers/ruby/legacy/class_handler.rb,
|
251
|
+
.../handlers/ruby/legacy/class_variable_handler.rb,
|
252
|
+
lib/yard/handlers/ruby/legacy/constant_handler.rb,
|
253
|
+
lib/yard/handlers/ruby/legacy/exception_handler.rb,
|
254
|
+
lib/yard/handlers/ruby/legacy/extend_handler.rb,
|
255
|
+
lib/yard/handlers/ruby/legacy/method_handler.rb,
|
256
|
+
lib/yard/handlers/ruby/legacy/mixin_handler.rb,
|
257
|
+
lib/yard/handlers/ruby/legacy/module_handler.rb,
|
258
|
+
lib/yard/handlers/ruby/legacy/process_handler.rb,
|
259
|
+
.../handlers/ruby/legacy/visibility_handler.rb,
|
260
|
+
lib/yard/handlers/ruby/legacy/yield_handler.rb,
|
261
|
+
lib/yard/handlers/ruby/method_condition_handler.rb,
|
262
|
+
lib/yard/handlers/ruby/method_handler.rb,
|
263
|
+
lib/yard/handlers/ruby/mixin_handler.rb,
|
264
|
+
lib/yard/handlers/ruby/module_handler.rb,
|
265
|
+
lib/yard/handlers/ruby/process_handler.rb,
|
266
|
+
lib/yard/handlers/ruby/struct_handler_methods.rb,
|
267
|
+
lib/yard/handlers/ruby/visibility_handler.rb,
|
268
|
+
lib/yard/handlers/ruby/yield_handler.rb,
|
269
|
+
lib/yard/parser/ruby/legacy/ruby_lex.rb, lib/yard/serializers/base.rb,
|
270
|
+
lib/yard/serializers/file_system_serializer.rb, lib/yard/tags/tag.rb,
|
271
|
+
lib/yard/templates/engine.rb, lib/yard/templates/helpers/base_helper.rb,
|
272
|
+
lib/yard/templates/helpers/uml_helper.rb: Update documentation in objects
|
273
|
+
|
274
|
+
* lib/yard/cli/yardoc.rb, lib/yard/serializers/base.rb,
|
275
|
+
lib/yard/serializers/file_system_serializer.rb: Cached generation will check
|
276
|
+
if the file does not exist on the filesystem, in addition to whether or not
|
277
|
+
it was changed. This change also adds Base#exists? that check whether the
|
278
|
+
endpoint exists on the system.
|
279
|
+
|
280
|
+
* lib/yard/templates/helpers/base_helper.rb, lib/yard/verifier.rb,
|
281
|
+
spec/templates/helpers/base_helper_spec.rb: Add Verifier#run to prune a list
|
282
|
+
of objects (similar to BaseHelper#run_verifier)
|
283
|
+
|
284
|
+
* lib/yard/code_objects/base.rb, lib/yard/docstring.rb,
|
285
|
+
spec/code_objects/base_spec.rb, spec/docstring_spec.rb: Add "(see PATH)"
|
286
|
+
syntax for Docstrings. Allows the ability to reference an entire docstrings
|
287
|
+
(including tags) using the following syntax: # (see OtherObject) class
|
288
|
+
Object; end # Real doctring here # @since 0.1 class OtherObject The above
|
289
|
+
example will use the docstring on OtherObject on both objects (including
|
290
|
+
tags). The (see ...) syntax must be at the start of the docstring, though
|
291
|
+
extra tags/info is allowed to be added afterwards. The following is valid: #
|
292
|
+
(see OtherObject) # extra info # @author Name This change also adds
|
293
|
+
Docstring#+ to add two docstrings together and maintain tag information.
|
294
|
+
|
295
|
+
2010-07-15 Loren Segal <lsegal@soen.ca>
|
296
|
+
|
297
|
+
* lib/yard/code_objects/base.rb, lib/yard/handlers/base.rb,
|
298
|
+
lib/yard/handlers/processor.rb, lib/yard/handlers/ruby/attribute_handler.rb,
|
299
|
+
lib/yard/handlers/ruby/base.rb,
|
300
|
+
lib/yard/handlers/ruby/legacy/alias_handler.rb,
|
301
|
+
lib/yard/handlers/ruby/legacy/attribute_handler.rb,
|
302
|
+
lib/yard/handlers/ruby/legacy/base.rb,
|
303
|
+
lib/yard/parser/ruby/legacy/ruby_lex.rb, lib/yard/templates/engine.rb:
|
304
|
+
Add/update documentation for various handler classes, update
|
305
|
+
CodeObjects::Base constants, and document Templates::Engine
|
306
|
+
|
307
|
+
* templates/default/fulldoc/html/css/style.css: Update styling for notes in
|
308
|
+
constants docstrings
|
309
|
+
|
310
|
+
* lib/yard/handlers/ruby/attribute_handler.rb,
|
311
|
+
lib/yard/handlers/ruby/legacy/attribute_handler.rb,
|
312
|
+
spec/handlers/attribute_handler_spec.rb,
|
313
|
+
.../handlers/examples/attribute_handler_001.rb.txt: [bugfix] Maintain
|
314
|
+
visibility in attribute definitions
|
315
|
+
|
316
|
+
2010-07-14 Loren Segal <lsegal@soen.ca>
|
317
|
+
|
318
|
+
* lib/yard/templates/helpers/base_helper.rb,
|
319
|
+
lib/yard/templates/helpers/html_helper.rb,
|
320
|
+
templates/default/fulldoc/html/css/style.css: Add {include:ObjectName} syntax
|
321
|
+
to global YARD markup syntax. This allows the docstring from ObjectName to be
|
322
|
+
inserted in-place into an existing docstring. For instance: #
|
323
|
+
{include:OtherString} class String; end # The docstring is here class
|
324
|
+
OtherString; end The above example prints "The docstring is here" for both
|
325
|
+
classes. Note that this syntax does not copy over tags.
|
326
|
+
|
327
|
+
* lib/yard/handlers/ruby/legacy/mixin_handler.rb,
|
328
|
+
lib/yard/handlers/ruby/mixin_handler.rb: Make sure mixins are only added if
|
329
|
+
they have not been
|
330
|
+
|
331
|
+
* lib/yard/cli/yri.rb, lib/yard/code_objects/class_object.rb,
|
332
|
+
lib/yard/handlers/base.rb, lib/yard/handlers/ruby/alias_handler.rb,
|
333
|
+
lib/yard/handlers/ruby/legacy/alias_handler.rb,
|
334
|
+
lib/yard/templates/helpers/base_helper.rb: Update documentation for various
|
335
|
+
classes/methods
|
336
|
+
|
337
|
+
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Fix visibility verifier
|
338
|
+
specs (--no-public should only apply to methods)
|
339
|
+
|
340
|
+
* lib/yard/cli/yardoc.rb, lib/yard/server/commands/library_command.rb,
|
341
|
+
spec/cli/yardoc_spec.rb: Remove --incremental switch in yardoc. Incremental
|
342
|
+
output generation is now automatic when the cache is used
|
343
|
+
|
344
|
+
* lib/yard/cli/yardoc.rb: Update Yardoc documentation
|
345
|
+
|
346
|
+
* templates/default/fulldoc/html/css/style.css: Improve styling of
|
347
|
+
class/method/file list buttons
|
348
|
+
|
349
|
+
* lib/yard/autoload.rb: Add autoload for WebrickServlet
|
350
|
+
|
351
|
+
* lib/yard.rb, lib/yard/autoload.rb, lib/yard/cli/command_parser.rb,
|
352
|
+
lib/yard/cli/yardoc.rb: Add documentation for various classes
|
353
|
+
|
354
|
+
* lib/yard/cli/yardoc.rb, lib/yard/code_objects/base.rb: Simplify visibility
|
355
|
+
Verifier expression
|
356
|
+
|
357
|
+
* spec/templates/helpers/html_helper_spec.rb: Add spec for relative object
|
358
|
+
link titles
|
359
|
+
|
360
|
+
* spec/server/webrick_servlet_spec.rb: Add specs for WebrickServlet
|
361
|
+
|
362
|
+
2010-07-13 Loren Segal <lsegal@soen.ca>
|
363
|
+
|
364
|
+
* lib/yard/server/webrick_adapter.rb: Remove unnecessary code from
|
365
|
+
WebrickAdapter
|
366
|
+
|
367
|
+
* spec/server/commands/static_file_command_spec.rb: Add specs for
|
368
|
+
StaticFileCommand
|
369
|
+
|
370
|
+
* spec/server/commands/base_spec.rb: Clean up Commands::Base#cache specs
|
371
|
+
|
372
|
+
* templates/default/fulldoc/html/css/style.css,
|
373
|
+
templates/default/fulldoc/html/js/app.js: Add JavaScript generated TOC for
|
374
|
+
file documents
|
375
|
+
|
376
|
+
* lib/yard/server/commands/display_file_command.rb: Remove reference to
|
377
|
+
MIME_TYPES
|
378
|
+
|
379
|
+
* lib/yard/server/commands/static_file_command.rb: Return an empty
|
380
|
+
favicon.ico for browsers that request it (if it does not exist in static
|
381
|
+
paths)
|
382
|
+
|
383
|
+
* lib/yard/server/commands/static_file_command.rb: Add mime type for
|
384
|
+
javascript (WEBrick does not have this defined)
|
385
|
+
|
386
|
+
* templates/default/fulldoc/html/css/style.css: Fix styling for constant
|
387
|
+
docstrings
|
388
|
+
|
389
|
+
* lib/yard/cli/stats.rb: Add documentation for Stats::STATS_ORDER
|
390
|
+
|
391
|
+
* lib/yard/cli/stats.rb: Fix failing stats specs in 1.8
|
392
|
+
|
393
|
+
* lib/yard/autoload.rb, lib/yard/server/commands/base.rb,
|
394
|
+
spec/server/commands/base_spec.rb, spec/server/router_spec.rb,
|
395
|
+
spec/server/spec_helper.rb: Add specs for Commands::Base
|
396
|
+
|
397
|
+
* spec/server/adapter_spec.rb, spec/server/doc_server_serializer_spec.rb,
|
398
|
+
spec/server/router_spec.rb, spec/server/spec_helper.rb,
|
399
|
+
spec/server/static_caching_spec.rb: Add spec_helper.rb file and refactor
|
400
|
+
adapter mocking
|
401
|
+
|
402
|
+
* lib/yard/server/rack_adapter.rb: Unescape PATH_INFO in URLs coming in via
|
403
|
+
Rack adapter
|
404
|
+
|
405
|
+
* lib/yard/server/doc_server_helper.rb,
|
406
|
+
lib/yard/server/doc_server_serializer.rb: Escape URLs in DocServerSerializer
|
407
|
+
|
408
|
+
* lib/yard/server/commands/static_file_command.rb: Refactor static file mime
|
409
|
+
type handling to use WEBrick::HTTPUtils#mime_type
|
410
|
+
|
411
|
+
* lib/yard/server/commands/base.rb,
|
412
|
+
lib/yard/server/commands/display_object_command.rb: Update Commands::Base to
|
413
|
+
take error message in NotFoundError as body
|
414
|
+
|
415
|
+
* lib/yard/server/library_version.rb: Remove debugging message from
|
416
|
+
LibraryVersion
|
417
|
+
|
418
|
+
* spec/server/static_caching_spec.rb: Add specs for StaticCaching
|
419
|
+
|
420
|
+
* lib/yard/server/library_version.rb, spec/server/adapter_spec.rb,
|
421
|
+
spec/server/doc_server_serializer_spec.rb, spec/server/router_spec.rb: Add
|
422
|
+
Router specs and rewrite Adapter specs (routing moved to Router class)
|
423
|
+
|
424
|
+
* lib/yard/server/library_version.rb, spec/cli/server_spec.rb,
|
425
|
+
spec/server/adapter_spec.rb, spec/server/doc_server_serializer_spec.rb: Fix
|
426
|
+
broken specs
|
427
|
+
|
428
|
+
* templates/default/fulldoc/html/js/app.js: Add JS function to comb through
|
429
|
+
markup generated URLs and add target=_parent for those that link outside docs
|
430
|
+
for frames
|
431
|
+
|
432
|
+
* templates/default/layout/html/footer.erb: Add target=_parent for yardoc.org
|
433
|
+
link in footer
|
434
|
+
|
435
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
436
|
+
spec/templates/helpers/html_helper_spec.rb: Add target=_parent for URLs
|
437
|
+
including scheme (http://,...) for frames
|
438
|
+
|
439
|
+
* templates/default/fulldoc/html/js/app.js,
|
440
|
+
templates/default/fulldoc/html/js/full_list.js: Fix javascript to copy title
|
441
|
+
to frame parent in frames mode
|
442
|
+
|
443
|
+
* lib/yard/server/commands/frames_command.rb: Fix titles for File urls in
|
444
|
+
frames
|
445
|
+
|
446
|
+
2010-07-12 Loren Segal <lsegal@soen.ca>
|
447
|
+
|
448
|
+
* .../templates/default/fulldoc/html/css/custom.css,
|
449
|
+
.../default/fulldoc/html/images/loading.gif,
|
450
|
+
.../default/fulldoc/html/images/processing.gif,
|
451
|
+
.../doc_server/processing/html/processing.erb: Much nicer 'processing' page
|
452
|
+
|
453
|
+
2010-07-10 Loren Segal <lsegal@soen.ca>
|
454
|
+
|
455
|
+
* .../templates/default/fulldoc/html/js/live.js: Fix javascript links to list
|
456
|
+
prefix path
|
457
|
+
|
458
|
+
* lib/yard/server/commands/library_command.rb,
|
459
|
+
.../doc_server/processing/html/processing.erb,
|
460
|
+
.../templates/doc_server/processing/html/setup.rb: Add temporary 'processing'
|
461
|
+
page while library .yardoc is being generated
|
462
|
+
|
463
|
+
* lib/yard/server/commands/display_file_command.rb,
|
464
|
+
lib/yard/server/commands/frames_command.rb,
|
465
|
+
lib/yard/server/commands/library_command.rb,
|
466
|
+
lib/yard/server/library_version.rb: Refactor LibraryVersion to support
|
467
|
+
alternate sources; add LibraryVersion#prepare! to load yardoc lazily for a
|
468
|
+
specific source type. Also add #source_path to list the location of the
|
469
|
+
library's sources for the specific source type
|
470
|
+
|
471
|
+
* lib/yard/server/commands/library_index_command.rb,
|
472
|
+
lib/yard/server/commands/search_command.rb,
|
473
|
+
lib/yard/server/doc_server_helper.rb,
|
474
|
+
lib/yard/server/doc_server_serializer.rb, lib/yard/server/router.rb,
|
475
|
+
.../templates/default/layout/html/breadcrumb.erb,
|
476
|
+
.../templates/default/layout/html/headers.erb,
|
477
|
+
.../templates/doc_server/frames/html/frames.erb,
|
478
|
+
.../doc_server/full_list/html/full_list.erb,
|
479
|
+
.../doc_server/library_list/html/contents.erb: Replace command prefix
|
480
|
+
constants with methods that can be overridden, also use prefixes in templates
|
481
|
+
|
482
|
+
* lib/yard/server/commands/base.rb: Only show 404 page if no body contents
|
483
|
+
exist
|
484
|
+
|
485
|
+
* lib/yard/server/adapter.rb: Allow alternate Router class to be specified
|
486
|
+
with Adapter
|
487
|
+
|
488
|
+
* lib/yard/cli/server.rb, spec/cli/server_spec.rb,
|
489
|
+
spec/server/adapter_spec.rb: Change order of LibraryVersion constructor
|
490
|
+
arguments
|
491
|
+
|
492
|
+
2010-07-09 Loren Segal <lsegal@soen.ca>
|
493
|
+
|
494
|
+
* lib/yard/server/commands/frames_command.rb: Update frames command to
|
495
|
+
support /frames/Path/To/Object URL mapping.
|
496
|
+
|
497
|
+
* .../doc_server/library_list/html/contents.erb,
|
498
|
+
.../doc_server/library_list/html/headers.erb,
|
499
|
+
.../doc_server/library_list/html/library_list.erb,
|
500
|
+
.../doc_server/library_list/html/setup.rb,
|
501
|
+
.../doc_server/library_list/html/title.erb: Refactor library_list template
|
502
|
+
into multiple erb files
|
503
|
+
|
504
|
+
* .../templates/default/layout/html/breadcrumb.erb: Link to /docs, not / in
|
505
|
+
breadcrumb
|
506
|
+
|
507
|
+
* lib/yard/server/commands/frames_command.rb: Only list relative path for
|
508
|
+
filename in frames
|
509
|
+
|
510
|
+
* lib/yard/autoload.rb, lib/yard/cli/server.rb, lib/yard/server/adapter.rb,
|
511
|
+
lib/yard/server/commands/base.rb,
|
512
|
+
lib/yard/server/commands/display_object_command.rb,
|
513
|
+
lib/yard/server/commands/library_index_command.rb,
|
514
|
+
lib/yard/server/library_version.rb, lib/yard/server/rack_adapter.rb,
|
515
|
+
lib/yard/server/router.rb, lib/yard/server/static_caching.rb,
|
516
|
+
lib/yard/server/webrick_adapter.rb: Refactor routing from adapter into Router
|
517
|
+
class and adjust some server functionality
|
518
|
+
|
519
|
+
* lib/yard/server/commands/static_file_command.rb: Check document root for
|
520
|
+
StaticFileCommand
|
521
|
+
|
522
|
+
* lib/yard/server/commands/library_command.rb: Reuse yardoc file over
|
523
|
+
multiple requests to same library
|
524
|
+
|
525
|
+
* lib/yard/server/commands/library_command.rb: Support libraries without
|
526
|
+
versions
|
527
|
+
|
528
|
+
* lib/yard/cli/gems.rb: Run yardoc without stats
|
529
|
+
|
530
|
+
2010-07-08 Loren Segal <lsegal@soen.ca>
|
531
|
+
|
532
|
+
* lib/yard/server/adapter.rb, lib/yard/server/commands/base.rb,
|
533
|
+
lib/yard/server/commands/frames_command.rb: Rename base_uri to base_path
|
534
|
+
|
535
|
+
2010-07-07 Loren Segal <lsegal@soen.ca>
|
536
|
+
|
537
|
+
* lib/yard/cli/yard_graph.rb: Fix typo in YardGraph
|
538
|
+
|
539
|
+
2010-07-05 Loren Segal <lsegal@soen.ca>
|
540
|
+
|
541
|
+
* Rakefile: Add YARD_VERSION env to Rakefile. Allows installing as arbitrary
|
542
|
+
gem version with `rake install YARD_VERSION=x.y` Note that this does not
|
543
|
+
change YARD::VERSION in the installed gem itself.
|
544
|
+
|
545
|
+
2010-07-04 Jake Kerr <jkerr@bumptechnologies.com>
|
546
|
+
|
547
|
+
* bin/yard-graph, lib/yard/cli/graph.rb: Fix typos in yard-graph script and
|
548
|
+
graph command The bin/yard-graph script was referring to Yard::CLI::Graph by
|
549
|
+
it's old name YardGraph. There was a comment in the graph command that also
|
550
|
+
that referred to YardGraph
|
551
|
+
|
552
|
+
2010-06-30 Loren Segal <lsegal@soen.ca>
|
553
|
+
|
554
|
+
* spec/cli/diff_spec.rb, spec/cli/stats_spec.rb: Fix spec in 1.8 (block
|
555
|
+
handling)
|
556
|
+
|
557
|
+
* lib/yard/cli/diff.rb, lib/yard/cli/stats.rb, lib/yard/cli/yardoc.rb,
|
558
|
+
spec/cli/yardoc_spec.rb: Add --no-save to yardoc to parse files but without
|
559
|
+
saving registry
|
560
|
+
|
561
|
+
* lib/yard/cli/diff.rb: Documentation for Diff command
|
562
|
+
|
563
|
+
* lib/yard/cli/command_parser.rb, spec/cli/command_parser_spec.rb: Document
|
564
|
+
CommandParser, make CommandParser#commands private
|
565
|
+
|
566
|
+
2010-06-27 Gabriel Horner <gabriel.horner@gmail.com>
|
567
|
+
|
568
|
+
* lib/yard/templates/helpers/text_helper.rb,
|
569
|
+
spec/templates/helpers/text_helper_spec.rb: Truncate text in align_right that
|
570
|
+
is longer than allowed width Closes gh-147
|
571
|
+
|
572
|
+
2010-06-30 Loren Segal <lsegal@soen.ca>
|
573
|
+
|
574
|
+
* lib/yard/cli/yardoc.rb: Only print statistics if not listing objects
|
575
|
+
|
576
|
+
2010-06-27 Loren Segal <lsegal@soen.ca>
|
577
|
+
|
578
|
+
* lib/rubygems_plugin.rb, lib/yard/autoload.rb, lib/yard/cli/command.rb,
|
579
|
+
lib/yard/cli/diff.rb, lib/yard/cli/gems.rb, lib/yard/cli/graph.rb,
|
580
|
+
lib/yard/cli/help.rb, lib/yard/cli/server.rb, lib/yard/cli/stats.rb,
|
581
|
+
lib/yard/cli/yardoc.rb, lib/yard/cli/yri.rb, lib/yard/code_objects/base.rb,
|
582
|
+
lib/yard/code_objects/method_object.rb,
|
583
|
+
lib/yard/code_objects/namespace_object.rb, lib/yard/core_ext/file.rb,
|
584
|
+
lib/yard/core_ext/insertion.rb, lib/yard/handlers/base.rb,
|
585
|
+
.../ruby/legacy/class_condition_handler.rb,
|
586
|
+
lib/yard/handlers/ruby/legacy/process_handler.rb,
|
587
|
+
lib/yard/handlers/ruby/process_handler.rb,
|
588
|
+
lib/yard/handlers/ruby/struct_handler_methods.rb, lib/yard/parser/base.rb,
|
589
|
+
lib/yard/parser/c_parser.rb, lib/yard/parser/ruby/legacy/ruby_parser.rb,
|
590
|
+
lib/yard/parser/ruby/legacy/statement.rb,
|
591
|
+
lib/yard/parser/ruby/ruby_parser.rb, lib/yard/parser/source_parser.rb,
|
592
|
+
lib/yard/registry.rb, lib/yard/registry_store.rb,
|
593
|
+
lib/yard/server/commands/library_command.rb, lib/yard/tags/library.rb,
|
594
|
+
lib/yard/templates/erb_cache.rb, lib/yard/templates/helpers/base_helper.rb,
|
595
|
+
lib/yard/templates/helpers/html_helper.rb,
|
596
|
+
lib/yard/templates/helpers/markup_helper.rb, lib/yard/templates/section.rb,
|
597
|
+
lib/yard/templates/template.rb, lib/yard/verifier.rb: Add @since tags for
|
598
|
+
objects between 0.5.0 and 0.6.0
|
599
|
+
|
600
|
+
* lib/yard/core_ext/file.rb, lib/yard/docstring.rb, lib/yard/globals.rb,
|
601
|
+
lib/yard/logging.rb, lib/yard/registry.rb, lib/yard/serializers/base.rb: Add
|
602
|
+
groups/docs
|
603
|
+
|
604
|
+
* lib/yard/cli/diff.rb: Change debug messages back to info
|
605
|
+
|
606
|
+
2010-06-26 Loren Segal <lsegal@soen.ca>
|
607
|
+
|
608
|
+
* lib/yard/handlers/base.rb: Make sure namespace is not a proxy
|
609
|
+
|
610
|
+
* lib/yard/cli/yardoc.rb, lib/yard/handlers/base.rb,
|
611
|
+
lib/yard/tags/library.rb, spec/cli/yardoc_spec.rb,
|
612
|
+
spec/handlers/base_spec.rb: Add transitive tags (and --transitive-tag).
|
613
|
+
Transitive tags allow a user to declare a tag on a namespace (like a module
|
614
|
+
or class) and have the tag be automatically applied to all methods and
|
615
|
+
objects inside the namespace. Consider declaring "@since" on a new class.
|
616
|
+
Instead of defining @since on every method inside the new class, a user can
|
617
|
+
simply declare it on the class itself and the tag will automatically be
|
618
|
+
applied to the methods inside. For example: # @since 1.1 class Foo def bar;
|
619
|
+
end end The Foo#bar method will have a @since tag defined as well.
|
620
|
+
|
621
|
+
* lib/yard/autoload.rb, lib/yard/cli/command_parser.rb, lib/yard/cli/diff.rb,
|
622
|
+
spec/cli/diff_spec.rb: Add yard diff command to compare two library versions
|
623
|
+
or gems
|
624
|
+
|
625
|
+
* spec/cli/yardoc_spec.rb, spec/templates/examples/module001.txt: Fix broken
|
626
|
+
specs
|
627
|
+
|
628
|
+
* lib/yard/templates/section.rb, spec/templates/section_spec.rb: Add
|
629
|
+
Section#unshift
|
630
|
+
|
631
|
+
2010-06-25 Loren Segal <lsegal@soen.ca>
|
632
|
+
|
633
|
+
* lib/yard/cli/stats.rb: Ignore overridden methods from "undocumented" check,
|
634
|
+
they don't need documentation.
|
635
|
+
|
636
|
+
* lib/yard/code_objects/method_object.rb,
|
637
|
+
spec/code_objects/method_object_spec.rb: Add MethodObject#overridden_method
|
638
|
+
that returns the method the object overrides in a superclass/mixin, if any
|
639
|
+
|
640
|
+
* lib/yard/code_objects/class_object.rb,
|
641
|
+
lib/yard/code_objects/namespace_object.rb,
|
642
|
+
lib/yard/handlers/ruby/legacy/mixin_handler.rb,
|
643
|
+
lib/yard/handlers/ruby/mixin_handler.rb,
|
644
|
+
spec/code_objects/class_object_spec.rb,
|
645
|
+
spec/code_objects/namespace_object_spec.rb,
|
646
|
+
spec/handlers/examples/module_handler_001.rb.txt,
|
647
|
+
spec/handlers/module_handler_spec.rb: Fix mixin/inheritance tree ordering,
|
648
|
+
also add :all key for meths/inherited_meths/included_meths to return all
|
649
|
+
method objects, not just first one
|
650
|
+
|
651
|
+
* lib/yard/verifier.rb: Fix Object#type deprecated warning in 1.8 for
|
652
|
+
Verifier
|
653
|
+
|
654
|
+
* lib/yard/registry.rb: Docs: rename 'reload' argument in Registry.load to
|
655
|
+
'reparse' for clarity
|
656
|
+
|
657
|
+
* lib/yard/docstring.rb, lib/yard/handlers/ruby/legacy/base.rb: Docs: fix
|
658
|
+
name resolution errors
|
659
|
+
|
660
|
+
* lib/yard/autoload.rb, lib/yard/cli/command_parser.rb,
|
661
|
+
lib/yard/cli/stats.rb, lib/yard/cli/yardoc.rb, spec/cli/stats_spec.rb,
|
662
|
+
spec/cli/yardoc_spec.rb: Add 'yard stats' command to list
|
663
|
+
documented/undocumented methods
|
664
|
+
|
665
|
+
* benchmarks/parsing.rb: Fix parsing benchmark require clause
|
666
|
+
|
667
|
+
* lib/yard/cli/yardoc.rb: Refactor Yardoc option parsing methods
|
668
|
+
|
669
|
+
* lib/yard/cli/command.rb, lib/yard/cli/yardoc.rb: Move -e and --legacy to
|
670
|
+
Command class
|
671
|
+
|
672
|
+
* lib/yard/templates/template.rb: Fix bug causing specs to fail in 1.8
|
673
|
+
|
674
|
+
* lib/yard/code_objects/base.rb: Refactor CodeObjects::Base.new to use
|
675
|
+
instance #path method to get key name instead of using Base.key_for hack
|
676
|
+
|
677
|
+
2010-06-24 Loren Segal <lsegal@soen.ca>
|
678
|
+
|
679
|
+
* lib/yard/autoload.rb, lib/yard/core_ext/array.rb,
|
680
|
+
lib/yard/core_ext/insertion.rb, lib/yard/templates/section.rb,
|
681
|
+
lib/yard/templates/template.rb, spec/core_ext/array_spec.rb,
|
682
|
+
spec/core_ext/insertion_spec.rb, spec/templates/section_spec.rb,
|
683
|
+
spec/templates/template_spec.rb, templates/default/tags/setup.rb: Refactor
|
684
|
+
'sections' template command to take Section objects and build tree-like
|
685
|
+
structures instead of plain Arrays. This change replaces all sections with
|
686
|
+
Section objects, allowing subsections to be accessed with Section#[] by name:
|
687
|
+
def init sections :a, :b, :c, [:sub1, :sub2]
|
688
|
+
sections[:c].place(:sub3).after(:sub1) puts "(sections is now [:a, :b, :c,
|
689
|
+
[:sub1, :sub2, :sub3]])" end This removes the need to use indexes, which is
|
690
|
+
problematic when multiple plugins overload the same template (because the
|
691
|
+
numeric index is not guaranteed). This change also adds Insertion#before_any
|
692
|
+
and Insertion#after_any to insert an object before any section no matter how
|
693
|
+
deeply nested it is. [1,[2,[3]]].place(4).after_any(3) #=> [1, [2, [3, 4]]]
|
694
|
+
The above template could be refactored as: def init sections :a, :b, :c,
|
695
|
+
[:sub1, :sub2] sections.place(:sub3).after_any(:sub1) end Closes gh-58
|
696
|
+
|
697
|
+
* lib/yard/parser/ruby/legacy/statement_list.rb,
|
698
|
+
lib/yard/tags/default_factory.rb, lib/yard/tags/library.rb,
|
699
|
+
lib/yard/tags/tag.rb: Docstring formatting: remove '##' pre-docstring lines
|
700
|
+
|
701
|
+
* lib/yard/parser/ruby/ruby_parser.rb: Fix broken spec in 1.9 parser; groups
|
702
|
+
not handling attributes (and other dsl syntaxes)
|
703
|
+
|
704
|
+
* README.md: Fix server reloading docs, note no longer applies
|
705
|
+
|
706
|
+
* lib/yard/code_objects/base.rb, lib/yard/registry_store.rb: Remove
|
707
|
+
disable_identity_map hack to initialize RootObject
|
708
|
+
|
709
|
+
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Make sure --tag is only
|
710
|
+
added once and fix specs
|
711
|
+
|
712
|
+
* lib/yard/code_objects/base.rb, lib/yard/registry.rb,
|
713
|
+
lib/yard/registry_store.rb: Remove Registry.objects cache and rely on
|
714
|
+
RegistryStore as object cache only
|
715
|
+
|
716
|
+
* lib/yard/docstring.rb, spec/docstring_spec.rb: Fix tag parsing of indented
|
717
|
+
lines and allow tag names with numbers in them
|
718
|
+
|
719
|
+
* lib/yard/cli/yardoc.rb, lib/yard/tags/library.rb, spec/cli/yardoc_spec.rb:
|
720
|
+
Add yardoc switches: `--tag`, `--type-tag`, `--type-name-tag`, `--name-tag`,
|
721
|
+
`--title-tag` and `--hide-tag` Allows the creation of custom YARD tags at
|
722
|
+
the command line without requiring a YARD extension. Tags can be defined in
|
723
|
+
the following way: $ yardoc --tag tagname:"Title of Tag" Similarly a
|
724
|
+
"typed", "named" or "titled" tag (or a few combinations) can be added with
|
725
|
+
the respective switches. Note the ':' separating the tag's @tagname from the
|
726
|
+
title used in templates. The quotations is used to escape spaces in the shell
|
727
|
+
(quotations should not be used when done inside Ruby). Titles are optional
|
728
|
+
(omit the ":TITLE" part). Tags added in this way are automatically displayed
|
729
|
+
in templates in the order that they are defined with the title given. If a
|
730
|
+
given tag should not be displayed in the templates, use the `--hide-tag`
|
731
|
+
switch to hide it: $ yardoc --tag tagname --hide-tag tagname This changeset
|
732
|
+
also makes Library.visible_tags into an attribute.
|
733
|
+
|
734
|
+
2010-06-23 Loren Segal <lsegal@soen.ca>
|
735
|
+
|
736
|
+
* templates/default/tags/setup.rb: Remove tag_ prefix from sections
|
737
|
+
(backwards compat.)
|
738
|
+
|
739
|
+
* lib/yard/docstring.rb, lib/yard/tags/library.rb, spec/docstring_spec.rb,
|
740
|
+
templates/default/tags/setup.rb: Rename .show_tags to .visible_tags and make
|
741
|
+
Docstring#blank? only be blank if it has no visible tags (togglable)
|
742
|
+
|
743
|
+
* lib/yard/core_ext/array.rb, spec/core_ext/array_spec.rb,
|
744
|
+
templates/default/class/setup.rb: Fix bug with new Insertion behaviour
|
745
|
+
|
746
|
+
* lib/yard/tags/library.rb, templates/default/tags/setup.rb: Add
|
747
|
+
Tags::Library.show_tags to order tags for templates and redesign tags
|
748
|
+
template to use that method when deciding which tags to show. Also add
|
749
|
+
#factory_method_for to get tag type
|
750
|
+
|
751
|
+
* lib/yard/core_ext/array.rb, spec/core_ext/array_spec.rb: Fix bug in
|
752
|
+
Insertion#before/#after when inserting array objects
|
753
|
+
|
754
|
+
* lib/yard/server/commands/library_command.rb, lib/yard/templates/engine.rb,
|
755
|
+
lib/yard/templates/helpers/base_helper.rb, spec/templates/engine_spec.rb,
|
756
|
+
spec/templates/module_spec.rb, templates/default/class/setup.rb,
|
757
|
+
templates/default/module/setup.rb: Add #globals helper method to keep state
|
758
|
+
for a rendering process (including all templates and sub-templates)
|
759
|
+
|
760
|
+
* lib/yard/server/library_version.rb, spec/cli/server_spec.rb,
|
761
|
+
spec/server/adapter_spec.rb: Fix server specs
|
762
|
+
|
763
|
+
* spec/templates/examples/module002.html: Fix group listing spec
|
764
|
+
|
765
|
+
* lib/yard/server/doc_server_helper.rb: Protect against nil error in
|
766
|
+
DocServerHelper
|
767
|
+
|
768
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
769
|
+
spec/templates/helpers/html_helper_spec.rb: Fix warning for missing reference
|
770
|
+
inside an extra-file. Now properly displays the file name and line number
|
771
|
+
more accurately
|
772
|
+
|
1
773
|
2010-06-22 Loren Segal <lsegal@soen.ca>
|
2
774
|
|
775
|
+
* lib/yard/parser/ruby/legacy/statement.rb: Fix displaying of first line in
|
776
|
+
legacy parser for undocumentable error
|
777
|
+
|
778
|
+
* lib/yard/parser/ruby/legacy/statement.rb: Fix displaying of first line in
|
779
|
+
legacy parser for undocumentable error
|
780
|
+
|
781
|
+
* lib/yard/cli/server.rb: Parse source and create .yardoc if does not exist
|
782
|
+
(with no args passed to server)
|
783
|
+
|
784
|
+
* README.md: Add info on yard server command
|
785
|
+
|
786
|
+
* README.md: Fix yardoc --build gems command
|
787
|
+
|
788
|
+
* README.md: Fix readme for yard graph command
|
789
|
+
|
790
|
+
* yard.gemspec: Add 'yard' binary to gemspec, remove 'yard-graph'
|
791
|
+
|
792
|
+
* spec/cli/yardoc_spec.rb: Add specs for --no-private Closes gh-146
|
793
|
+
|
794
|
+
* ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump to version 0.5.8
|
795
|
+
|
3
796
|
* spec/cli/yardoc_spec.rb: Add specs for --no-private Closes gh-146
|
4
797
|
|
5
798
|
2010-06-19 Loren Segal <lsegal@soen.ca>
|
6
799
|
|
7
800
|
* lib/yard/cli/yardoc.rb: Fix verifier for --no-private
|
8
801
|
|
802
|
+
2010-06-22 Loren Segal <lsegal@soen.ca>
|
803
|
+
|
804
|
+
* templates/default/fulldoc/html/js/app.js: Add localStorage support for
|
805
|
+
remembering collapsed/expanded state of method summary listing.
|
806
|
+
|
9
807
|
2010-06-21 Loren Segal <lsegal@soen.ca>
|
10
808
|
|
11
809
|
* ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump to version 0.5.7
|
12
810
|
|
811
|
+
* lib/yard/server/rack_adapter.rb: Reset command on each request in Rack
|
812
|
+
adapter
|
813
|
+
|
814
|
+
* lib/yard/server/adapter.rb: Fix library loading for single library
|
815
|
+
|
816
|
+
* templates/default/layout/html/setup.rb: Don't print readme filename for
|
817
|
+
--one-file
|
818
|
+
|
819
|
+
* templates/default/layout/html/setup.rb: Ignore private and @private
|
820
|
+
classes/modules from alphabetic index
|
821
|
+
|
822
|
+
* lib/yard/autoload.rb, lib/yard/cli/server.rb, lib/yard/server/adapter.rb,
|
823
|
+
lib/yard/server/commands/base.rb,
|
824
|
+
lib/yard/server/commands/display_object_command.rb,
|
825
|
+
lib/yard/server/commands/library_command.rb, lib/yard/server/rack_adapter.rb,
|
826
|
+
lib/yard/server/static_caching.rb, lib/yard/server/webrick_adapter.rb: Add
|
827
|
+
static caching support to adapters
|
828
|
+
|
829
|
+
* lib/yard/server/doc_server_serializer.rb: Fix serialization for constants
|
830
|
+
|
831
|
+
* lib/yard/server/commands/library_command.rb,
|
832
|
+
.../templates/default/layout/html/breadcrumb.erb: 1.8 compatibility fixes
|
833
|
+
|
834
|
+
* .../templates/default/layout/html/breadcrumb.erb: Smaller autocomplete
|
835
|
+
window on right side
|
836
|
+
|
837
|
+
2010-06-20 Loren Segal <lsegal@soen.ca>
|
838
|
+
|
839
|
+
* lib/yard/server/commands/base.rb,
|
840
|
+
lib/yard/server/commands/search_command.rb, lib/yard/server/rack_adapter.rb,
|
841
|
+
lib/yard/server/webrick_adapter.rb: Move xhr? method into Request objects
|
842
|
+
|
843
|
+
* lib/yard/autoload.rb, lib/yard/cli/gems.rb, lib/yard/cli/server.rb,
|
844
|
+
lib/yard/server/adapter.rb,
|
845
|
+
lib/yard/server/commands/display_object_command.rb,
|
846
|
+
lib/yard/server/commands/frames_command.rb,
|
847
|
+
lib/yard/server/commands/library_command.rb,
|
848
|
+
lib/yard/server/library_version.rb,
|
849
|
+
.../templates/default/layout/html/breadcrumb.erb,
|
850
|
+
.../doc_server/library_list/html/library_list.erb: Add LibraryVersion and
|
851
|
+
list projects by version
|
852
|
+
|
853
|
+
* lib/yard/cli/server.rb, lib/yard/server/commands/library_command.rb: Add
|
854
|
+
all gems by version for yard server command
|
855
|
+
|
856
|
+
* .../doc_server/library_list/html/library_list.erb: Improve library listing
|
857
|
+
page
|
858
|
+
|
859
|
+
* lib/yard/server/commands/library_command.rb: Fix on-demand building of gems
|
860
|
+
|
861
|
+
* lib/yard/server/commands/frames_command.rb: Fix frames command failing if
|
862
|
+
no files are provided
|
863
|
+
|
864
|
+
* lib/yard/autoload.rb, lib/yard/cli/server.rb, lib/yard/server/adapter.rb,
|
865
|
+
lib/yard/server/commands/base.rb,
|
866
|
+
lib/yard/server/commands/display_file_command.rb,
|
867
|
+
lib/yard/server/commands/display_object_command.rb,
|
868
|
+
lib/yard/server/commands/frames_command.rb,
|
869
|
+
lib/yard/server/commands/library_command.rb,
|
870
|
+
lib/yard/server/commands/library_index_command.rb,
|
871
|
+
lib/yard/server/commands/list_command.rb,
|
872
|
+
lib/yard/server/commands/project_command.rb,
|
873
|
+
lib/yard/server/commands/project_index_command.rb,
|
874
|
+
lib/yard/server/commands/search_command.rb,
|
875
|
+
lib/yard/server/doc_server_helper.rb,
|
876
|
+
lib/yard/server/doc_server_serializer.rb, lib/yard/server/rack_adapter.rb,
|
877
|
+
.../templates/default/fulldoc/html/js/live.js,
|
878
|
+
.../templates/default/layout/html/breadcrumb.erb,
|
879
|
+
.../templates/default/layout/html/headers.erb,
|
880
|
+
.../doc_server/library_list/html/library_list.erb,
|
881
|
+
.../doc_server/library_list/html/setup.rb,
|
882
|
+
.../doc_server/project_list/html/project_list.erb,
|
883
|
+
.../doc_server/project_list/html/setup.rb,
|
884
|
+
lib/yard/server/webrick_adapter.rb, spec/cli/server_spec.rb,
|
885
|
+
spec/server/adapter_spec.rb, spec/server/doc_server_serializer_spec.rb:
|
886
|
+
Rename all references from 'projects' to 'libraries' in server
|
887
|
+
|
888
|
+
* lib/yard/cli/server.rb, lib/yard/server/commands/project_command.rb,
|
889
|
+
spec/cli/server_spec.rb: Add yard server --gems to serve gems on demand. If
|
890
|
+
the gem does not have a yardoc file, it will be built on demand (with a small
|
891
|
+
delay on the first load)
|
892
|
+
|
893
|
+
* lib/yard/cli/gems.rb: Add ability to build gem for single gem in command
|
894
|
+
|
895
|
+
* lib/yard/cli/server.rb, spec/cli/server_spec.rb: Add specs for CLI::Server
|
896
|
+
and fix some bugs
|
897
|
+
|
898
|
+
* lib/yard/server/adapter.rb, lib/yard/server/doc_server_serializer.rb,
|
899
|
+
spec/server/adapter_spec.rb, spec/server/doc_server_serializer_spec.rb: Add
|
900
|
+
specs for Server::Adapter, Server::DocServerSerializer
|
901
|
+
|
902
|
+
* spec/templates/examples/module002.html, spec/templates/module_spec.rb: Add
|
903
|
+
specs for @group
|
904
|
+
|
905
|
+
* spec/cli/command_parser_spec.rb, spec/cli/yardoc_spec.rb: Fix broken specs
|
906
|
+
|
907
|
+
2010-06-19 Loren Segal <lsegal@soen.ca>
|
908
|
+
|
909
|
+
* lib/yard/cli/server.rb: Add --adapter to select rack/webrick adapter and
|
910
|
+
-s/--server to select server type (thin,mongrel,cgi,etc.)
|
911
|
+
|
912
|
+
* lib/yard/server/commands/base.rb: Add low-level link to server adapter in
|
913
|
+
command
|
914
|
+
|
915
|
+
* lib/yard/cli/server.rb: Change daemonize option
|
916
|
+
|
917
|
+
* lib/yard/autoload.rb, lib/yard/cli/server.rb, lib/yard/server/adapter.rb,
|
918
|
+
lib/yard/server/rack_adapter.rb, lib/yard/server/webrick_adapter.rb: Refactor
|
919
|
+
Webrick code into Adapter class and add RackAdapter
|
920
|
+
|
921
|
+
* lib/yard/cli/yardoc.rb: Fix verifier for --no-private
|
922
|
+
|
923
|
+
* lib/yard/autoload.rb, lib/yard/server/commands/project_index_command.rb,
|
924
|
+
lib/yard/server/commands/root_command.rb, lib/yard/server/webrick_adapter.rb:
|
925
|
+
Rename RootCommand to ProjectIndexCommand
|
926
|
+
|
927
|
+
* lib/yard/server/webrick_adapter.rb: Mount static paths and root separately
|
928
|
+
|
929
|
+
* .../templates/default/layout/html/breadcrumb.erb: Fix link to project list
|
930
|
+
|
931
|
+
* lib/yard/server/commands/root_command.rb: Fix RootCommand
|
932
|
+
|
933
|
+
* lib/yard/autoload.rb, lib/yard/server/commands/base.rb,
|
934
|
+
lib/yard/server/commands/display_file_command.rb,
|
935
|
+
lib/yard/server/commands/display_object_command.rb,
|
936
|
+
lib/yard/server/commands/list_command.rb,
|
937
|
+
lib/yard/server/commands/project_command.rb,
|
938
|
+
lib/yard/server/commands/root_command.rb,
|
939
|
+
lib/yard/server/commands/search_command.rb,
|
940
|
+
lib/yard/server/webrick_adapter.rb: Refactor project commands into
|
941
|
+
ProjectCommand and root commands as base, change Base initializer to accept
|
942
|
+
hash and set attributes matching hash keys
|
943
|
+
|
944
|
+
* lib/yard/cli/server.rb, lib/yard/cli/yardoc.rb,
|
945
|
+
lib/yard/server/commands/base.rb, lib/yard/server/doc_server.rb,
|
946
|
+
lib/yard/server/webrick_adapter.rb: Various server changes; add command line
|
947
|
+
options and reload parsing
|
948
|
+
|
949
|
+
* lib/yard/autoload.rb, lib/yard/cli/server.rb,
|
950
|
+
lib/yard/server/commands/base.rb,
|
951
|
+
lib/yard/server/commands/display_file_command.rb,
|
952
|
+
lib/yard/server/commands/display_object_command.rb,
|
953
|
+
lib/yard/server/commands/frames_command.rb,
|
954
|
+
lib/yard/server/commands/list_command.rb,
|
955
|
+
lib/yard/server/commands/root_command.rb,
|
956
|
+
lib/yard/server/commands/search_command.rb,
|
957
|
+
lib/yard/server/commands/static_file_command.rb,
|
958
|
+
lib/yard/server/doc_server_helper.rb,
|
959
|
+
lib/yard/server/doc_server_serializer.rb,
|
960
|
+
lib/yard/server/doc_server_url_helper.rb,
|
961
|
+
.../default/fulldoc/html/images/loading.gif,
|
962
|
+
.../templates/default/layout/html/breadcrumb.erb,
|
963
|
+
.../templates/default/layout/html/headers.erb,
|
964
|
+
.../templates/doc_server/frames/html/frames.erb,
|
965
|
+
.../doc_server/full_list/html/full_list.erb,
|
966
|
+
.../doc_server/project_list/html/project_list.erb,
|
967
|
+
lib/yard/server/webrick_adapter.rb: Refactor server into Command pattern for
|
968
|
+
each URL mapping
|
969
|
+
|
970
|
+
* .yardopts: Ignore templates from docs
|
971
|
+
|
972
|
+
* lib/yard/server/doc_server.rb, lib/yard/server/doc_server_serializer.rb,
|
973
|
+
.../default/fulldoc/html/js/autocomplete.js,
|
974
|
+
.../templates/doc_server/search/html/search.erb,
|
975
|
+
.../templates/doc_server/search/html/setup.rb: Add search support to doc
|
976
|
+
server
|
977
|
+
|
13
978
|
2010-06-17 Loren Segal <lsegal@soen.ca>
|
14
979
|
|
980
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
981
|
+
lib/yard/templates/helpers/markup_helper.rb,
|
982
|
+
spec/templates/helpers/markup_helper_spec.rb,
|
983
|
+
templates/default/layout/html/setup.rb: Better support for file shebangs and
|
984
|
+
better markup support in general. Adds two new markup types "text" and "html"
|
985
|
+
which can be used in shebangs as well as a markup type (-m switch to yardoc).
|
986
|
+
Can now implement htmlify for custom markup types by implementing
|
987
|
+
YARD::Templates::Helpers::HtmlHelper#html_markup_MARKUPTYPE Where MARKUPTYPE
|
988
|
+
is the markup type name. A provider must also be added to
|
989
|
+
MarkupHelper::MARKUP_PROVIDERS, though it can be a blank list of libraries.
|
990
|
+
|
991
|
+
* lib/yard/autoload.rb, lib/yard/cli/command_parser.rb, lib/yard/cli/help.rb,
|
992
|
+
spec/cli/help_spec.rb: Add 'yard help' command for help on commands
|
993
|
+
|
994
|
+
* lib/yard/cli/gems.rb, lib/yard/cli/yardoc.rb: Refactor yardoc --build-gems
|
995
|
+
into `yard gems` command
|
996
|
+
|
997
|
+
* lib/yard/autoload.rb, lib/yard/cli/command_parser.rb, lib/yard/cli/gems.rb:
|
998
|
+
Add gems command
|
999
|
+
|
1000
|
+
* lib/yard/cli/command_parser.rb, spec/cli/command_parser_spec.rb: Parse
|
1001
|
+
default command if no command is passed or first argument is option, add
|
1002
|
+
specs
|
1003
|
+
|
1004
|
+
* lib/yard/cli/yardoc.rb: Remove unnecessary code from old merge
|
1005
|
+
|
1006
|
+
* lib/yard/tags/library.rb: Add @group and @endgroup as reserved tags
|
1007
|
+
|
1008
|
+
* lib/yard/cli/yardoc.rb, templates/default/fulldoc/html/setup.rb,
|
1009
|
+
templates/default/layout/html/setup.rb,
|
1010
|
+
templates/default/onefile/html/files.erb,
|
1011
|
+
templates/default/onefile/html/layout.erb,
|
1012
|
+
templates/default/onefile/html/readme.erb,
|
1013
|
+
templates/default/onefile/html/setup.rb,
|
1014
|
+
templates/default/root/html/setup.rb: Add support for --one-file in Yardoc
|
1015
|
+
command
|
1016
|
+
|
1017
|
+
* bin/yard, lib/yard/autoload.rb, lib/yard/cli/base.rb,
|
1018
|
+
lib/yard/cli/command.rb, lib/yard/cli/command_parser.rb,
|
1019
|
+
lib/yard/cli/graph.rb, lib/yard/cli/server.rb, lib/yard/cli/yard_graph.rb,
|
1020
|
+
lib/yard/cli/yardoc.rb, lib/yard/cli/yri.rb: Refactor into new command scheme
|
1021
|
+
Conflicts: lib/yard/autoload.rb lib/yard/cli/command.rb
|
1022
|
+
lib/yard/cli/graph.rb lib/yard/cli/server.rb
|
1023
|
+
|
1024
|
+
2010-06-03 Loren Segal <lsegal@soen.ca>
|
1025
|
+
|
1026
|
+
* lib/yard/cli/yard_graph.rb: Fix typo in yard graph command
|
1027
|
+
|
1028
|
+
2010-06-17 Loren Segal <lsegal@soen.ca>
|
1029
|
+
|
1030
|
+
* lib/yard/code_objects/base.rb, lib/yard/code_objects/namespace_object.rb,
|
1031
|
+
lib/yard/handlers/base.rb, spec/parser/source_parser_spec.rb,
|
1032
|
+
templates/default/module/setup.rb: Remove group as tag and make it standard
|
1033
|
+
object property (so templates don't get confused about tags)
|
1034
|
+
|
1035
|
+
* lib/yard/parser/ruby/legacy/statement_list.rb: Fix @group parsing in 1.8
|
1036
|
+
|
1037
|
+
* templates/default/module/setup.rb: Add groups ordering to class
|
1038
|
+
|
1039
|
+
* lib/yard/handlers/base.rb, spec/parser/source_parser_spec.rb: Add groups
|
1040
|
+
tag to namespace to maintain ordering
|
1041
|
+
|
1042
|
+
* .../default/module/html/attribute_summary.erb,
|
1043
|
+
templates/default/module/html/method_summary.erb,
|
1044
|
+
templates/default/module/setup.rb: Add template support for @groups
|
1045
|
+
|
1046
|
+
* lib/yard/handlers/base.rb, lib/yard/parser/ruby/ast_node.rb,
|
1047
|
+
lib/yard/parser/ruby/legacy/statement.rb,
|
1048
|
+
lib/yard/parser/ruby/legacy/statement_list.rb,
|
1049
|
+
lib/yard/parser/ruby/ruby_parser.rb, spec/parser/source_parser_spec.rb: Add
|
1050
|
+
support for @group and @endgroup Comments must be in the form # @group NAME
|
1051
|
+
To end a group use "# @endgroup". A group does not need to be ended for
|
1052
|
+
another to begin. If you want to start a new group, simply call a new @group.
|
1053
|
+
Note that these tags are not treated as classical "tags" and cannot be
|
1054
|
+
overridden.
|
1055
|
+
|
15
1056
|
* lib/yard/cli/yardoc.rb, lib/yard/serializers/file_system_serializer.rb,
|
16
1057
|
spec/cli/yardoc_spec.rb: Clean up parsing of yardoc options and handle
|
17
1058
|
.document files more effectively
|
@@ -170,6 +1211,29 @@
|
|
170
1211
|
templates/default/layout/html/setup.rb: Various encoding related template
|
171
1212
|
fixes. Closes gh-131
|
172
1213
|
|
1214
|
+
2010-06-04 Loren Segal <lsegal@soen.ca>
|
1215
|
+
|
1216
|
+
* lib/yard/server/doc_server.rb: Add redirect method
|
1217
|
+
|
1218
|
+
* lib/yard/server/doc_server.rb: Only load yardopts once per project change
|
1219
|
+
|
1220
|
+
* lib/yard/server/doc_server.rb: Add search command stub
|
1221
|
+
|
1222
|
+
* lib/yard/server/doc_server.rb,
|
1223
|
+
.../doc_server/project_list/html/project_list.erb,
|
1224
|
+
.../doc_server/project_list/html/setup.rb: Add project listing
|
1225
|
+
|
1226
|
+
* lib/yard/server/doc_server.rb: Add render method, factor out caching
|
1227
|
+
|
1228
|
+
2010-06-02 Loren Segal <lsegal@soen.ca>
|
1229
|
+
|
1230
|
+
* lib/yard/server/doc_server.rb, lib/yard/server/doc_server_url_helper.rb,
|
1231
|
+
.../templates/default/fulldoc/html/css/custom.css,
|
1232
|
+
.../templates/default/fulldoc/html/js/live.js,
|
1233
|
+
.../templates/default/layout/html/breadcrumb.erb,
|
1234
|
+
.../templates/default/layout/html/headers.erb: Add support for modified
|
1235
|
+
templates
|
1236
|
+
|
173
1237
|
2010-05-26 Loren Segal <lsegal@soen.ca>
|
174
1238
|
|
175
1239
|
* lib/yard/cli/yri.rb: Don't use less on Windows (non-cygwin)
|