yard 0.8.3 → 0.8.4
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/ChangeLog +197 -38
- data/LICENSE +1 -1
- data/README.md +15 -4
- data/docs/GettingStarted.md +6 -6
- data/docs/WhatsNew.md +5 -0
- data/docs/images/code-objects-class-diagram.png +0 -0
- data/docs/images/handlers-class-diagram.png +0 -0
- data/docs/images/overview-class-diagram.png +0 -0
- data/docs/images/parser-class-diagram.png +0 -0
- data/docs/images/tags-class-diagram.png +0 -0
- data/lib/yard/autoload.rb +2 -0
- data/lib/yard/cli/graph.rb +3 -2
- data/lib/yard/cli/server.rb +3 -0
- data/lib/yard/cli/yardoc.rb +1 -0
- data/lib/yard/code_objects/base.rb +60 -30
- data/lib/yard/code_objects/extra_file_object.rb +1 -1
- data/lib/yard/code_objects/proxy.rb +1 -0
- data/lib/yard/docstring.rb +36 -2
- data/lib/yard/docstring_parser.rb +25 -2
- data/lib/yard/handlers/base.rb +18 -2
- data/lib/yard/handlers/c/handler_methods.rb +1 -1
- data/lib/yard/handlers/processor.rb +3 -0
- data/lib/yard/handlers/ruby/class_handler.rb +1 -2
- data/lib/yard/handlers/ruby/dsl_handler_methods.rb +7 -1
- data/lib/yard/handlers/ruby/exception_handler.rb +2 -2
- data/lib/yard/handlers/ruby/legacy/class_handler.rb +4 -3
- data/lib/yard/handlers/ruby/legacy/exception_handler.rb +2 -2
- data/lib/yard/handlers/ruby/legacy/method_handler.rb +4 -4
- data/lib/yard/handlers/ruby/legacy/yield_handler.rb +4 -4
- data/lib/yard/handlers/ruby/method_handler.rb +6 -6
- data/lib/yard/handlers/ruby/struct_handler_methods.rb +4 -4
- data/lib/yard/handlers/ruby/yield_handler.rb +4 -4
- data/lib/yard/i18n/locale.rb +16 -0
- data/lib/yard/parser/ruby/legacy/statement_list.rb +3 -0
- data/lib/yard/parser/ruby/ruby_parser.rb +9 -4
- data/lib/yard/rubygems/doc_manager.rb +16 -7
- data/lib/yard/server/templates/default/fulldoc/html/images/processing.gif +0 -0
- data/lib/yard/tags/directives.rb +3 -2
- data/lib/yard/tags/overload_tag.rb +1 -1
- data/lib/yard/templates/helpers/html_helper.rb +5 -2
- data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +3 -3
- data/lib/yard/version.rb +1 -1
- data/spec/cli/server_spec.rb +18 -0
- data/spec/code_objects/base_spec.rb +32 -1
- data/spec/handlers/base_spec.rb +9 -0
- data/spec/handlers/dsl_handler_spec.rb +12 -1
- data/spec/handlers/examples/dsl_handler_001.rb.txt +16 -1
- data/spec/handlers/examples/visibility_handler_001.rb.txt +5 -0
- data/spec/handlers/method_handler_spec.rb +3 -3
- data/spec/handlers/processor_spec.rb +12 -1
- data/spec/handlers/visibility_handler_spec.rb +5 -0
- data/spec/parser/ruby/ruby_parser_spec.rb +13 -0
- data/spec/parser/source_parser_spec.rb +38 -1
- data/spec/server/doc_server_helper_spec.rb +2 -0
- data/spec/tags/directives_spec.rb +8 -1
- data/spec/tags/overload_tag_spec.rb +1 -1
- data/spec/templates/helpers/html_helper_spec.rb +25 -5
- data/templates/default/class/setup.rb +1 -1
- data/templates/default/module/html/box_info.erb +1 -1
- data/templates/default/tags/html/example.erb +1 -1
- data/templates/default/tags/setup.rb +1 -1
- data/templates/guide/fulldoc/html/css/style.css +12 -5
- data/templates/guide/layout/html/layout.erb +4 -4
- metadata +3 -3
data/ChangeLog
CHANGED
@@ -1,3 +1,162 @@
|
|
1
|
+
2013-02-04 Loren Segal <lsegal@amazon.com>
|
2
|
+
|
3
|
+
* LICENSE, README.md, docs/WhatsNew.md, lib/yard/version.rb: Bump to 0.8.4
|
4
|
+
|
5
|
+
2013-02-01 Loren Segal <lsegal@amazon.com>
|
6
|
+
|
7
|
+
* lib/yard/code_objects/extra_file_object.rb: Make ExtraFileObject type a
|
8
|
+
symbol
|
9
|
+
|
10
|
+
* .travis.yml: Disable ree on Travis CI
|
11
|
+
|
12
|
+
* templates/default/module/html/box_info.erb: Filter out hidden modules from
|
13
|
+
mixin listing References #645
|
14
|
+
|
15
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
16
|
+
spec/server/doc_server_helper_spec.rb,
|
17
|
+
spec/templates/helpers/html_helper_spec.rb: Disable linking objects filtered
|
18
|
+
out by verifier Fixes #645
|
19
|
+
|
20
|
+
* lib/yard/code_objects/base.rb, lib/yard/code_objects/proxy.rb,
|
21
|
+
lib/yard/templates/helpers/html_helper.rb,
|
22
|
+
spec/templates/helpers/html_helper_spec.rb: Add CodeObjects::Base#title and
|
23
|
+
use this for links Resolves #646
|
24
|
+
|
25
|
+
2013-01-28 Loren Segal <lsegal@amazon.com>
|
26
|
+
|
27
|
+
* lib/yard/handlers/ruby/dsl_handler_methods.rb,
|
28
|
+
spec/handlers/dsl_handler_spec.rb,
|
29
|
+
spec/handlers/examples/dsl_handler_001.rb.txt: Expand new attached macro on
|
30
|
+
first DSL method call Fixes #631
|
31
|
+
|
32
|
+
2013-01-27 Loren Segal <lsegal@amazon.com>
|
33
|
+
|
34
|
+
* lib/yard/parser/ruby/ruby_parser.rb,
|
35
|
+
.../helpers/html_syntax_highlight_helper.rb,
|
36
|
+
spec/parser/ruby/ruby_parser_spec.rb, spec/parser/source_parser_spec.rb: Fix
|
37
|
+
line_range for class/module node bodies Node bodies now properly return
|
38
|
+
range to "end" token. Requires change to tokens structure, which now keeps
|
39
|
+
track of line and char position of each token value. Fixes #626
|
40
|
+
|
41
|
+
* lib/yard/handlers/ruby/dsl_handler_methods.rb,
|
42
|
+
spec/handlers/dsl_handler_spec.rb,
|
43
|
+
spec/handlers/examples/dsl_handler_001.rb.txt: Search extended modules for
|
44
|
+
attached DSL macros Fixes #553
|
45
|
+
|
46
|
+
* lib/yard/tags/directives.rb, spec/tags/directives_spec.rb: Allow macro
|
47
|
+
expansion on class methods Fixes #632
|
48
|
+
|
49
|
+
* lib/yard/rubygems/doc_manager.rb: Future proof loading of Gem::DocManager
|
50
|
+
Fixes #627
|
51
|
+
|
52
|
+
2013-01-26 Loren Segal <lsegal@amazon.com>
|
53
|
+
|
54
|
+
* lib/yard/code_objects/base.rb, lib/yard/handlers/ruby/class_handler.rb,
|
55
|
+
lib/yard/handlers/ruby/legacy/class_handler.rb,
|
56
|
+
lib/yard/parser/ruby/legacy/statement_list.rb,
|
57
|
+
spec/parser/source_parser_spec.rb: Fix handling of multiline class/module
|
58
|
+
definitions Fixes #642
|
59
|
+
|
60
|
+
2013-01-20 Loren Segal <lsegal@amazon.com>
|
61
|
+
|
62
|
+
* lib/yard/cli/graph.rb: Grab root object after Registry.load in graph CLI
|
63
|
+
Otherwise the root object will have changed. Fixes #618
|
64
|
+
|
65
|
+
2013-01-06 Loren Segal <lsegal@amazon.com>
|
66
|
+
|
67
|
+
* lib/yard/handlers/base.rb, .../examples/visibility_handler_001.rb.txt,
|
68
|
+
spec/handlers/visibility_handler_spec.rb: Don't #register_visibility on
|
69
|
+
class/modules Closes #636
|
70
|
+
|
71
|
+
* .travis.yml: Disable JRuby testing due to bugs in JRuby
|
72
|
+
|
73
|
+
* spec/templates/helpers/html_helper_spec.rb: Update code block tests
|
74
|
+
|
75
|
+
* templates/guide/layout/html/layout.erb: Update guide template to properly
|
76
|
+
link to prev/index/next
|
77
|
+
|
78
|
+
* templates/guide/fulldoc/html/css/style.css: CSS updates
|
79
|
+
|
80
|
+
* lib/yard/templates/helpers/html_helper.rb: Add lang to code block for
|
81
|
+
syntax highlighting scripts like highlight.js
|
82
|
+
|
83
|
+
2012-12-24 imageoptimiser <skattyadz+imageoptimiser@gmail.com>
|
84
|
+
|
85
|
+
* docs/images/code-objects-class-diagram.png,
|
86
|
+
docs/images/handlers-class-diagram.png,
|
87
|
+
docs/images/overview-class-diagram.png, docs/images/parser-class-diagram.png,
|
88
|
+
docs/images/tags-class-diagram.png,
|
89
|
+
.../default/fulldoc/html/images/processing.gif: Optimised images
|
90
|
+
|
91
|
+
2012-11-25 Loren Segal <lsegal@soen.ca>
|
92
|
+
|
93
|
+
* lib/yard/code_objects/base.rb: Fix typo in documentation
|
94
|
+
|
95
|
+
2012-10-16 Tsyren Ochirov <tsyren@kupibilet.ru>
|
96
|
+
|
97
|
+
* lib/yard/cli/server.rb, spec/cli/server_spec.rb: Add -B/--bind parameter to
|
98
|
+
`yard server` command Closes #608, #615
|
99
|
+
|
100
|
+
2012-11-25 Loren Segal <lsegal@soen.ca>
|
101
|
+
|
102
|
+
* lib/yard/tags/overload_tag.rb, spec/handlers/dsl_handler_spec.rb,
|
103
|
+
spec/handlers/method_handler_spec.rb, spec/tags/directives_spec.rb,
|
104
|
+
spec/tags/overload_tag_spec.rb: OverloadTag#parameters should use String
|
105
|
+
values This is consistent with #parameters set by MethodHandlers Fixes #620
|
106
|
+
|
107
|
+
2012-11-21 Loren Segal <lsegal@amazon.com>
|
108
|
+
|
109
|
+
* lib/yard/autoload.rb, lib/yard/handlers/base.rb,
|
110
|
+
lib/yard/handlers/processor.rb, spec/handlers/base_spec.rb,
|
111
|
+
spec/handlers/processor_spec.rb: Add HandlerAborted exception and
|
112
|
+
Handlers::Base#abort! to silently exit from handler.
|
113
|
+
|
114
|
+
* lib/yard/autoload.rb: Autoload Tags::Directive class
|
115
|
+
|
116
|
+
2012-11-16 Loren Segal <lsegal@amazon.com>
|
117
|
+
|
118
|
+
* templates/default/tags/html/example.erb: Add code block around example tags
|
119
|
+
|
120
|
+
* lib/yard/handlers/ruby/method_handler.rb, templates/default/class/setup.rb,
|
121
|
+
templates/default/tags/setup.rb: Perform proper constructor checks on methods
|
122
|
+
|
123
|
+
2012-11-14 Loren Segal <lsegal@amazon.com>
|
124
|
+
|
125
|
+
* .travis.yml: Disable 1.9.2 on travis... sigh
|
126
|
+
|
127
|
+
* lib/yard/code_objects/base.rb: Don't split CodeObjects::Base#type by NSEP,
|
128
|
+
it should be hardcoded to ::
|
129
|
+
|
130
|
+
2012-11-13 Kostas Karachalios <kostas.karachalios@me.com>
|
131
|
+
|
132
|
+
* docs/GettingStarted.md: Change syntax of @param examples in
|
133
|
+
GettingStarted.md Changed to the syntax referenced in Tags.md
|
134
|
+
|
135
|
+
2012-11-03 Kouhei Sutou <kou@clear-code.com>
|
136
|
+
|
137
|
+
* lib/yard/code_objects/base.rb, lib/yard/handlers/base.rb,
|
138
|
+
lib/yard/handlers/c/handler_methods.rb,
|
139
|
+
lib/yard/handlers/ruby/exception_handler.rb,
|
140
|
+
lib/yard/handlers/ruby/legacy/exception_handler.rb,
|
141
|
+
lib/yard/handlers/ruby/legacy/method_handler.rb,
|
142
|
+
lib/yard/handlers/ruby/legacy/yield_handler.rb,
|
143
|
+
lib/yard/handlers/ruby/method_handler.rb,
|
144
|
+
lib/yard/handlers/ruby/struct_handler_methods.rb,
|
145
|
+
lib/yard/handlers/ruby/yield_handler.rb: Add CodeObject::Base#add_tag and use
|
146
|
+
it in handlers
|
147
|
+
|
148
|
+
* lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Keep
|
149
|
+
localized docstrings in CodeObjects::Base
|
150
|
+
|
151
|
+
* lib/yard/cli/yardoc.rb: --locale set the default locale
|
152
|
+
|
153
|
+
* lib/yard/i18n/locale.rb: Add YARD::I18n::Locale#default and #default= It
|
154
|
+
provides default locale name.
|
155
|
+
|
156
|
+
* lib/yard/code_objects/base.rb, lib/yard/docstring.rb,
|
157
|
+
lib/yard/docstring_parser.rb: Move "(see XXX)" parsing to Docstring from
|
158
|
+
CodeObjects::Base
|
159
|
+
|
1
160
|
2012-10-15 Loren Segal <lsegal@soen.ca>
|
2
161
|
|
3
162
|
* ChangeLog, README.md, docs/WhatsNew.md, lib/yard/version.rb: Bump to
|
@@ -126,7 +285,7 @@
|
|
126
285
|
* lib/yard/logging.rb: Clear progress lines when printing severity messages
|
127
286
|
|
128
287
|
* lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Handle
|
129
|
-
creation of objects with complex object paths when path starts with "::"
|
288
|
+
creation of objects with complex object paths when path starts with "::"
|
130
289
|
Closes #552
|
131
290
|
|
132
291
|
* benchmarks/format_args.rb, benchmarks/pathname_vs_string.rb,
|
@@ -431,7 +590,7 @@
|
|
431
590
|
* Gemfile: Unlock rspec in Gemfile
|
432
591
|
|
433
592
|
* lib/yard/logging.rb, lib/yard/parser/source_parser.rb,
|
434
|
-
spec/logging_spec.rb: Parser backtraces should be logged in warn level
|
593
|
+
spec/logging_spec.rb: Parser backtraces should be logged in warn level
|
435
594
|
Closes #541
|
436
595
|
|
437
596
|
* spec/rubygems/doc_manager_spec.rb: Add specs for yard doc installation
|
@@ -450,7 +609,7 @@
|
|
450
609
|
broken specs, references #535
|
451
610
|
|
452
611
|
* lib/yard/tags/default_factory.rb, spec/tags/default_factory_spec.rb: Fix
|
453
|
-
type parser to properly handle Ruby's operator and special method names
|
612
|
+
type parser to properly handle Ruby's operator and special method names
|
454
613
|
Closes #535
|
455
614
|
|
456
615
|
2012-05-02 Loren Segal <lsegal@soen.ca>
|
@@ -879,7 +1038,7 @@
|
|
879
1038
|
* lib/yard/server/commands/display_object_command.rb,
|
880
1039
|
lib/yard/server/doc_server_helper.rb, lib/yard/server/router.rb,
|
881
1040
|
.../templates/default/layout/html/breadcrumb.erb: Server displays README on
|
882
|
-
index route if available. Renames the index route to /docs/[library/]index.
|
1041
|
+
index route if available. Renames the index route to /docs/[library/]index.
|
883
1042
|
Closes #385
|
884
1043
|
|
885
1044
|
* lib/yard/server/commands/frames_command.rb,
|
@@ -972,7 +1131,7 @@
|
|
972
1131
|
|
973
1132
|
* lib/yard/autoload.rb, lib/yard/parser/source_parser.rb,
|
974
1133
|
lib/yard/tags/directives.rb, lib/yard/tags/library.rb,
|
975
|
-
spec/tags/directives_spec.rb: Add @!parse directive to parse arbitrary code
|
1134
|
+
spec/tags/directives_spec.rb: Add @!parse directive to parse arbitrary code
|
976
1135
|
Blocks are parsed in the context of where they are called, and you can
|
977
1136
|
specify the code language using the type specifier: class A # @!parse # #
|
978
1137
|
A dynamic foo method # def foo; end # @!parse def foo2; end # @!parse [c]
|
@@ -1163,7 +1322,7 @@
|
|
1163
1322
|
Add support for module_function calls in Ruby. Also supports
|
1164
1323
|
rb_define_module_function() in CRuby. Allows instantiation of MethodObjects
|
1165
1324
|
using :module scope. This creates the method object in the class scope but
|
1166
|
-
also creates a blank instance method of the same name and makes it private.
|
1325
|
+
also creates a blank instance method of the same name and makes it private.
|
1167
1326
|
Allows @!scope directive to specify module scope for creation of module
|
1168
1327
|
functions using directive syntax. Some refactoring was done to `register_`
|
1169
1328
|
methods in Handlers::Base to more easily set object visibility. Closes #378
|
@@ -1644,7 +1803,7 @@
|
|
1644
1803
|
now be registered as 'foo.bar' to namespace tags for a 'foo' library or
|
1645
1804
|
plugin. Note that the registered tag methods in the Library will use
|
1646
1805
|
underscores in place of the '.', so calling: Tags::Library.define_tag
|
1647
|
-
'Description', 'foo.bar', :with_types Will register the method:
|
1806
|
+
'Description', 'foo.bar', :with_types Will register the method:
|
1648
1807
|
Tags::Library#foo_bar_tag(text) Closes #452
|
1649
1808
|
|
1650
1809
|
* templates/default/module/html/item_summary.erb: Note titles should be
|
@@ -1652,7 +1811,7 @@
|
|
1652
1811
|
|
1653
1812
|
* spec/templates/examples/module003.html, spec/templates/module_spec.rb,
|
1654
1813
|
.../default/module/html/inherited_attributes.erb,
|
1655
|
-
templates/default/module/setup.rb: Run verifier on inherited attributes list
|
1814
|
+
templates/default/module/setup.rb: Run verifier on inherited attributes list
|
1656
1815
|
Closes #432
|
1657
1816
|
|
1658
1817
|
2012-01-10 Loren Segal <lsegal@soen.ca>
|
@@ -1828,7 +1987,7 @@
|
|
1828
1987
|
2012-01-05 Sergey Avseyev <sergey.avseyev@gmail.com>
|
1829
1988
|
|
1830
1989
|
* lib/yard/templates/helpers/html_helper.rb,
|
1831
|
-
spec/templates/helpers/html_helper_spec.rb: Do not escape snippets twice
|
1990
|
+
spec/templates/helpers/html_helper_spec.rb: Do not escape snippets twice
|
1832
1991
|
Markup helpers aleardy done escaping. This is actually partial revert of
|
1833
1992
|
414e53424c28129625d743e41b15556f150fe083
|
1834
1993
|
|
@@ -1915,7 +2074,7 @@
|
|
1915
2074
|
|
1916
2075
|
* lib/yard/server/commands/search_command.rb: Prune search results according
|
1917
2076
|
to verifiers (no-private, etc.) This should ensure that the server side
|
1918
|
-
search results are in sync with the statically generated class/method lists.
|
2077
|
+
search results are in sync with the statically generated class/method lists.
|
1919
2078
|
Closes #420
|
1920
2079
|
|
1921
2080
|
* lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Add support for
|
@@ -1924,7 +2083,7 @@
|
|
1924
2083
|
* lib/yard/templates/helpers/html_helper.rb,
|
1925
2084
|
lib/yard/templates/helpers/markup_helper.rb,
|
1926
2085
|
spec/templates/helpers/html_helper_spec.rb: Re-organize markup types text,
|
1927
|
-
none, and add type 'pre'. The new behaviour for the types are as follows:
|
2086
|
+
none, and add type 'pre'. The new behaviour for the types are as follows:
|
1928
2087
|
pre: Pre-formatted text, wrapping input inside <pre> tags. text: No
|
1929
2088
|
formatting except for replacing newlines with <br> tags. none: No formatting
|
1930
2089
|
at all. In all cases, HTML is escaped. Note that syntax highlighting does
|
@@ -1958,7 +2117,7 @@
|
|
1958
2117
|
|
1959
2118
|
2011-12-01 Mark Morga <markmorga@gmail.com>
|
1960
2119
|
|
1961
|
-
* lib/yard/rake/yardoc_task.rb: Documentation improvements in YardocTask.
|
2120
|
+
* lib/yard/rake/yardoc_task.rb: Documentation improvements in YardocTask.
|
1962
2121
|
Fixed attr :options to indicate that it should be an Array<String> rather
|
1963
2122
|
than Hash. Added an example for attr :files to show correct use of "-" for
|
1964
2123
|
extra files.
|
@@ -2026,7 +2185,7 @@
|
|
2026
2185
|
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Error early if files have
|
2027
2186
|
markup formats that are not available on the system
|
2028
2187
|
|
2029
|
-
* lib/yard/code_objects/base.rb: Remove unused self.line setting method.
|
2188
|
+
* lib/yard/code_objects/base.rb: Remove unused self.line setting method.
|
2030
2189
|
This method was initiating a dispatch to method_missing, since the method did
|
2031
2190
|
not exist, and was silently setting an attribute on the object that is never
|
2032
2191
|
used.
|
@@ -2080,7 +2239,7 @@
|
|
2080
2239
|
|
2081
2240
|
2011-10-14 Dirkjan Bussink <d.bussink@gmail.com>
|
2082
2241
|
|
2083
|
-
* lib/yard/verifier.rb: Use remove_method instead of undef_method
|
2242
|
+
* lib/yard/verifier.rb: Use remove_method instead of undef_method
|
2084
2243
|
undef_method has very different semantics. It prevents the class from
|
2085
2244
|
responding to the named method. This means that also original methods on
|
2086
2245
|
super classes won't be called. This for example results in weird behavior on
|
@@ -2169,7 +2328,7 @@
|
|
2169
2328
|
2011-08-18 Kouhei Sutou <kou@clear-code.com>
|
2170
2329
|
|
2171
2330
|
* lib/yard/templates/helpers/html_helper.rb: escape HTML meta characters in
|
2172
|
-
text for HTML output. Here is an example text file. hello.txt: Hello >_<!
|
2331
|
+
text for HTML output. Here is an example text file. hello.txt: Hello >_<!
|
2173
2332
|
Here is a command to generate HTML: % yardoc - hello.txt It generates the
|
2174
2333
|
following HTML: ... ...<pre>Hello >_<!</pre>... ... We should escape ">",
|
2175
2334
|
"<" and so on in text to output valid HTML.
|
@@ -2193,7 +2352,7 @@
|
|
2193
2352
|
* .../default/fulldoc/html/full_list_methods.erb: [template][html] add
|
2194
2353
|
missing escape in object link label. This problem can be reproducable by the
|
2195
2354
|
following steps: 1. Create the following script: class Array def &(other)
|
2196
|
-
end end 2. Genreate documents from the above script: % yardoc array-amp.rb
|
2355
|
+
end end 2. Genreate documents from the above script: % yardoc array-amp.rb
|
2197
2356
|
3. Find link markup in method_list.html: % grep '#&' method_list.html <span
|
2198
2357
|
class='object_link'><a href="Array.html#%26-instance_method" title="Array#&
|
2199
2358
|
(method)">#&</a></span> '>#&</a' should be '>#&</a'.
|
@@ -2261,7 +2420,7 @@
|
|
2261
2420
|
|
2262
2421
|
* lib/yard/templates/helpers/html_helper.rb,
|
2263
2422
|
spec/templates/helpers/html_helper_spec.rb: Support YARD style `{http://...
|
2264
|
-
title}` links when using markdown provider that performs URL autolinking.
|
2423
|
+
title}` links when using markdown provider that performs URL autolinking.
|
2265
2424
|
Closes #353
|
2266
2425
|
|
2267
2426
|
2011-06-13 Loren Segal <lsegal@soen.ca>
|
@@ -2380,7 +2539,7 @@
|
|
2380
2539
|
spec/templates/helpers/html_helper_spec.rb: Handles the valid 'utf8' locale
|
2381
2540
|
value as 'utf-8' Supporting #317
|
2382
2541
|
|
2383
|
-
* spec/templates/helpers/html_helper_spec.rb: Stub ENV for charset test
|
2542
|
+
* spec/templates/helpers/html_helper_spec.rb: Stub ENV for charset test
|
2384
2543
|
Closes #317
|
2385
2544
|
|
2386
2545
|
2011-05-21 Loren Segal <lsegal@soen.ca>
|
@@ -2845,7 +3004,7 @@
|
|
2845
3004
|
attaching the command macro to the `command` method call. This can be done by
|
2846
3005
|
adding `[attach]` to the initial @macro definition: # @macro [attach]
|
2847
3006
|
command # ... command :create_file, ... The next use of `command` will
|
2848
|
-
automatically use this macro, even without any explicit docstring or tags:
|
3007
|
+
automatically use this macro, even without any explicit docstring or tags:
|
2849
3008
|
command :foobar, String, "this will be in my docs!" Note that the `command`
|
2850
3009
|
must come from a class that is in the same inheritance tree as the initially
|
2851
3010
|
defined macro. That is, if `command` is used in another class, it will not be
|
@@ -3081,7 +3240,7 @@
|
|
3081
3240
|
templates/default/fulldoc/html/setup.rb,
|
3082
3241
|
templates/default/layout/html/headers.erb,
|
3083
3242
|
templates/default/layout/html/search.erb,
|
3084
|
-
templates/default/layout/html/setup.rb: Customizable JS, CSS, and menus
|
3243
|
+
templates/default/layout/html/setup.rb: Customizable JS, CSS, and menus
|
3085
3244
|
provided methods to override or add to Javascript, CSS, and the search
|
3086
3245
|
fields.
|
3087
3246
|
|
@@ -3143,7 +3302,7 @@
|
|
3143
3302
|
for titles
|
3144
3303
|
|
3145
3304
|
* lib/yard/templates/helpers/base_helper.rb: Add {render:Object} syntax to
|
3146
|
-
templating syntax. Inserts the formatted object in line to the call site.
|
3305
|
+
templating syntax. Inserts the formatted object in line to the call site.
|
3147
3306
|
Closes #277
|
3148
3307
|
|
3149
3308
|
* README.md, docs/GettingStarted.md: Fix formatting in readme / doc files
|
@@ -3253,7 +3412,7 @@
|
|
3253
3412
|
* lib/yard/core_ext/hash.rb: Fix RDoc failure in lib/yard/core_ext/hash.rb at
|
3254
3413
|
or around line 13 column 11 Before reporting this, could you check that the
|
3255
3414
|
file you're documenting compiles cleanly--RDoc is not a full Ruby parser, and
|
3256
|
-
gets confused easily if fed invalid programs. The internal error was:
|
3415
|
+
gets confused easily if fed invalid programs. The internal error was:
|
3257
3416
|
ERROR: While generating documentation for yard-0.6.5 ... MESSAGE: Name or
|
3258
3417
|
symbol expected (got #<RubyToken::TkfLBRACK:0x1025e40e0>) ... RDOC args: --ri
|
3259
3418
|
--op /Users/akzhanabdulin/.rvm/gems/ree-1.8.7-2011.03/doc/yard-0.6.5/ri
|
@@ -3360,7 +3519,7 @@
|
|
3360
3519
|
|
3361
3520
|
2011-02-27 Guten <ywzhaifei@gmail.com>
|
3362
3521
|
|
3363
|
-
* templates/default/fulldoc/html/css/style.css: add css style to list
|
3522
|
+
* templates/default/fulldoc/html/css/style.css: add css style to list
|
3364
3523
|
support <ul> <dl>
|
3365
3524
|
|
3366
3525
|
2011-02-26 Loren Segal <lsegal@soen.ca>
|
@@ -3524,7 +3683,7 @@
|
|
3524
3683
|
lib/yard/parser/ruby/ast_node.rb, lib/yard/parser/ruby/legacy/statement.rb,
|
3525
3684
|
lib/yard/parser/ruby/legacy/statement_list.rb,
|
3526
3685
|
lib/yard/parser/ruby/ruby_parser.rb, spec/parser/source_parser_spec.rb: Add
|
3527
|
-
Docstring#hash_flag to denote when a docstring comment started with '##'
|
3686
|
+
Docstring#hash_flag to denote when a docstring comment started with '##'
|
3528
3687
|
Closes gh-230
|
3529
3688
|
|
3530
3689
|
* lib/yard/tags/default_factory.rb, spec/docstring_spec.rb,
|
@@ -3980,7 +4139,7 @@
|
|
3980
4139
|
* lib/yard/cli/gems.rb: Require 'rubygems' in yard gems command for 1.8.x
|
3981
4140
|
compat
|
3982
4141
|
|
3983
|
-
* lib/yard/cli/gems.rb: Replace #each_slice with 1.8.6 compatible iteration.
|
4142
|
+
* lib/yard/cli/gems.rb: Replace #each_slice with 1.8.6 compatible iteration.
|
3984
4143
|
Closes gh-178
|
3985
4144
|
|
3986
4145
|
2010-09-27 srawlins <sam.rawlins@gmail.com>
|
@@ -4058,7 +4217,7 @@
|
|
4058
4217
|
|
4059
4218
|
* lib/yard/handlers/base.rb, lib/yard/handlers/processor.rb,
|
4060
4219
|
spec/handlers/base_spec.rb: Add Handlers::Base.in_file to declare that a
|
4061
|
-
handler should only process certain files by string/regex match. Example:
|
4220
|
+
handler should only process certain files by string/regex match. Example:
|
4062
4221
|
class MyHandler < Handlers::Ruby::Base handles method_call(:foo) in_file
|
4063
4222
|
%r{/templates/} def process # Only process "foo" calls inside the
|
4064
4223
|
/templates/ directory end end
|
@@ -4275,7 +4434,7 @@
|
|
4275
4434
|
`coding=ENC` encoding comment format (previously only supported `coding:ENC`)
|
4276
4435
|
Closes gh-159
|
4277
4436
|
|
4278
|
-
* templates/default/fulldoc/html/js/full_list.js: Fix inline searching JS
|
4437
|
+
* templates/default/fulldoc/html/js/full_list.js: Fix inline searching JS
|
4279
4438
|
Closes gh-161
|
4280
4439
|
|
4281
4440
|
* templates/default/fulldoc/html/js/jquery.js: Update jQuery to 1.4.2
|
@@ -4286,7 +4445,7 @@
|
|
4286
4445
|
* templates/default/fulldoc/html/css/style.css: Remove webkit gradients on
|
4287
4446
|
search links
|
4288
4447
|
|
4289
|
-
* templates/default/fulldoc/html/js/app.js: Fix undefined links in TOC
|
4448
|
+
* templates/default/fulldoc/html/js/app.js: Fix undefined links in TOC
|
4290
4449
|
Closes gh-160
|
4291
4450
|
|
4292
4451
|
* lib/yard/registry.rb: Fix bug in Registry refactoring that broke .yardoc
|
@@ -4364,7 +4523,7 @@
|
|
4364
4523
|
objects (yri) Closes gh-150
|
4365
4524
|
|
4366
4525
|
* lib/yard/cli/yri.rb, spec/cli/yri_spec.rb: Add `YRI::DEFAULT_SEARCH_PATHS`
|
4367
|
-
to add extra search paths at runtime to be searched before all other paths.
|
4526
|
+
to add extra search paths at runtime to be searched before all other paths.
|
4368
4527
|
Closes gh-151
|
4369
4528
|
|
4370
4529
|
* lib/yard/code_objects/base.rb,
|
@@ -4870,7 +5029,7 @@
|
|
4870
5029
|
problematic when multiple plugins overload the same template (because the
|
4871
5030
|
numeric index is not guaranteed). This change also adds Insertion#before_any
|
4872
5031
|
and Insertion#after_any to insert an object before any section no matter how
|
4873
|
-
deeply nested it is. [1,[2,[3]]].place(4).after_any(3) #=> [1, [2, [3, 4]]]
|
5032
|
+
deeply nested it is. [1,[2,[3]]].place(4).after_any(3) #=> [1, [2, [3, 4]]]
|
4874
5033
|
The above template could be refactored as: def init sections :a, :b, :c,
|
4875
5034
|
[:sub1, :sub2] sections.place(:sub3).after_any(:sub1) end Closes gh-58
|
4876
5035
|
|
@@ -5163,7 +5322,7 @@
|
|
5163
5322
|
templates/default/layout/html/setup.rb: Better support for file shebangs and
|
5164
5323
|
better markup support in general. Adds two new markup types "text" and "html"
|
5165
5324
|
which can be used in shebangs as well as a markup type (-m switch to yardoc).
|
5166
|
-
Can now implement htmlify for custom markup types by implementing
|
5325
|
+
Can now implement htmlify for custom markup types by implementing
|
5167
5326
|
YARD::Templates::Helpers::HtmlHelper#html_markup_MARKUPTYPE Where MARKUPTYPE
|
5168
5327
|
is the markup type name. A provider must also be added to
|
5169
5328
|
MarkupHelper::MARKUP_PROVIDERS, though it can be a blank list of libraries.
|
@@ -5240,7 +5399,7 @@
|
|
5240
5399
|
* README.md: Add special installation instructions for some Ubuntu/Debian
|
5241
5400
|
installations. It is impossible to add rdoc as a dependency, since this will
|
5242
5401
|
force the RDoc gem to be installed rather than the Ruby stdlib package. It is
|
5243
|
-
therefore preferable to install rdoc locally with apt-get on such an OS.
|
5402
|
+
therefore preferable to install rdoc locally with apt-get on such an OS.
|
5244
5403
|
Closes gh-109
|
5245
5404
|
|
5246
5405
|
2010-06-16 Loren Segal <lsegal@soen.ca>
|
@@ -5754,7 +5913,7 @@
|
|
5754
5913
|
* spec/templates/examples/module001.html, spec/templates/module_spec.rb,
|
5755
5914
|
templates/default/fulldoc/html/css/style.css,
|
5756
5915
|
templates/default/module/html/constant_summary.erb,
|
5757
|
-
templates/default/module/setup.rb: Show full docstrings for constants.
|
5916
|
+
templates/default/module/setup.rb: Show full docstrings for constants.
|
5758
5917
|
Closes gh-89 Closes gh-90
|
5759
5918
|
|
5760
5919
|
* lib/yard/docstring.rb, spec/docstring_spec.rb: Finish parsing @tag when
|
@@ -6142,7 +6301,7 @@
|
|
6142
6301
|
|
6143
6302
|
* lib/yard/cli/yri.rb, spec/cli/yri_spec.rb: Allow user to specify
|
6144
6303
|
~/.yard/yri_search_paths file listing extra yardoc dbs to search. File
|
6145
|
-
format should just be newline separated .yardoc files/directories:
|
6304
|
+
format should just be newline separated .yardoc files/directories:
|
6146
6305
|
/path/to/.yardoc /path/to/other.yardoc ...
|
6147
6306
|
|
6148
6307
|
* lib/yard/cli/yardoc.rb: Improve behaviour of re-generating changed objects
|
@@ -8115,7 +8274,7 @@
|
|
8115
8274
|
2009-08-12 Loren Segal <lsegal@soen.ca>
|
8116
8275
|
|
8117
8276
|
* lib/yard/registry.rb, spec/registry_spec.rb: Explicitly define all of
|
8118
|
-
Registry's instance methods as singleton methods delegated to instance.
|
8277
|
+
Registry's instance methods as singleton methods delegated to instance.
|
8119
8278
|
Closes gh-26
|
8120
8279
|
|
8121
8280
|
2009-08-11 Loren Segal <lsegal@soen.ca>
|
@@ -8668,7 +8827,7 @@
|
|
8668
8827
|
* lib/yard/generators/tags_generator.rb,
|
8669
8828
|
templates/default/tags/html/todo.erb: Add @todo to output generation
|
8670
8829
|
|
8671
|
-
* lib/yard/generators/tags_generator.rb: Add @yield to output generation.
|
8830
|
+
* lib/yard/generators/tags_generator.rb: Add @yield to output generation.
|
8672
8831
|
Closes gh-15
|
8673
8832
|
|
8674
8833
|
* lib/yard/generators/class_generator.rb,
|
@@ -9048,7 +9207,7 @@
|
|
9048
9207
|
2009-05-16 Nathan Weizenbaum <nex342@gmail.com>
|
9049
9208
|
|
9050
9209
|
* templates/default/attributes/html/header.erb,
|
9051
|
-
templates/default/fulldoc/html/style.css: Display aliases of attributes.
|
9210
|
+
templates/default/fulldoc/html/style.css: Display aliases of attributes.
|
9052
9211
|
Closes gh-2
|
9053
9212
|
|
9054
9213
|
2009-05-23 Loren Segal <lsegal@soen.ca>
|
@@ -10943,7 +11102,7 @@
|
|
10943
11102
|
aliases for the method object
|
10944
11103
|
|
10945
11104
|
* lib/yard/generators/base.rb: Add extra_opts to initialize so generators can
|
10946
|
-
be initialized without updating the options hash that's passed in:
|
11105
|
+
be initialized without updating the options hash that's passed in:
|
10947
11106
|
MethodGenerator.new(options, :other => :options)
|
10948
11107
|
|
10949
11108
|
* lib/yard/generators/constants_generator.rb: Update documentation
|