yard 0.6.8 → 0.7.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.

Files changed (224) hide show
  1. data/.yardopts +1 -0
  2. data/ChangeLog +723 -0
  3. data/README.md +16 -6
  4. data/docs/CodeObjects.md +10 -16
  5. data/docs/GettingStarted.md +232 -32
  6. data/docs/Glossary.md +1 -2
  7. data/docs/Handlers.md +10 -16
  8. data/docs/Overview.md +14 -13
  9. data/docs/Parser.md +13 -22
  10. data/docs/Tags.md +209 -16
  11. data/docs/Templates.md +237 -26
  12. data/docs/WhatsNew.md +178 -2
  13. data/lib/yard.rb +13 -10
  14. data/lib/yard/autoload.rb +22 -18
  15. data/lib/yard/cli/command.rb +13 -12
  16. data/lib/yard/cli/command_parser.rb +20 -19
  17. data/lib/yard/cli/config.rb +19 -19
  18. data/lib/yard/cli/diff.rb +46 -21
  19. data/lib/yard/cli/gems.rb +11 -11
  20. data/lib/yard/cli/graph.rb +13 -13
  21. data/lib/yard/cli/help.rb +1 -1
  22. data/lib/yard/cli/list.rb +22 -0
  23. data/lib/yard/cli/server.rb +17 -17
  24. data/lib/yard/cli/stats.rb +32 -32
  25. data/lib/yard/cli/yardoc.rb +181 -135
  26. data/lib/yard/cli/yri.rb +29 -29
  27. data/lib/yard/code_objects/base.rb +101 -101
  28. data/lib/yard/code_objects/class_object.rb +20 -20
  29. data/lib/yard/code_objects/constant_object.rb +1 -1
  30. data/lib/yard/code_objects/extended_method_object.rb +5 -5
  31. data/lib/yard/code_objects/extra_file_object.rb +89 -0
  32. data/lib/yard/code_objects/macro_object.rb +215 -0
  33. data/lib/yard/code_objects/method_object.rb +30 -30
  34. data/lib/yard/code_objects/module_object.rb +1 -1
  35. data/lib/yard/code_objects/namespace_object.rb +39 -39
  36. data/lib/yard/code_objects/proxy.rb +38 -38
  37. data/lib/yard/code_objects/root_object.rb +1 -1
  38. data/lib/yard/config.rb +40 -40
  39. data/lib/yard/core_ext/array.rb +2 -2
  40. data/lib/yard/core_ext/file.rb +11 -11
  41. data/lib/yard/core_ext/insertion.rb +10 -10
  42. data/lib/yard/core_ext/module.rb +2 -2
  43. data/lib/yard/core_ext/string.rb +2 -2
  44. data/lib/yard/core_ext/symbol_hash.rb +14 -14
  45. data/lib/yard/docstring.rb +122 -54
  46. data/lib/yard/globals.rb +2 -2
  47. data/lib/yard/handlers/base.rb +216 -127
  48. data/lib/yard/handlers/processor.rb +65 -27
  49. data/lib/yard/handlers/ruby/alias_handler.rb +6 -3
  50. data/lib/yard/handlers/ruby/attribute_handler.rb +7 -6
  51. data/lib/yard/handlers/ruby/base.rb +50 -31
  52. data/lib/yard/handlers/ruby/class_condition_handler.rb +11 -11
  53. data/lib/yard/handlers/ruby/class_handler.rb +10 -10
  54. data/lib/yard/handlers/ruby/class_variable_handler.rb +3 -3
  55. data/lib/yard/handlers/ruby/constant_handler.rb +7 -7
  56. data/lib/yard/handlers/ruby/exception_handler.rb +2 -2
  57. data/lib/yard/handlers/ruby/extend_handler.rb +1 -1
  58. data/lib/yard/handlers/ruby/legacy/alias_handler.rb +8 -5
  59. data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +6 -5
  60. data/lib/yard/handlers/ruby/legacy/base.rb +42 -27
  61. data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +9 -9
  62. data/lib/yard/handlers/ruby/legacy/class_handler.rb +13 -12
  63. data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +3 -6
  64. data/lib/yard/handlers/ruby/legacy/constant_handler.rb +5 -8
  65. data/lib/yard/handlers/ruby/legacy/exception_handler.rb +1 -1
  66. data/lib/yard/handlers/ruby/legacy/extend_handler.rb +1 -0
  67. data/lib/yard/handlers/ruby/legacy/macro_handler.rb +40 -0
  68. data/lib/yard/handlers/ruby/legacy/method_handler.rb +10 -10
  69. data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +4 -3
  70. data/lib/yard/handlers/ruby/legacy/module_handler.rb +2 -1
  71. data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +4 -4
  72. data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +2 -1
  73. data/lib/yard/handlers/ruby/legacy/yield_handler.rb +3 -3
  74. data/lib/yard/handlers/ruby/macro_handler.rb +41 -0
  75. data/lib/yard/handlers/ruby/macro_handler_methods.rb +130 -0
  76. data/lib/yard/handlers/ruby/method_condition_handler.rb +1 -1
  77. data/lib/yard/handlers/ruby/method_handler.rb +13 -13
  78. data/lib/yard/handlers/ruby/mixin_handler.rb +4 -4
  79. data/lib/yard/handlers/ruby/module_handler.rb +2 -1
  80. data/lib/yard/handlers/ruby/private_constant_handler.rb +4 -4
  81. data/lib/yard/handlers/ruby/struct_handler_methods.rb +11 -11
  82. data/lib/yard/handlers/ruby/visibility_handler.rb +1 -1
  83. data/lib/yard/handlers/ruby/yield_handler.rb +5 -5
  84. data/lib/yard/logging.rb +11 -11
  85. data/lib/yard/parser/base.rb +8 -8
  86. data/lib/yard/parser/c_parser.rb +42 -33
  87. data/lib/yard/parser/ruby/ast_node.rb +62 -61
  88. data/lib/yard/parser/ruby/legacy/ruby_lex.rb +66 -66
  89. data/lib/yard/parser/ruby/legacy/ruby_parser.rb +4 -4
  90. data/lib/yard/parser/ruby/legacy/statement.rb +11 -11
  91. data/lib/yard/parser/ruby/legacy/statement_list.rb +15 -15
  92. data/lib/yard/parser/ruby/legacy/token_list.rb +9 -9
  93. data/lib/yard/parser/ruby/ruby_parser.rb +51 -37
  94. data/lib/yard/parser/source_parser.rb +271 -46
  95. data/lib/yard/rake/yardoc_task.rb +18 -17
  96. data/lib/yard/registry.rb +64 -64
  97. data/lib/yard/registry_store.rb +34 -34
  98. data/lib/yard/rubygems/backports.rb +8 -0
  99. data/lib/yard/rubygems/backports/LICENSE.txt +57 -0
  100. data/lib/yard/rubygems/backports/MIT.txt +20 -0
  101. data/lib/yard/rubygems/backports/gem.rb +8 -0
  102. data/lib/yard/rubygems/backports/source_index.rb +353 -0
  103. data/lib/yard/rubygems/specification.rb +2 -2
  104. data/lib/yard/serializers/base.rb +20 -20
  105. data/lib/yard/serializers/file_system_serializer.rb +28 -24
  106. data/lib/yard/serializers/process_serializer.rb +3 -3
  107. data/lib/yard/serializers/stdout_serializer.rb +6 -6
  108. data/lib/yard/serializers/yardoc_serializer.rb +17 -17
  109. data/lib/yard/server/adapter.rb +12 -12
  110. data/lib/yard/server/commands/base.rb +26 -26
  111. data/lib/yard/server/commands/display_file_command.rb +3 -2
  112. data/lib/yard/server/commands/display_object_command.rb +5 -5
  113. data/lib/yard/server/commands/frames_command.rb +1 -1
  114. data/lib/yard/server/commands/library_command.rb +7 -7
  115. data/lib/yard/server/commands/library_index_command.rb +2 -2
  116. data/lib/yard/server/commands/list_command.rb +8 -8
  117. data/lib/yard/server/commands/search_command.rb +8 -8
  118. data/lib/yard/server/commands/static_file_command.rb +3 -3
  119. data/lib/yard/server/doc_server_helper.rb +6 -3
  120. data/lib/yard/server/doc_server_serializer.rb +1 -1
  121. data/lib/yard/server/library_version.rb +45 -45
  122. data/lib/yard/server/rack_adapter.rb +10 -10
  123. data/lib/yard/server/router.rb +28 -28
  124. data/lib/yard/server/static_caching.rb +5 -5
  125. data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +3 -3
  126. data/lib/yard/server/templates/default/fulldoc/html/js/live.js +1 -1
  127. data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +2 -2
  128. data/lib/yard/server/templates/default/layout/html/headers.erb +13 -8
  129. data/lib/yard/server/templates/default/layout/html/setup.rb +7 -0
  130. data/lib/yard/server/templates/doc_server/full_list/html/full_list.erb +2 -2
  131. data/lib/yard/server/templates/doc_server/full_list/html/setup.rb +14 -4
  132. data/lib/yard/server/templates/doc_server/library_list/html/contents.erb +2 -2
  133. data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +2 -2
  134. data/lib/yard/server/templates/doc_server/processing/html/processing.erb +1 -1
  135. data/lib/yard/server/templates/doc_server/search/html/search.erb +1 -1
  136. data/lib/yard/server/webrick_adapter.rb +2 -2
  137. data/lib/yard/tags/default_factory.rb +19 -19
  138. data/lib/yard/tags/default_tag.rb +1 -1
  139. data/lib/yard/tags/library.rb +68 -63
  140. data/lib/yard/tags/option_tag.rb +1 -1
  141. data/lib/yard/tags/overload_tag.rb +9 -9
  142. data/lib/yard/tags/ref_tag_list.rb +2 -2
  143. data/lib/yard/tags/tag.rb +7 -7
  144. data/lib/yard/templates/engine.rb +31 -31
  145. data/lib/yard/templates/erb_cache.rb +1 -1
  146. data/lib/yard/templates/helpers/base_helper.rb +46 -32
  147. data/lib/yard/templates/helpers/filter_helper.rb +2 -2
  148. data/lib/yard/templates/helpers/html_helper.rb +120 -81
  149. data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +4 -4
  150. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +9 -9
  151. data/lib/yard/templates/helpers/markup_helper.rb +37 -30
  152. data/lib/yard/templates/helpers/method_helper.rb +7 -7
  153. data/lib/yard/templates/helpers/text_helper.rb +7 -7
  154. data/lib/yard/templates/helpers/uml_helper.rb +3 -3
  155. data/lib/yard/templates/section.rb +14 -14
  156. data/lib/yard/templates/template.rb +54 -54
  157. data/lib/yard/verifier.rb +27 -27
  158. data/spec/cli/list_spec.rb +8 -0
  159. data/spec/cli/yardoc_spec.rb +58 -10
  160. data/spec/code_objects/extra_file_object_spec.rb +132 -0
  161. data/spec/code_objects/macro_object_spec.rb +154 -0
  162. data/spec/docstring_spec.rb +90 -0
  163. data/spec/handlers/base_spec.rb +22 -0
  164. data/spec/handlers/examples/macro_handler_001.rb.txt +73 -0
  165. data/spec/handlers/examples/method_handler_001.rb.txt +17 -0
  166. data/spec/handlers/macro_handler_spec.rb +140 -0
  167. data/spec/handlers/method_handler_spec.rb +28 -0
  168. data/spec/handlers/processor_spec.rb +4 -0
  169. data/spec/handlers/spec_helper.rb +1 -1
  170. data/spec/parser/c_parser_spec.rb +47 -16
  171. data/spec/parser/examples/extrafile.c.txt +8 -0
  172. data/spec/parser/examples/multifile.c.txt +6 -0
  173. data/spec/parser/ruby/ruby_parser_spec.rb +5 -0
  174. data/spec/parser/source_parser_spec.rb +235 -0
  175. data/spec/rake/yardoc_task_spec.rb +22 -17
  176. data/spec/serializers/file_system_serializer_spec.rb +6 -0
  177. data/spec/server/commands/library_command_spec.rb +39 -0
  178. data/spec/spec_helper.rb +14 -0
  179. data/spec/templates/examples/method001.html +6 -6
  180. data/spec/templates/examples/method002.html +4 -4
  181. data/spec/templates/examples/method003.html +10 -10
  182. data/spec/templates/examples/method005.html +2 -2
  183. data/spec/templates/examples/module001.dot +2 -0
  184. data/spec/templates/examples/module001.html +76 -37
  185. data/spec/templates/examples/module001.txt +1 -1
  186. data/spec/templates/helpers/base_helper_spec.rb +7 -2
  187. data/spec/templates/helpers/html_helper_spec.rb +49 -5
  188. data/spec/templates/helpers/markup_helper_spec.rb +9 -8
  189. data/spec/templates/module_spec.rb +7 -0
  190. data/spec/templates/onefile_spec.rb +47 -0
  191. data/templates/default/fulldoc/html/css/style.css +7 -5
  192. data/templates/default/fulldoc/html/full_list.erb +13 -10
  193. data/templates/default/fulldoc/html/full_list_files.erb +1 -1
  194. data/templates/default/fulldoc/html/js/app.js +16 -14
  195. data/templates/default/fulldoc/html/js/full_list.js +7 -6
  196. data/templates/default/fulldoc/html/setup.rb +78 -17
  197. data/templates/default/layout/html/files.erb +1 -1
  198. data/templates/default/layout/html/headers.erb +11 -7
  199. data/templates/default/layout/html/search.erb +4 -4
  200. data/templates/default/layout/html/setup.rb +28 -8
  201. data/templates/default/module/html/inherited_attributes.erb +17 -0
  202. data/templates/default/module/setup.rb +1 -1
  203. data/templates/default/onefile/html/files.erb +2 -2
  204. data/templates/default/onefile/html/layout.erb +1 -1
  205. data/templates/default/onefile/html/setup.rb +7 -5
  206. data/templates/default/tags/html/option.erb +1 -1
  207. data/templates/default/tags/html/tag.erb +3 -3
  208. data/templates/guide/class/html/setup.rb +1 -0
  209. data/templates/guide/docstring/html/setup.rb +1 -0
  210. data/templates/guide/fulldoc/html/css/style.css +91 -0
  211. data/templates/guide/fulldoc/html/js/app.js +33 -0
  212. data/templates/guide/fulldoc/html/setup.rb +54 -0
  213. data/templates/guide/layout/html/layout.erb +81 -0
  214. data/templates/guide/layout/html/setup.rb +24 -0
  215. data/templates/guide/method/html/header.erb +18 -0
  216. data/templates/guide/method/html/setup.rb +21 -0
  217. data/templates/guide/module/html/header.erb +7 -0
  218. data/templates/guide/module/html/method_list.erb +5 -0
  219. data/templates/guide/module/html/setup.rb +26 -0
  220. data/templates/guide/tags/html/setup.rb +8 -0
  221. metadata +40 -7
  222. data/lib/yard/handlers/ruby/legacy/process_handler.rb +0 -13
  223. data/lib/yard/handlers/ruby/process_handler.rb +0 -18
  224. data/spec/handlers/process_handler_spec.rb +0 -17
data/.yardopts CHANGED
@@ -1,6 +1,7 @@
1
1
  --protected
2
2
  --no-private
3
3
  --exclude /server/templates/
4
+ --exclude /yard/rubygems/
4
5
  --asset docs/images:images
5
6
  -
6
7
  docs/WhatsNew.md
data/ChangeLog CHANGED
@@ -1,11 +1,724 @@
1
+ 2011-05-17 Loren Segal <lsegal@soen.ca>
2
+
3
+ * ChangeLog, README.md: Release 0.7.0
4
+
5
+ * lib/yard.rb: Bump version to 0.7.0
6
+
7
+ * README.md: Update readme for release
8
+
9
+ 2011-05-16 Loren Segal <lsegal@soen.ca>
10
+
11
+ * docs/WhatsNew.md: Discuss new -t guide template in WhatsNew
12
+
13
+ * lib/yard/templates/helpers/html_helper.rb: A little hack to avoid
14
+ {http://foo.com} from warning about invalid object when autolinking is turned
15
+ on in the markup provider
16
+
17
+ * docs/WhatsNew.md: Add documentation about new --yardopts flag
18
+
19
+ * templates/guide/fulldoc/html/css/style.css: Fix some tag stylings in guide
20
+ style
21
+
22
+ * lib/yard/templates/helpers/html_helper.rb,
23
+ spec/templates/helpers/html_helper_spec.rb: Make sure RDiscount autolinks
24
+ URLs (silly RDiscount)
25
+
26
+ * .gitignore: Ignore doc_guide dir
27
+
28
+ * .yardopts_guide: Put the guide docs in another directory
29
+
30
+ * .yardopts_guide: Add title to Guide docs
31
+
32
+ * docs/GettingStarted.md: Document the use of the @encoding extra file
33
+ metadata tag
34
+
35
+ * .yardopts_guide: Add guide yardopts
36
+
37
+ 2011-05-15 Loren Segal <lsegal@soen.ca>
38
+
39
+ * templates/guide/layout/html/layout.erb: Update layout to remove ToC title
40
+ if there are no topics
41
+
42
+ * templates/guide/fulldoc/html/css/style.css,
43
+ templates/guide/layout/html/layout.erb: Update guide style
44
+
45
+ 2011-04-11 Loren Segal <lsegal@soen.ca>
46
+
47
+ * templates/guide/class/html/setup.rb,
48
+ templates/guide/docstring/html/setup.rb,
49
+ templates/guide/fulldoc/html/css/style.css,
50
+ templates/guide/fulldoc/html/js/app.js,
51
+ templates/guide/fulldoc/html/setup.rb,
52
+ templates/guide/layout/html/layout.erb, templates/guide/layout/html/setup.rb,
53
+ templates/guide/method/html/header.erb, templates/guide/method/html/setup.rb,
54
+ templates/guide/module/html/header.erb,
55
+ templates/guide/module/html/method_list.erb,
56
+ templates/guide/module/html/setup.rb, templates/guide/tags/html/setup.rb: Add
57
+ initial guide template
58
+
59
+ 2011-05-16 Loren Segal <lsegal@soen.ca>
60
+
61
+ * docs/Templates.md: Update Templates guide on adding custom js/css; manually
62
+ generating assets is no longer necessary
63
+
64
+ * spec/templates/onefile_spec.rb, templates/default/fulldoc/html/setup.rb,
65
+ templates/default/onefile/html/files.erb,
66
+ templates/default/onefile/html/setup.rb: Fix --one-file template generation
67
+ and add some sanity specs so it doesn't break again
68
+
69
+ 2011-05-15 Loren Segal <lsegal@soen.ca>
70
+
71
+ * lib/yard/templates/helpers/html_helper.rb,
72
+ spec/templates/helpers/html_helper_spec.rb: HtmlHelper#charset should be
73
+ aware of extra files and set proper page encoding
74
+
75
+ * lib/yard/code_objects/extra_file_object.rb,
76
+ spec/code_objects/extra_file_object_spec.rb: Attempt to reparse extra file
77
+ contents as binary data if it cannot be parsed as utf-8
78
+
79
+ * lib/yard/cli/yardoc.rb: Fix wording of --charset
80
+
81
+ * docs/Tags.md: Fix formatting in Tags.md
82
+
83
+ * lib/yard/templates/helpers/html_helper.rb,
84
+ spec/templates/helpers/html_helper_spec.rb: Fix bug in htmlify when
85
+ encountering a {} string
86
+
87
+ * lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Add support for --yardopts
88
+ FILE to specify a non-standard yardopts filename
89
+
90
+ * lib/yard/cli/command.rb, lib/yard/cli/yardoc.rb: Fix yard doc --help
91
+ formatting of options to make it fit on 80 width terminals
92
+
93
+ 2011-05-14 Loren Segal <lsegal@soen.ca>
94
+
95
+ * docs/WhatsNew.md: What's New docs for 0.7.0
96
+
97
+ * lib/yard/code_objects/macro_object.rb, lib/yard/parser/source_parser.rb:
98
+ Some inter-doc link formatting fixes
99
+
100
+ * docs/WhatsNew.md: Initial what's new sections
101
+
102
+ * lib/yard/parser/source_parser.rb: Add @since tag for SourceParser#contents
103
+
104
+ * lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb: Add
105
+ SourceParser.{before,after}_parse_{list,file} callbacks which allow plugin
106
+ developers to register callbacks and hook into parsing phase, either on a
107
+ per-file basis or a per-"parse" (list of files) basis. Closes #315
108
+
109
+ * lib/yard/docstring.rb: Make Docstring#create_tag public
110
+
111
+ 2011-05-13 Loren Segal <lsegal@soen.ca>
112
+
113
+ * lib/yard/code_objects/macro_object.rb: Fix formatting of list in
114
+ MacroObject#expand
115
+
116
+ * docs/GettingStarted.md: Add `{render:}` sample tag in getting started guide
117
+
118
+ * docs/GettingStarted.md: Document new {render:FOO} syntax Closes #309
119
+
120
+ * docs/GettingStarted.md, docs/Tags.md: Document new macros behaviour in
121
+ Getting Started guide and Tags Overview Closes #307
122
+
123
+ * lib/yard/templates/helpers/html_helper.rb: Don't attempt to link file
124
+ without serializer
125
+
126
+ * lib/yard/handlers/base.rb: Make sure globals.__attached_macros is
127
+ initialized in handlers
128
+
129
+ * lib/yard/code_objects/macro_object.rb: Document MacroObject class
130
+
131
+ * lib/yard/docstring.rb, lib/yard/handlers/base.rb,
132
+ lib/yard/handlers/ruby/macro_handler_methods.rb,
133
+ spec/handlers/examples/macro_handler_001.rb.txt,
134
+ spec/handlers/macro_handler_spec.rb: Properly handle @overload tags and
135
+ create @overload tag when @method is used
136
+
137
+ 2011-05-13 Franklin Webber <franklin.webber@gmail.com>
138
+
139
+ * lib/yard/cli/command.rb: Load Script - load error message For scripts that
140
+ are composed of multiple files the load script error message, in it's current
141
+ state is a head scratcher. I updated the load error message to include the
142
+ load exception in the output to help debug the loading of the script.
143
+
144
+ 2011-05-13 Loren Segal <lsegal@soen.ca>
145
+
146
+ * lib/yard/cli/yardoc.rb, lib/yard/parser/source_parser.rb,
147
+ spec/cli/yardoc_spec.rb: Add 'app/**/*.rb' to default parsing glob. Closes
148
+ #314
149
+
150
+ * templates/default/fulldoc/html/css/style.css: Make style more friendly to
151
+ {render} on extra files
152
+
153
+ 2011-05-11 Loren Segal <lsegal@soen.ca>
154
+
155
+ * lib/yard/handlers/base.rb, lib/yard/handlers/ruby/base.rb,
156
+ lib/yard/handlers/ruby/legacy/base.rb,
157
+ lib/yard/handlers/ruby/legacy/macro_handler.rb,
158
+ lib/yard/handlers/ruby/legacy/method_handler.rb,
159
+ lib/yard/handlers/ruby/macro_handler.rb,
160
+ lib/yard/handlers/ruby/macro_handler_methods.rb,
161
+ lib/yard/handlers/ruby/method_handler.rb,
162
+ spec/handlers/method_handler_spec.rb, spec/parser/source_parser_spec.rb:
163
+ Support @macro creation/expansion in any object docstring
164
+
165
+ * lib/yard/docstring.rb: Docstring should accept initialization with array
166
+ (legacy handler support)
167
+
168
+ 2011-05-10 misfo <tedwardo2@gmail.com>
169
+
170
+ * templates/default/fulldoc/html/js/app.js: ignore keyboard shortcuts when an
171
+ input is active use event.target since it's standard across all browsers,
172
+ event.originalTarget is mozilla-specific
173
+
174
+ 2011-05-10 Loren Segal <lsegal@soen.ca>
175
+
176
+ * .yardopts: Ignore rubygems/ from docs (they're just backports)
177
+
178
+ 2011-05-09 Loren Segal <lsegal@soen.ca>
179
+
180
+ * lib/yard.rb, lib/yard/rubygems/backports.rb,
181
+ lib/yard/rubygems/backports/LICENSE.txt, lib/yard/rubygems/backports/MIT.txt,
182
+ lib/yard/rubygems/backports/gem.rb,
183
+ lib/yard/rubygems/backports/source_index.rb: Fix RubyGems 1.8.x deprecations
184
+ by backporting Gem::SourceIndex We can work on migrating to the new API as
185
+ time goes on. Closes #311
186
+
187
+ 2011-05-08 Loren Segal <lsegal@soen.ca>
188
+
189
+ * templates/default/fulldoc/html/css/full_list.css: Remove '|' after content
190
+ for menus; it is now generated statically.
191
+
192
+ 2011-05-08 Franklin Webber <franklin.webber@gmail.com>
193
+
194
+ * docs/Templates.md: Template - Adding and Overriding Search Menus An
195
+ explanation of overriding the existing functionality of the search menus An
196
+ explanation of adding a new search menu
197
+
198
+ * docs/Templates.md: Template - Custom Javascript and Stylesheets Outlined
199
+ how to override and add a custom javascript and stylesheet file for plugin
200
+ authors
201
+
202
+ 2011-05-07 Loren Segal <lsegal@soen.ca>
203
+
204
+ * lib/yard/handlers/processor.rb: Fix Processor spec, expects a globals
205
+ object to be created
206
+
207
+ * lib/yard/code_objects/base.rb: No longer support 'Foo.bar' or 'Foo#bar'
208
+ syntax as name argument to Base.new It was never used in YARD's codebase,
209
+ and makes initialization very complex.
210
+
211
+ * lib/yard/cli/yardoc.rb: Handle objects with no file/line info when printing
212
+
213
+ * lib/yard/autoload.rb, lib/yard/cli/command_parser.rb, lib/yard/cli/list.rb,
214
+ spec/cli/list_spec.rb: Add `yard list` command, basically just passes off to
215
+ `yard doc --list`. Closes #283
216
+
217
+ * lib/yard/handlers/ruby/macro_handler_methods.rb: Don't need to
218
+ ensure_loaded when checking macros anymore
219
+
220
+ * lib/yard/handlers/processor.rb, lib/yard/parser/source_parser.rb: Make sure
221
+ same globals object is passed across all SourceParsers
222
+
223
+ * lib/yard/handlers/ruby/alias_handler.rb,
224
+ lib/yard/handlers/ruby/attribute_handler.rb,
225
+ lib/yard/handlers/ruby/class_condition_handler.rb,
226
+ lib/yard/handlers/ruby/class_handler.rb,
227
+ lib/yard/handlers/ruby/class_variable_handler.rb,
228
+ lib/yard/handlers/ruby/constant_handler.rb,
229
+ lib/yard/handlers/ruby/extend_handler.rb,
230
+ lib/yard/handlers/ruby/legacy/alias_handler.rb,
231
+ lib/yard/handlers/ruby/legacy/attribute_handler.rb,
232
+ lib/yard/handlers/ruby/legacy/class_handler.rb,
233
+ .../handlers/ruby/legacy/class_variable_handler.rb,
234
+ lib/yard/handlers/ruby/legacy/constant_handler.rb,
235
+ lib/yard/handlers/ruby/legacy/extend_handler.rb,
236
+ lib/yard/handlers/ruby/legacy/mixin_handler.rb,
237
+ lib/yard/handlers/ruby/legacy/module_handler.rb,
238
+ .../ruby/legacy/private_constant_handler.rb,
239
+ .../handlers/ruby/legacy/visibility_handler.rb,
240
+ lib/yard/handlers/ruby/mixin_handler.rb,
241
+ lib/yard/handlers/ruby/module_handler.rb,
242
+ lib/yard/handlers/ruby/private_constant_handler.rb: Declare a bunch of
243
+ handlers as namespace_only (for potential future optimizations)
244
+
245
+ * lib/yard/handlers/ruby/legacy/macro_handler.rb,
246
+ lib/yard/handlers/ruby/legacy/method_handler.rb,
247
+ lib/yard/handlers/ruby/macro_handler.rb,
248
+ lib/yard/handlers/ruby/macro_handler_methods.rb,
249
+ lib/yard/handlers/ruby/method_handler.rb: Optimize macro handler, increase
250
+ performance to pre-macro speeds
251
+
252
+ * lib/yard/handlers/base.rb, lib/yard/handlers/processor.rb,
253
+ lib/yard/parser/source_parser.rb, spec/handlers/processor_spec.rb,
254
+ spec/handlers/spec_helper.rb: Make Processor#globals global to entire
255
+ post-process phase and add #extra_state for file-specific state
256
+
257
+ 2011-05-07 Franklin Webber <franklin.webber@gmail.com>
258
+
259
+ * templates/default/fulldoc/html/setup.rb: Fulldoc Template Updated to
260
+ contain information about the various helper methods specified.
261
+
262
+ 2011-05-07 Loren Segal <lsegal@soen.ca>
263
+
264
+ * lib/yard/handlers/base.rb, lib/yard/handlers/processor.rb,
265
+ spec/handlers/base_spec.rb: Add Processor#globals and Handlers::Base#globals
266
+ to allow handlers to share state within post processing of files. Closes
267
+ #310
268
+
269
+ * lib/yard/handlers/ruby/macro_handler.rb, lib/yard/parser/ruby/ast_node.rb,
270
+ spec/handlers/examples/macro_handler_001.rb.txt,
271
+ spec/handlers/macro_handler_spec.rb: Properly handle macro calls with no
272
+ arguments
273
+
274
+ * lib/yard/templates/helpers/html_helper.rb,
275
+ lib/yard/templates/helpers/markup_helper.rb, spec/cli/yardoc_spec.rb:
276
+ Properly clear markup cache, and try to load markup cache from markup_class
277
+
278
+ * lib/yard/autoload.rb, lib/yard/handlers/ruby/legacy/macro_handler.rb,
279
+ lib/yard/handlers/ruby/legacy/method_handler.rb,
280
+ lib/yard/handlers/ruby/macro_handler.rb,
281
+ lib/yard/handlers/ruby/macro_handler_methods.rb,
282
+ spec/handlers/examples/macro_handler_001.rb.txt: Backport macros to legacy
283
+ parser/handlers
284
+
285
+ * spec/docstring_spec.rb: Remove silly useless spec.
286
+
287
+ * spec/spec_helper.rb: Only htmlify p() and puts() inside of TextMate (rspec
288
+ helpers)
289
+
290
+ * lib/yard/handlers/ruby/macro_handler.rb: Make attribute tag parser regex
291
+ 1.8 compatible
292
+
293
+ * lib/yard/templates/helpers/html_helper.rb,
294
+ lib/yard/templates/helpers/markup_helper.rb,
295
+ spec/templates/helpers/html_helper_spec.rb: Add -m ruby markup type and
296
+ detection of .rb/.ru extra files. Also marks up files when included via
297
+ {include:file:...} (and works with ruby source files). Closes #303
298
+
299
+ * lib/yard/templates/helpers/base_helper.rb,
300
+ spec/templates/helpers/base_helper_spec.rb: Disallow users from calling
301
+ include:file: on files outside of Dir.pwd
302
+
303
+ * templates/default/fulldoc/html/setup.rb: Don't duplicate README if
304
+ specified manually
305
+
306
+ * .../templates/doc_server/full_list/html/setup.rb: Show instance attributes
307
+ in method list for yard server Closes #302
308
+
309
+ 2011-05-01 Loren Segal <lsegal@soen.ca>
310
+
311
+ * lib/yard/code_objects/macro_object.rb,
312
+ lib/yard/handlers/ruby/macro_handler.rb, lib/yard/tags/library.rb,
313
+ spec/code_objects/macro_object_spec.rb, spec/handlers/macro_handler_spec.rb:
314
+ Refactor macro expansion methods into MacroObject class
315
+
316
+ 2011-04-29 Loren Segal <lsegal@soen.ca>
317
+
318
+ * lib/yard/handlers/ruby/macro_handler.rb,
319
+ spec/handlers/examples/macro_handler_001.rb.txt,
320
+ spec/handlers/macro_handler_spec.rb: Handle RDoc style ## hash flag
321
+ docstrings when recognizing DSL methods
322
+
323
+ 2011-04-28 Loren Segal <lsegal@soen.ca>
324
+
325
+ * lib/yard/code_objects/macro_object.rb,
326
+ lib/yard/handlers/ruby/macro_handler.rb,
327
+ spec/code_objects/macro_object_spec.rb, spec/handlers/macro_handler_spec.rb,
328
+ spec/handlers/method_handler_spec.rb: Add MacroObject.find to do a Registry
329
+ lookup without needing to know the .macro. prefix
330
+
331
+ * lib/yard/code_objects/macro_object.rb,
332
+ lib/yard/handlers/ruby/macro_handler.rb,
333
+ lib/yard/handlers/ruby/method_handler.rb,
334
+ spec/code_objects/macro_object_spec.rb, spec/handlers/macro_handler_spec.rb,
335
+ spec/handlers/method_handler_spec.rb: Refactor MacroObject API to make it
336
+ easier to use, and add MacroObject.create for quick macro creation
337
+
338
+ * lib/yard/handlers/ruby/macro_handler.rb: Fix lookup path from outside of
339
+ spec suite
340
+
341
+ * lib/yard/autoload.rb, lib/yard/handlers/base.rb,
342
+ lib/yard/handlers/ruby/legacy/process_handler.rb,
343
+ lib/yard/handlers/ruby/process_handler.rb,
344
+ spec/handlers/process_handler_spec.rb: New macros make process handler
345
+ obsolete, it can be removed
346
+
347
+ * lib/yard/handlers/ruby/method_handler.rb,
348
+ spec/handlers/examples/method_handler_001.rb.txt,
349
+ spec/handlers/method_handler_spec.rb: Add macro objects when creating class
350
+ methods
351
+
352
+ * spec/spec_helper.rb: Better HTML friendly printing in the test environment
353
+
354
+ * lib/yard/handlers/ruby/base.rb: Allow handles method_call to have no
355
+ specified method (catches all method calls)
356
+
357
+ * lib/yard/docstring.rb, spec/docstring_spec.rb: Add Docstring#delete_tags,
358
+ Docstring#delete_tag_if and Docstring#dup to support new macros behaviour
359
+
360
+ * lib/yard/autoload.rb, lib/yard/code_objects/macro_object.rb,
361
+ lib/yard/handlers/ruby/macro_handler.rb, lib/yard/tags/library.rb,
362
+ spec/handlers/examples/macro_handler_001.rb.txt,
363
+ spec/handlers/macro_handler_spec.rb: Add MacroObject and MacroHandler which
364
+ processes DSL methods in a namespace that have any @tags defined on them as
365
+ dynamically generated methods, where the first argument is the method name.
366
+ YARD will now automatically detect a dynamic method if it sees tags defined
367
+ in its docstring, for example: # The name property # @return [String] a
368
+ user's name property :name, String The above definition will automatically
369
+ create an instance method named `name` with the docstring "The name property"
370
+ (and return tag). In addition to this default behaviour, the method name and
371
+ object type/properties can be customized with the addition of the @method,
372
+ @attribute, @scope, @visibility tags. Specifically, the example above can be
373
+ defined as an attribute by specifying: # @attribute # @return [String] the
374
+ name property property :name, String The attribute can be customized further
375
+ by adding the 'r' or 'w' type to specify if it is writeonly: # @attribute
376
+ [w] property :writeonlyproperty The method/attribute name/signature can also
377
+ be customized by adding a signature to the @method/@attibute tags: # @method
378
+ foobar(name, opts = {}) # @param [String] name # @scope class register
379
+ :foobar Note that because @scope is set, `foobar` will be made into a class
380
+ method. Visibility can be set in the same way. Finally, a new @macro tag is
381
+ added, with a MacroObject to support it. Whenever a @macro is defined on a
382
+ docstring, it creates a new re-usable named macro object that can be
383
+ re-applied to any other object, either explicitly by calling on the name, or
384
+ implicitly through the "attach" keyword (or by declaring the macro on a class
385
+ method directly [*not yet supported*]). Macros are expanded when applied,
386
+ interpolating `$N` or `${N-M}` strings with the respective parameters in the
387
+ original DSL method. `$0` and `$*` are special tokens that refer to the DSL
388
+ method name and the full source line, respectively. The following is an
389
+ example of how a DSL method for a CLI option parsing library (such as Rake,
390
+ Thor, or others) can be easily documented with macro expansion: # @macro
391
+ command # @method $1(opts = {}) # $3 # @return [$2] the result of the
392
+ $0 command :create_file, String, "Creates a new file and returns the
393
+ filename" The above will automatically expand the macro on the first usage,
394
+ and then create a new macro named 'command' that can be reused by other
395
+ commands. The above docstring would be expanded into the full docstring: #
396
+ @method create_file(opts = {}) # Creates a new file and returns the filename
397
+ # @return [String] the result of the command command :create_file, String,
398
+ "Creates a new file and returns the filename" This macro can then be re-used
399
+ on other commands, either explicitly via: # @macro command command :exit,
400
+ Fixnum, "Exits the shell and returns the exit code" Or implicitly by
401
+ attaching the command macro to the `command` method call. This can be done by
402
+ adding `[attach]` to the initial @macro definition: # @macro [attach]
403
+ command # ... command :create_file, ... The next use of `command` will
404
+ automatically use this macro, even without any explicit docstring or tags:
405
+ command :foobar, String, "this will be in my docs!" Note that the `command`
406
+ must come from a class that is in the same inheritance tree as the initially
407
+ defined macro. That is, if `command` is used in another class, it will not be
408
+ documented. A new macro can be defined for that separate method. In the
409
+ future, it will be possible to define a macro directly on the class method
410
+ declaration itself, ie.: class CommandParser # @macro command # @method
411
+ $1(opts = {}) # $3 # @return [$2] def self.command(name, return_type,
412
+ docstring, &block) # implementation... end command :name, String, "retrieves
413
+ a username" do DB.get(username) end end * @attribute [rw] optional_name -
414
+ defines the DSL method as an attribute * @macro name DOCSTRING - defines a
415
+ new macro using name and expands DOCSTRING * @method signature - declares
416
+ that the DSL method is a method with an optional signature. Use this when you
417
+ otherwise have no other tags to specify for the docstring (since YARD
418
+ requires at least one @tag to detect a dynamic DSL method) * @scope
419
+ class|instance - sets the scope of the newly added method * @visibility
420
+ public|private|protected - sets the visibility of the newly added method
421
+
422
+ 2011-05-07 Loren Segal <lsegal@soen.ca>
423
+
424
+ * lib/yard/parser/ruby/ruby_parser.rb, spec/parser/ruby/ruby_parser_spec.rb:
425
+ Fix rendering of %w() array literals Closes #306
426
+
427
+ * lib/yard/handlers/base.rb, lib/yard/handlers/ruby/alias_handler.rb,
428
+ lib/yard/handlers/ruby/legacy/alias_handler.rb: Ensure docstring has
429
+ line_range if parsed from a file Closes #243
430
+
431
+ * ChangeLog: Don't markdown changelog
432
+
433
+ * lib/yard/code_objects/base.rb: Cache CodeObjects::Base#docstring properly
434
+
435
+ * lib/yard/docstring.rb, spec/docstring_spec.rb: Docstring#line should return
436
+ nil if #line_range is nil
437
+
438
+ * lib/yard/autoload.rb: Update documentation in autoload
439
+
440
+ * lib/yard/rake/yardoc_task.rb, spec/rake/yardoc_task_spec.rb: Fix regression
441
+ where YardocTask#verifier would not properly set verifier object Closes #282
442
+
443
+ * lib/yard/rake/yardoc_task.rb: Document that YardocTask#verifier should take
444
+ a Verifier object Closes #281
445
+
446
+ * lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Allow run(nil) to cancel
447
+ argument parsing in Yardoc
448
+
449
+ * spec/parser/source_parser_spec.rb: Only test BOM in ripper/1.9
450
+
451
+ * .../default/module/html/inherited_attributes.erb: Sort inherited attributes
452
+
453
+ * lib/yard/parser/ruby/ruby_parser.rb, spec/parser/source_parser_spec.rb:
454
+ Support any number of hashes prefixing a comment line
455
+
456
+ * lib/yard/parser/c_parser.rb: Remove nonexistent ENOTFILE constant
457
+
458
+ 2011-05-05 Postmodern <postmodern.mod3@gmail.com>
459
+
460
+ * lib/yard.rb: Catch all Exceptions raised by Rubinius or JRuby when testing
461
+ callcc.
462
+
463
+ 2011-04-26 Loren Segal <lsegal@soen.ca>
464
+
465
+ * lib/yard/code_objects/extra_file_object.rb,
466
+ spec/code_objects/extra_file_object_spec.rb: Add support for @encoding
467
+ metadata in extra files to specify individual file encodings
468
+
469
+ 2011-04-25 Loren Segal <lsegal@soen.ca>
470
+
471
+ * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Warn when extra
472
+ C file is missing from documentation
473
+
474
+ * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Gracefully
475
+ handle missing extra source files when parsing C code
476
+
477
+ * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb,
478
+ spec/parser/examples/extrafile.c.txt, spec/parser/examples/multifile.c.txt:
479
+ Find docstring for methods that are documented in alternate C source files
480
+ when "/* in file.c */" comment is found.
481
+
482
+ * .../templates/default/layout/html/headers.erb,
483
+ .../server/templates/default/layout/html/setup.rb: Update yard server
484
+ templates to use new css/js listing feature from #289
485
+
486
+ * templates/default/fulldoc/html/setup.rb,
487
+ templates/default/layout/html/headers.erb,
488
+ templates/default/layout/html/search.erb,
489
+ templates/default/layout/html/setup.rb: Refactor css/js API changes from #289
490
+ into layout template so that it works without fulldoc
491
+
492
+ * lib/yard/server/commands/display_file_command.rb,
493
+ lib/yard/server/doc_server_helper.rb,
494
+ lib/yard/templates/helpers/html_helper.rb: Fix yard server to work with
495
+ ExtraFileObjects
496
+
497
+ * .../templates/default/layout/html/headers.erb,
498
+ .../doc_server/full_list/html/full_list.erb,
499
+ .../doc_server/library_list/html/headers.erb,
500
+ templates/default/fulldoc/html/full_list.erb,
501
+ templates/default/onefile/html/layout.erb: Add proper meta content-type tag
502
+ to layout headers Closes #298
503
+
504
+ * lib/yard/cli/yardoc.rb: Properly check for -m being set in yardoc arguments
505
+
506
+ * .../server/commands/display_object_command_spec.rb,
507
+ spec/server/commands/library_command_spec.rb: Move tests to
508
+ LibraryObjectCommand and improve setup/teardown
509
+
510
+ * lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Fix regression in `yard -m
511
+ markup` selection
512
+
513
+ 2011-04-25 Franklin Webber <franklin.webber@gmail.com>
514
+
515
+ * lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb,
516
+ .../server/commands/display_object_command_spec.rb: YARD server - rdoc not
517
+ set as default markup; Fixes #300 yardoc parse_arguments reset the markup to
518
+ assist with performing validation. However, that should only be done when
519
+ yard is generating output, this is not the case when running 'yard server'
520
+ which generates no output.
521
+
522
+ 2011-04-21 Loren Segal <lsegal@soen.ca>
523
+
524
+ * lib/yard/tags/library.rb: @api should be transitive too
525
+
526
+ * lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb: Add
527
+ support for UTF-8 byte order mark encoded source files Closes #288
528
+
529
+ 2011-04-21 Erik Michaels-Ober <sferik@gmail.com>
530
+
531
+ * lib/yard.rb, lib/yard/autoload.rb, lib/yard/cli/command.rb,
532
+ lib/yard/cli/command_parser.rb, lib/yard/cli/config.rb, lib/yard/cli/diff.rb,
533
+ lib/yard/cli/gems.rb, lib/yard/cli/graph.rb, lib/yard/cli/help.rb,
534
+ lib/yard/cli/server.rb, lib/yard/cli/stats.rb, lib/yard/cli/yardoc.rb,
535
+ lib/yard/cli/yri.rb, lib/yard/code_objects/base.rb,
536
+ lib/yard/code_objects/class_object.rb,
537
+ lib/yard/code_objects/constant_object.rb,
538
+ lib/yard/code_objects/extended_method_object.rb,
539
+ lib/yard/code_objects/extra_file_object.rb,
540
+ lib/yard/code_objects/method_object.rb,
541
+ lib/yard/code_objects/module_object.rb,
542
+ lib/yard/code_objects/namespace_object.rb, lib/yard/code_objects/proxy.rb,
543
+ lib/yard/code_objects/root_object.rb, lib/yard/config.rb,
544
+ lib/yard/core_ext/array.rb, lib/yard/core_ext/file.rb,
545
+ lib/yard/core_ext/insertion.rb, lib/yard/core_ext/module.rb,
546
+ lib/yard/core_ext/string.rb, lib/yard/core_ext/symbol_hash.rb,
547
+ lib/yard/docstring.rb, lib/yard/globals.rb, lib/yard/handlers/base.rb,
548
+ lib/yard/handlers/processor.rb, lib/yard/handlers/ruby/alias_handler.rb,
549
+ lib/yard/handlers/ruby/attribute_handler.rb, lib/yard/handlers/ruby/base.rb,
550
+ lib/yard/handlers/ruby/class_condition_handler.rb,
551
+ lib/yard/handlers/ruby/class_handler.rb,
552
+ lib/yard/handlers/ruby/class_variable_handler.rb,
553
+ lib/yard/handlers/ruby/constant_handler.rb,
554
+ lib/yard/handlers/ruby/exception_handler.rb,
555
+ lib/yard/handlers/ruby/legacy/alias_handler.rb,
556
+ lib/yard/handlers/ruby/legacy/attribute_handler.rb,
557
+ lib/yard/handlers/ruby/legacy/base.rb,
558
+ .../ruby/legacy/class_condition_handler.rb,
559
+ lib/yard/handlers/ruby/legacy/class_handler.rb,
560
+ .../handlers/ruby/legacy/class_variable_handler.rb,
561
+ lib/yard/handlers/ruby/legacy/constant_handler.rb,
562
+ lib/yard/handlers/ruby/legacy/exception_handler.rb,
563
+ lib/yard/handlers/ruby/legacy/method_handler.rb,
564
+ lib/yard/handlers/ruby/legacy/mixin_handler.rb,
565
+ lib/yard/handlers/ruby/legacy/module_handler.rb,
566
+ .../ruby/legacy/private_constant_handler.rb,
567
+ lib/yard/handlers/ruby/legacy/process_handler.rb,
568
+ .../handlers/ruby/legacy/visibility_handler.rb,
569
+ lib/yard/handlers/ruby/legacy/yield_handler.rb,
570
+ lib/yard/handlers/ruby/method_condition_handler.rb,
571
+ lib/yard/handlers/ruby/method_handler.rb,
572
+ lib/yard/handlers/ruby/mixin_handler.rb,
573
+ lib/yard/handlers/ruby/module_handler.rb,
574
+ lib/yard/handlers/ruby/private_constant_handler.rb,
575
+ lib/yard/handlers/ruby/process_handler.rb,
576
+ lib/yard/handlers/ruby/struct_handler_methods.rb,
577
+ lib/yard/handlers/ruby/visibility_handler.rb,
578
+ lib/yard/handlers/ruby/yield_handler.rb, lib/yard/logging.rb,
579
+ lib/yard/parser/base.rb, lib/yard/parser/c_parser.rb,
580
+ lib/yard/parser/ruby/ast_node.rb, lib/yard/parser/ruby/legacy/ruby_lex.rb,
581
+ lib/yard/parser/ruby/legacy/ruby_parser.rb,
582
+ lib/yard/parser/ruby/legacy/statement.rb,
583
+ lib/yard/parser/ruby/legacy/statement_list.rb,
584
+ lib/yard/parser/ruby/legacy/token_list.rb,
585
+ lib/yard/parser/ruby/ruby_parser.rb, lib/yard/parser/source_parser.rb,
586
+ lib/yard/rake/yardoc_task.rb, lib/yard/registry.rb,
587
+ lib/yard/registry_store.rb, lib/yard/rubygems/specification.rb,
588
+ lib/yard/serializers/base.rb, lib/yard/serializers/file_system_serializer.rb,
589
+ lib/yard/serializers/process_serializer.rb,
590
+ lib/yard/serializers/stdout_serializer.rb,
591
+ lib/yard/serializers/yardoc_serializer.rb, lib/yard/server/adapter.rb,
592
+ lib/yard/server/commands/base.rb,
593
+ lib/yard/server/commands/display_file_command.rb,
594
+ lib/yard/server/commands/display_object_command.rb,
595
+ lib/yard/server/commands/frames_command.rb,
596
+ lib/yard/server/commands/library_command.rb,
597
+ lib/yard/server/commands/library_index_command.rb,
598
+ lib/yard/server/commands/list_command.rb,
599
+ lib/yard/server/commands/search_command.rb,
600
+ lib/yard/server/commands/static_file_command.rb,
601
+ lib/yard/server/doc_server_helper.rb,
602
+ lib/yard/server/doc_server_serializer.rb, lib/yard/server/library_version.rb,
603
+ lib/yard/server/rack_adapter.rb, lib/yard/server/router.rb,
604
+ lib/yard/server/static_caching.rb,
605
+ .../templates/default/fulldoc/html/css/custom.css,
606
+ .../templates/default/fulldoc/html/js/live.js,
607
+ .../templates/default/layout/html/breadcrumb.erb,
608
+ .../doc_server/full_list/html/full_list.erb,
609
+ .../doc_server/library_list/html/contents.erb,
610
+ .../doc_server/library_list/html/headers.erb,
611
+ .../doc_server/processing/html/processing.erb,
612
+ .../templates/doc_server/search/html/search.erb,
613
+ lib/yard/server/webrick_adapter.rb, lib/yard/tags/default_factory.rb,
614
+ lib/yard/tags/default_tag.rb, lib/yard/tags/library.rb,
615
+ lib/yard/tags/option_tag.rb, lib/yard/tags/overload_tag.rb,
616
+ lib/yard/tags/ref_tag_list.rb, lib/yard/tags/tag.rb,
617
+ lib/yard/templates/engine.rb, lib/yard/templates/erb_cache.rb,
618
+ lib/yard/templates/helpers/base_helper.rb,
619
+ lib/yard/templates/helpers/filter_helper.rb,
620
+ lib/yard/templates/helpers/html_helper.rb,
621
+ .../helpers/html_syntax_highlight_helper.rb,
622
+ lib/yard/templates/helpers/markup/rdoc_markup.rb,
623
+ lib/yard/templates/helpers/markup_helper.rb,
624
+ lib/yard/templates/helpers/method_helper.rb,
625
+ lib/yard/templates/helpers/text_helper.rb,
626
+ lib/yard/templates/helpers/uml_helper.rb, lib/yard/templates/section.rb,
627
+ lib/yard/templates/template.rb, lib/yard/verifier.rb: Remove EOL whitespace
628
+
629
+ * lib/yard/templates/helpers/markup_helper.rb,
630
+ spec/templates/helpers/markup_helper_spec.rb: Add Redcarpet to the list of
631
+ Markdown providers
632
+
633
+ 2011-04-16 Franklin Webber <franklin.webber@gmail.com>
634
+
635
+ * templates/default/fulldoc/html/css/full_list.css,
636
+ templates/default/fulldoc/html/full_list.erb,
637
+ templates/default/fulldoc/html/setup.rb,
638
+ templates/default/layout/html/headers.erb,
639
+ templates/default/layout/html/search.erb,
640
+ templates/default/layout/html/setup.rb: Customizable JS, CSS, and menus
641
+ provided methods to override or add to Javascript, CSS, and the search
642
+ fields.
643
+
1
644
  2011-04-14 Loren Segal <lsegal@soen.ca>
2
645
 
3
646
  * ChangeLog, README.md, lib/yard.rb: 0.6.8 release
4
647
 
648
+ 2011-04-13 Loren Segal <lsegal@soen.ca>
649
+
650
+ * lib/yard/templates/helpers/html_helper.rb,
651
+ spec/templates/helpers/html_helper_spec.rb: Allow backslash escaping of YARD
652
+ syntax (`\{foo bar}`) Closes #279
653
+
5
654
  2011-04-12 Loren Segal <lsegal@soen.ca>
6
655
 
7
656
  * spec/cli/yardoc_spec.rb: Fix spec title
8
657
 
658
+ 2011-04-12 Akzhan Abdulin <akzhan.abdulin@gmail.com>
659
+
660
+ * templates/default/fulldoc/html/js/app.js,
661
+ templates/default/fulldoc/html/js/full_list.js: Fix JSLint issues
662
+
663
+ 2011-04-11 Loren Segal <lsegal@soen.ca>
664
+
665
+ * lib/yard/templates/helpers/markup_helper.rb,
666
+ spec/templates/helpers/markup_helper_spec.rb: Remove BlueCloth as default
667
+ markdown processor. Replace it with RDiscount and fall back on Kramdown as
668
+ second source. Closes #263
669
+
670
+ * spec/cli/yardoc_spec.rb: Fix specs due to changes in ExtraFileObject API
671
+
672
+ * lib/yard/code_objects/extra_file_object.rb,
673
+ spec/code_objects/extra_file_object_spec.rb: Add specs for ExtraFileObject
674
+
675
+ * spec/templates/examples/method001.html,
676
+ spec/templates/examples/method002.html,
677
+ spec/templates/examples/method003.html,
678
+ spec/templates/examples/method005.html,
679
+ spec/templates/examples/module001.html,
680
+ templates/default/tags/html/option.erb, templates/default/tags/html/tag.erb:
681
+ Render the option key and parameter name before type specifications. Closes
682
+ #240
683
+
684
+ * lib/yard/cli/yardoc.rb, lib/yard/templates/helpers/markup_helper.rb,
685
+ spec/cli/yardoc_spec.rb, spec/templates/helpers/base_helper_spec.rb,
686
+ spec/templates/helpers/html_helper_spec.rb: Fix broken specs, make things
687
+ work with new markup/extra file logic
688
+
689
+ * lib/yard/code_objects/extra_file_object.rb,
690
+ lib/yard/serializers/file_system_serializer.rb,
691
+ lib/yard/templates/helpers/base_helper.rb,
692
+ lib/yard/templates/helpers/html_helper.rb,
693
+ spec/serializers/file_system_serializer_spec.rb: Update ExtraFileObject and
694
+ use this object in FileSystemSerializer and template helpers (for linking)
695
+
696
+ * ChangeLog, docs/CodeObjects.md, docs/GettingStarted.md, docs/Glossary.md,
697
+ docs/Handlers.md, docs/Overview.md, docs/Parser.md, docs/Tags.md,
698
+ docs/Templates.md, docs/WhatsNew.md: Update docs to use new attribute tags
699
+ for titles
700
+
701
+ * lib/yard/templates/helpers/base_helper.rb: Add {render:Object} syntax to
702
+ templating syntax. Inserts the formatted object in line to the call site.
703
+ Closes #277
704
+
705
+ * README.md, docs/GettingStarted.md: Fix formatting in readme / doc files
706
+
707
+ * lib/yard/templates/helpers/markup_helper.rb: Deprecate some markup file
708
+ loading methods (use ExtraFileObject instead)
709
+
710
+ * lib/yard/cli/yardoc.rb, templates/default/layout/html/headers.erb: Add
711
+ global title to each page title
712
+
713
+ * lib/yard/autoload.rb, lib/yard/cli/yardoc.rb,
714
+ lib/yard/code_objects/extra_file_object.rb,
715
+ lib/yard/templates/helpers/html_helper.rb,
716
+ templates/default/fulldoc/html/full_list_files.erb,
717
+ templates/default/fulldoc/html/setup.rb,
718
+ templates/default/layout/html/files.erb,
719
+ templates/default/layout/html/setup.rb: Add ExtraFileObject to abstract extra
720
+ (doc) files
721
+
9
722
  2011-04-10 Loren Segal <lsegal@soen.ca>
10
723
 
11
724
  * lib/yard/templates/helpers/markup_helper.rb: Ensure that
@@ -51,6 +764,16 @@
51
764
  * lib/yard/templates/helpers/markup_helper.rb: Remove loading of 'rdoc' lib
52
765
  (not all systems have even this file)
53
766
 
767
+ 2011-04-05 Michael Smit <mike.smit@amentra.com>
768
+
769
+ * spec/templates/examples/module001.dot,
770
+ spec/templates/examples/module001.html,
771
+ spec/templates/examples/module001.txt, spec/templates/module_spec.rb,
772
+ .../default/module/html/inherited_attributes.erb,
773
+ templates/default/module/setup.rb: Added a new section to the default module
774
+ template which generates inherited attribute documentation. Modified the
775
+ rspec test for the module template to reflect the change.
776
+
54
777
  2011-04-05 Loren Segal <lsegal@soen.ca>
55
778
 
56
779
  * lib/yard/cli/yardoc.rb, lib/yard/templates/helpers/html_helper.rb,