sprout 1.0.11.pre → 1.0.13.pre

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.

This version of sprout might be problematic. Click here for more details.

Files changed (149) hide show
  1. data/lib/sprout/executable.rb +37 -10
  2. data/lib/sprout/generator/base.rb +17 -0
  3. data/lib/sprout/ruby_feature.rb +1 -1
  4. data/lib/sprout/version.rb +1 -1
  5. data/rdoc/<.html +274 -0
  6. data/rdoc/Dir.html +387 -0
  7. data/rdoc/Object.html +344 -0
  8. data/rdoc/Sprout.html +440 -0
  9. data/rdoc/Sprout/ArchiveUnpacker.html +1045 -0
  10. data/rdoc/Sprout/Base.html +283 -0
  11. data/rdoc/Sprout/Base/ClassMethods.html +474 -0
  12. data/rdoc/Sprout/Concern.html +415 -0
  13. data/rdoc/Sprout/Errors.html +324 -0
  14. data/rdoc/Sprout/Errors/ArchiveUnpackerError.html +284 -0
  15. data/rdoc/Sprout/Errors/DestinationExistsError.html +286 -0
  16. data/rdoc/Sprout/Errors/DuplicateMemberError.html +284 -0
  17. data/rdoc/Sprout/Errors/ExecutableError.html +285 -0
  18. data/rdoc/Sprout/Errors/ExecutableRegistrationError.html +284 -0
  19. data/rdoc/Sprout/Errors/ExecutionError.html +284 -0
  20. data/rdoc/Sprout/Errors/GeneratorError.html +284 -0
  21. data/rdoc/Sprout/Errors/InvalidArgumentError.html +284 -0
  22. data/rdoc/Sprout/Errors/LoadError.html +284 -0
  23. data/rdoc/Sprout/Errors/MissingArgumentError.html +284 -0
  24. data/rdoc/Sprout/Errors/MissingExecutableError.html +284 -0
  25. data/rdoc/Sprout/Errors/MissingGeneratorError.html +285 -0
  26. data/rdoc/Sprout/Errors/MissingTemplateError.html +285 -0
  27. data/rdoc/Sprout/Errors/ProcessRunnerError.html +284 -0
  28. data/rdoc/Sprout/Errors/RemoteFileLoaderError.html +284 -0
  29. data/rdoc/Sprout/Errors/SproutError.html +284 -0
  30. data/rdoc/Sprout/Errors/UnknownArchiveType.html +285 -0
  31. data/rdoc/Sprout/Errors/UsageError.html +284 -0
  32. data/rdoc/Sprout/Errors/ValidationError.html +284 -0
  33. data/rdoc/Sprout/Errors/VersionRequirementNotMetError.html +284 -0
  34. data/rdoc/Sprout/Executable.html +549 -0
  35. data/rdoc/Sprout/Executable/Boolean.html +445 -0
  36. data/rdoc/Sprout/Executable/ClassMethods.html +713 -0
  37. data/rdoc/Sprout/Executable/CollectionParam.html +501 -0
  38. data/rdoc/Sprout/Executable/FileParam.html +512 -0
  39. data/rdoc/Sprout/Executable/Files.html +385 -0
  40. data/rdoc/Sprout/Executable/InstanceMethods.html +1597 -0
  41. data/rdoc/Sprout/Executable/Number.html +284 -0
  42. data/rdoc/Sprout/Executable/Param.html +1660 -0
  43. data/rdoc/Sprout/Executable/ParameterFactory.html +345 -0
  44. data/rdoc/Sprout/Executable/Path.html +339 -0
  45. data/rdoc/Sprout/Executable/Paths.html +339 -0
  46. data/rdoc/Sprout/Executable/StringParam.html +333 -0
  47. data/rdoc/Sprout/Executable/Strings.html +295 -0
  48. data/rdoc/Sprout/Executable/Url.html +284 -0
  49. data/rdoc/Sprout/Executable/Urls.html +284 -0
  50. data/rdoc/Sprout/FileTarget.html +660 -0
  51. data/rdoc/Sprout/Generator.html +643 -0
  52. data/rdoc/Sprout/Generator/Base.html +1143 -0
  53. data/rdoc/Sprout/Generator/Command.html +604 -0
  54. data/rdoc/Sprout/Generator/DirectoryManifest.html +561 -0
  55. data/rdoc/Sprout/Generator/FileManifest.html +545 -0
  56. data/rdoc/Sprout/Generator/Manifest.html +387 -0
  57. data/rdoc/Sprout/Generator/TemplateManifest.html +331 -0
  58. data/rdoc/Sprout/GeneratorGenerator.html +358 -0
  59. data/rdoc/Sprout/Library.html +646 -0
  60. data/rdoc/Sprout/LibraryGenerator.html +368 -0
  61. data/rdoc/Sprout/Log.html +281 -0
  62. data/rdoc/Sprout/Platform.html +610 -0
  63. data/rdoc/Sprout/ProcessRunner.html +1145 -0
  64. data/rdoc/Sprout/ProgressBar.html +281 -0
  65. data/rdoc/Sprout/ProgressBarImpl.html +281 -0
  66. data/rdoc/Sprout/ProgressBarManager.html +281 -0
  67. data/rdoc/Sprout/ProgressBarOutputStream.html +281 -0
  68. data/rdoc/Sprout/RDocParser.html +702 -0
  69. data/rdoc/Sprout/RemoteFileLoader.html +537 -0
  70. data/rdoc/Sprout/RemoteFileTarget.html +741 -0
  71. data/rdoc/Sprout/ReversedProgressBar.html +281 -0
  72. data/rdoc/Sprout/RubyFeature.html +324 -0
  73. data/rdoc/Sprout/RubyFeature/ClassMethods.html +821 -0
  74. data/rdoc/Sprout/RubyGenerator.html +576 -0
  75. data/rdoc/Sprout/Specification.html +915 -0
  76. data/rdoc/Sprout/System.html +383 -0
  77. data/rdoc/Sprout/System/BaseSystem.html +1173 -0
  78. data/rdoc/Sprout/System/JavaSystem.html +284 -0
  79. data/rdoc/Sprout/System/OSXSystem.html +419 -0
  80. data/rdoc/Sprout/System/ThreadMock.html +281 -0
  81. data/rdoc/Sprout/System/UnixSystem.html +583 -0
  82. data/rdoc/Sprout/System/VistaSystem.html +367 -0
  83. data/rdoc/Sprout/System/WinNixSystem.html +417 -0
  84. data/rdoc/Sprout/System/WinSystem.html +672 -0
  85. data/rdoc/Sprout/ToolGenerator.html +376 -0
  86. data/rdoc/Sprout/VERSION.html +274 -0
  87. data/rdoc/SproutTestCase.html +279 -0
  88. data/rdoc/String.html +411 -0
  89. data/rdoc/created.rid +61 -0
  90. data/rdoc/index.html +795 -0
  91. data/rdoc/lib/sprout/archive_unpacker_rb.html +56 -0
  92. data/rdoc/lib/sprout/base_rb.html +111 -0
  93. data/rdoc/lib/sprout/concern_rb.html +52 -0
  94. data/rdoc/lib/sprout/dir_rb.html +52 -0
  95. data/rdoc/lib/sprout/errors_rb.html +52 -0
  96. data/rdoc/lib/sprout/executable/boolean_rb.html +52 -0
  97. data/rdoc/lib/sprout/executable/collection_param_rb.html +52 -0
  98. data/rdoc/lib/sprout/executable/file_param_rb.html +52 -0
  99. data/rdoc/lib/sprout/executable/files_rb.html +52 -0
  100. data/rdoc/lib/sprout/executable/number_rb.html +52 -0
  101. data/rdoc/lib/sprout/executable/param_rb.html +52 -0
  102. data/rdoc/lib/sprout/executable/parameter_factory_rb.html +52 -0
  103. data/rdoc/lib/sprout/executable/path_rb.html +52 -0
  104. data/rdoc/lib/sprout/executable/paths_rb.html +52 -0
  105. data/rdoc/lib/sprout/executable/string_param_rb.html +52 -0
  106. data/rdoc/lib/sprout/executable/strings_rb.html +52 -0
  107. data/rdoc/lib/sprout/executable/url_rb.html +52 -0
  108. data/rdoc/lib/sprout/executable/urls_rb.html +52 -0
  109. data/rdoc/lib/sprout/executable_rb.html +78 -0
  110. data/rdoc/lib/sprout/file_target_rb.html +52 -0
  111. data/rdoc/lib/sprout/generator/base_rb.html +54 -0
  112. data/rdoc/lib/sprout/generator/command_rb.html +52 -0
  113. data/rdoc/lib/sprout/generator/directory_manifest_rb.html +52 -0
  114. data/rdoc/lib/sprout/generator/file_manifest_rb.html +52 -0
  115. data/rdoc/lib/sprout/generator/manifest_rb.html +52 -0
  116. data/rdoc/lib/sprout/generator/template_manifest_rb.html +52 -0
  117. data/rdoc/lib/sprout/generators/generator/generator_generator_rb.html +52 -0
  118. data/rdoc/lib/sprout/generators/generator/templates/generator_test_helper_rb.html +64 -0
  119. data/rdoc/lib/sprout/generators/library/library_generator_rb.html +52 -0
  120. data/rdoc/lib/sprout/generators/ruby/ruby_generator_rb.html +52 -0
  121. data/rdoc/lib/sprout/generators/ruby/templates/ruby_base_rb.html +54 -0
  122. data/rdoc/lib/sprout/generators/tool/tool_generator_rb.html +52 -0
  123. data/rdoc/lib/sprout/library_rb.html +52 -0
  124. data/rdoc/lib/sprout/log_rb.html +52 -0
  125. data/rdoc/lib/sprout/platform_rb.html +52 -0
  126. data/rdoc/lib/sprout/process_runner_rb.html +58 -0
  127. data/rdoc/lib/sprout/progress_bar_rb.html +72 -0
  128. data/rdoc/lib/sprout/rdoc_parser_rb.html +54 -0
  129. data/rdoc/lib/sprout/remote_file_loader_rb.html +54 -0
  130. data/rdoc/lib/sprout/remote_file_target_rb.html +52 -0
  131. data/rdoc/lib/sprout/ruby_feature_rb.html +52 -0
  132. data/rdoc/lib/sprout/specification_rb.html +52 -0
  133. data/rdoc/lib/sprout/string_rb.html +52 -0
  134. data/rdoc/lib/sprout/system/base_system_rb.html +52 -0
  135. data/rdoc/lib/sprout/system/java_system_rb.html +52 -0
  136. data/rdoc/lib/sprout/system/osx_system_rb.html +52 -0
  137. data/rdoc/lib/sprout/system/unix_system_rb.html +52 -0
  138. data/rdoc/lib/sprout/system/vista_system_rb.html +52 -0
  139. data/rdoc/lib/sprout/system/win_nix_system_rb.html +52 -0
  140. data/rdoc/lib/sprout/system/win_system_rb.html +52 -0
  141. data/rdoc/lib/sprout/system_rb.html +66 -0
  142. data/rdoc/lib/sprout/test/sprout_test_case_rb.html +57 -0
  143. data/rdoc/lib/sprout/version_rb.html +52 -0
  144. data/rdoc/lib/sprout_rb.html +54 -0
  145. data/rdoc/rdoc.css +706 -0
  146. data/test/fixtures/executable/mxmlc.rb +2 -2
  147. data/test/unit/executable_test.rb +13 -0
  148. data/test/unit/generator_test.rb +25 -2
  149. metadata +144 -3
data/rdoc/Sprout/RDocParser.html ADDED
@@ -0,0 +1,702 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
+
8
+ <title>Class: Sprout::RDocParser</title>
9
+
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="../js/jquery.js" type="text/javascript"
13
+ charset="utf-8"></script>
14
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
15
+ charset="utf-8"></script>
16
+ <script src="../js/quicksearch.js" type="text/javascript"
17
+ charset="utf-8"></script>
18
+ <script src="../js/darkfish.js" type="text/javascript"
19
+ charset="utf-8"></script>
20
+
21
+ </head>
22
+ <body class="class">
23
+
24
+ <div id="metadata">
25
+ <div id="home-metadata">
26
+ <div id="home-section" class="section">
27
+ <h3 class="section-header">
28
+ <a href="../index.html">Home</a>
29
+ <a href="../index.html#classes">Classes</a>
30
+ <a href="../index.html#methods">Methods</a>
31
+ </h3>
32
+ </div>
33
+ </div>
34
+
35
+ <div id="file-metadata">
36
+ <div id="file-list-section" class="section">
37
+ <h3 class="section-header">In Files</h3>
38
+ <div class="section-body">
39
+ <ul>
40
+
41
+ <li><a href="../lib/sprout/rdoc_parser_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
+ class="thickbox" title="lib/sprout/rdoc_parser.rb">lib/sprout/rdoc_parser.rb</a></li>
43
+
44
+ </ul>
45
+ </div>
46
+ </div>
47
+
48
+
49
+ </div>
50
+
51
+ <div id="class-metadata">
52
+
53
+ <!-- Parent Class -->
54
+
55
+ <div id="parent-class-section" class="section">
56
+ <h3 class="section-header">Parent</h3>
57
+
58
+ <p class="link"><a href="../Object.html">Object</a></p>
59
+
60
+ </div>
61
+
62
+
63
+ <!-- Namespace Contents -->
64
+
65
+
66
+ <!-- Method Quickref -->
67
+
68
+ <div id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+ <ul class="link-list">
71
+
72
+ <li><a href="#method-i-class_name_from_caller_string">#class_name_from_caller_string</a></li>
73
+
74
+ <li><a href="#method-i-parse">#parse</a></li>
75
+
76
+ <li><a href="#method-i-parse_caller_string">#parse_caller_string</a></li>
77
+
78
+ <li><a href="#method-i-parse_from_caller_string">#parse_from_caller_string</a></li>
79
+
80
+ <li><a href="#method-i-rdoc_description_for">#rdoc_description_for</a></li>
81
+
82
+ <li><a href="#method-i-render_rdoc">#render_rdoc</a></li>
83
+
84
+ <li><a href="#method-i-render_rdoc_bak">#render_rdoc_bak</a></li>
85
+
86
+ <li><a href="#method-i-render_rdoc_from_files">#render_rdoc_from_files</a></li>
87
+
88
+ <li><a href="#method-i-render_rdoc_toplevel">#render_rdoc_toplevel</a></li>
89
+
90
+ <li><a href="#method-i-rendered_rdoc">#rendered_rdoc</a></li>
91
+
92
+ </ul>
93
+ </div>
94
+
95
+
96
+ <!-- Included Modules -->
97
+
98
+ </div>
99
+
100
+ <div id="project-metadata">
101
+
102
+
103
+
104
+ <div id="classindex-section" class="section project-section">
105
+ <h3 class="section-header">Class Index
106
+ <span class="search-toggle"><img src="../images/find.png"
107
+ height="16" width="16" alt="[+]"
108
+ title="show/hide quicksearch" /></span></h3>
109
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
110
+ <fieldset>
111
+ <legend>Quicksearch</legend>
112
+ <input type="text" name="quicksearch" value=""
113
+ class="quicksearch-field" />
114
+ </fieldset>
115
+ </form>
116
+
117
+ <ul class="link-list">
118
+
119
+ <li><a href="../Sprout/ArchiveUnpacker.html">Sprout::ArchiveUnpacker</a></li>
120
+
121
+ <li><a href="../Sprout/Base.html">Sprout::Base</a></li>
122
+
123
+ <li><a href="../Sprout/Base/ClassMethods.html">Sprout::Base::ClassMethods</a></li>
124
+
125
+ <li><a href="../Sprout/Concern.html">Sprout::Concern</a></li>
126
+
127
+ <li><a href="../Sprout/Errors.html">Sprout::Errors</a></li>
128
+
129
+ <li><a href="../Sprout/Errors/ArchiveUnpackerError.html">Sprout::Errors::ArchiveUnpackerError</a></li>
130
+
131
+ <li><a href="../Sprout/Errors/DestinationExistsError.html">Sprout::Errors::DestinationExistsError</a></li>
132
+
133
+ <li><a href="../Sprout/Errors/DuplicateMemberError.html">Sprout::Errors::DuplicateMemberError</a></li>
134
+
135
+ <li><a href="../Sprout/Errors/ExecutableError.html">Sprout::Errors::ExecutableError</a></li>
136
+
137
+ <li><a href="../Sprout/Errors/ExecutableRegistrationError.html">Sprout::Errors::ExecutableRegistrationError</a></li>
138
+
139
+ <li><a href="../Sprout/Errors/ExecutionError.html">Sprout::Errors::ExecutionError</a></li>
140
+
141
+ <li><a href="../Sprout/Errors/GeneratorError.html">Sprout::Errors::GeneratorError</a></li>
142
+
143
+ <li><a href="../Sprout/Errors/InvalidArgumentError.html">Sprout::Errors::InvalidArgumentError</a></li>
144
+
145
+ <li><a href="../Sprout/Errors/LoadError.html">Sprout::Errors::LoadError</a></li>
146
+
147
+ <li><a href="../Sprout/Errors/MissingArgumentError.html">Sprout::Errors::MissingArgumentError</a></li>
148
+
149
+ <li><a href="../Sprout/Errors/MissingExecutableError.html">Sprout::Errors::MissingExecutableError</a></li>
150
+
151
+ <li><a href="../Sprout/Errors/MissingGeneratorError.html">Sprout::Errors::MissingGeneratorError</a></li>
152
+
153
+ <li><a href="../Sprout/Errors/MissingTemplateError.html">Sprout::Errors::MissingTemplateError</a></li>
154
+
155
+ <li><a href="../Sprout/Errors/ProcessRunnerError.html">Sprout::Errors::ProcessRunnerError</a></li>
156
+
157
+ <li><a href="../Sprout/Errors/RemoteFileLoaderError.html">Sprout::Errors::RemoteFileLoaderError</a></li>
158
+
159
+ <li><a href="../Sprout/Errors/SproutError.html">Sprout::Errors::SproutError</a></li>
160
+
161
+ <li><a href="../Sprout/Errors/UnknownArchiveType.html">Sprout::Errors::UnknownArchiveType</a></li>
162
+
163
+ <li><a href="../Sprout/Errors/UsageError.html">Sprout::Errors::UsageError</a></li>
164
+
165
+ <li><a href="../Sprout/Errors/ValidationError.html">Sprout::Errors::ValidationError</a></li>
166
+
167
+ <li><a href="../Sprout/Errors/VersionRequirementNotMetError.html">Sprout::Errors::VersionRequirementNotMetError</a></li>
168
+
169
+ <li><a href="../Sprout/Executable.html">Sprout::Executable</a></li>
170
+
171
+ <li><a href="../Sprout/Executable/Boolean.html">Sprout::Executable::Boolean</a></li>
172
+
173
+ <li><a href="../Sprout/Executable/ClassMethods.html">Sprout::Executable::ClassMethods</a></li>
174
+
175
+ <li><a href="../Sprout/Executable/CollectionParam.html">Sprout::Executable::CollectionParam</a></li>
176
+
177
+ <li><a href="../Sprout/Executable/FileParam.html">Sprout::Executable::FileParam</a></li>
178
+
179
+ <li><a href="../Sprout/Executable/Files.html">Sprout::Executable::Files</a></li>
180
+
181
+ <li><a href="../Sprout/Executable/InstanceMethods.html">Sprout::Executable::InstanceMethods</a></li>
182
+
183
+ <li><a href="../Sprout/Executable/Number.html">Sprout::Executable::Number</a></li>
184
+
185
+ <li><a href="../Sprout/Executable/Param.html">Sprout::Executable::Param</a></li>
186
+
187
+ <li><a href="../Sprout/Executable/ParameterFactory.html">Sprout::Executable::ParameterFactory</a></li>
188
+
189
+ <li><a href="../Sprout/Executable/Path.html">Sprout::Executable::Path</a></li>
190
+
191
+ <li><a href="../Sprout/Executable/Paths.html">Sprout::Executable::Paths</a></li>
192
+
193
+ <li><a href="../Sprout/Executable/StringParam.html">Sprout::Executable::StringParam</a></li>
194
+
195
+ <li><a href="../Sprout/Executable/Strings.html">Sprout::Executable::Strings</a></li>
196
+
197
+ <li><a href="../Sprout/Executable/Url.html">Sprout::Executable::Url</a></li>
198
+
199
+ <li><a href="../Sprout/Executable/Urls.html">Sprout::Executable::Urls</a></li>
200
+
201
+ <li><a href="../Sprout/FileTarget.html">Sprout::FileTarget</a></li>
202
+
203
+ <li><a href="../Sprout/Generator.html">Sprout::Generator</a></li>
204
+
205
+ <li><a href="../Sprout/Generator/Base.html">Sprout::Generator::Base</a></li>
206
+
207
+ <li><a href="../Sprout/Generator/Command.html">Sprout::Generator::Command</a></li>
208
+
209
+ <li><a href="../Sprout/Generator/DirectoryManifest.html">Sprout::Generator::DirectoryManifest</a></li>
210
+
211
+ <li><a href="../Sprout/Generator/FileManifest.html">Sprout::Generator::FileManifest</a></li>
212
+
213
+ <li><a href="../Sprout/Generator/Manifest.html">Sprout::Generator::Manifest</a></li>
214
+
215
+ <li><a href="../Sprout/Generator/TemplateManifest.html">Sprout::Generator::TemplateManifest</a></li>
216
+
217
+ <li><a href="../Sprout/GeneratorGenerator.html">Sprout::GeneratorGenerator</a></li>
218
+
219
+ <li><a href="../Sprout/Library.html">Sprout::Library</a></li>
220
+
221
+ <li><a href="../Sprout/LibraryGenerator.html">Sprout::LibraryGenerator</a></li>
222
+
223
+ <li><a href="../Sprout/Platform.html">Sprout::Platform</a></li>
224
+
225
+ <li><a href="../Sprout/ProcessRunner.html">Sprout::ProcessRunner</a></li>
226
+
227
+ <li><a href="../Sprout/RDocParser.html">Sprout::RDocParser</a></li>
228
+
229
+ <li><a href="../Sprout/RemoteFileLoader.html">Sprout::RemoteFileLoader</a></li>
230
+
231
+ <li><a href="../Sprout/RemoteFileTarget.html">Sprout::RemoteFileTarget</a></li>
232
+
233
+ <li><a href="../Sprout/RubyFeature.html">Sprout::RubyFeature</a></li>
234
+
235
+ <li><a href="../Sprout/RubyFeature/ClassMethods.html">Sprout::RubyFeature::ClassMethods</a></li>
236
+
237
+ <li><a href="../Sprout/RubyGenerator.html">Sprout::RubyGenerator</a></li>
238
+
239
+ <li><a href="../Sprout/Specification.html">Sprout::Specification</a></li>
240
+
241
+ <li><a href="../Sprout/System.html">Sprout::System</a></li>
242
+
243
+ <li><a href="../Sprout/System/BaseSystem.html">Sprout::System::BaseSystem</a></li>
244
+
245
+ <li><a href="../Sprout/System/JavaSystem.html">Sprout::System::JavaSystem</a></li>
246
+
247
+ <li><a href="../Sprout/System/OSXSystem.html">Sprout::System::OSXSystem</a></li>
248
+
249
+ <li><a href="../Sprout/System/UnixSystem.html">Sprout::System::UnixSystem</a></li>
250
+
251
+ <li><a href="../Sprout/System/VistaSystem.html">Sprout::System::VistaSystem</a></li>
252
+
253
+ <li><a href="../Sprout/System/WinNixSystem.html">Sprout::System::WinNixSystem</a></li>
254
+
255
+ <li><a href="../Sprout/System/WinSystem.html">Sprout::System::WinSystem</a></li>
256
+
257
+ <li><a href="../Sprout/ToolGenerator.html">Sprout::ToolGenerator</a></li>
258
+
259
+ <li><a href="../<.html"><</a></li>
260
+
261
+ <li><a href="../Dir.html">Dir</a></li>
262
+
263
+ <li><a href="../Object.html">Object</a></li>
264
+
265
+ <li><a href="../String.html">String</a></li>
266
+
267
+ </ul>
268
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
269
+ </div>
270
+
271
+
272
+ </div>
273
+ </div>
274
+
275
+ <div id="documentation">
276
+ <h1 class="class">Sprout::RDocParser</h1>
277
+
278
+ <div id="description">
279
+
280
+ </div>
281
+
282
+ <!-- Constants -->
283
+
284
+
285
+ <!-- Attributes -->
286
+
287
+
288
+ <!-- Methods -->
289
+
290
+ <div id="public-instance-method-details" class="method-section section">
291
+ <h3 class="section-header">Public Instance Methods</h3>
292
+
293
+
294
+ <div id="parse-method" class="method-detail ">
295
+ <a name="method-i-parse"></a>
296
+
297
+ <div class="method-heading">
298
+
299
+ <span class="method-name">parse</span><span
300
+ class="method-args">(content)</span>
301
+ <span class="method-click-advice">click to toggle source</span>
302
+
303
+ </div>
304
+
305
+ <div class="method-description">
306
+
307
+
308
+
309
+
310
+
311
+ <div class="method-source-code"
312
+ id="parse-source">
313
+ <pre>
314
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 7</span>
315
+ 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span> <span class="ruby-identifier">content</span>
316
+ 8: <span class="ruby-keyword kw">end</span></pre>
317
+ </div>
318
+
319
+ </div>
320
+
321
+
322
+
323
+
324
+ </div>
325
+
326
+
327
+ <div id="parse-from-caller-string-method" class="method-detail ">
328
+ <a name="method-i-parse_from_caller_string"></a>
329
+
330
+ <div class="method-heading">
331
+
332
+ <span class="method-name">parse_from_caller_string</span><span
333
+ class="method-args">(caller_string)</span>
334
+ <span class="method-click-advice">click to toggle source</span>
335
+
336
+ </div>
337
+
338
+ <div class="method-description">
339
+
340
+
341
+
342
+
343
+
344
+ <div class="method-source-code"
345
+ id="parse-from-caller-string-source">
346
+ <pre>
347
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 10</span>
348
+ 10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_from_caller_string</span> <span class="ruby-identifier">caller_string</span>
349
+ 11: <span class="ruby-identifier">class_name</span>, <span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">line_number</span> = <span class="ruby-identifier">parse_caller_string</span> <span class="ruby-identifier">caller_string</span>
350
+ 12: <span class="ruby-identifier">rdoc_description_for</span> <span class="ruby-identifier">class_name</span>, <span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">line_number</span>
351
+ 13: <span class="ruby-keyword kw">end</span></pre>
352
+ </div>
353
+
354
+ </div>
355
+
356
+
357
+
358
+
359
+ </div>
360
+
361
+
362
+ </div>
363
+
364
+ <div id="private-instance-method-details" class="method-section section">
365
+ <h3 class="section-header">Private Instance Methods</h3>
366
+
367
+
368
+ <div id="class-name-from-caller-string-method" class="method-detail ">
369
+ <a name="method-i-class_name_from_caller_string"></a>
370
+
371
+ <div class="method-heading">
372
+
373
+ <span class="method-name">class_name_from_caller_string</span><span
374
+ class="method-args">(caller_string)</span>
375
+ <span class="method-click-advice">click to toggle source</span>
376
+
377
+ </div>
378
+
379
+ <div class="method-description">
380
+
381
+
382
+
383
+
384
+
385
+ <div class="method-source-code"
386
+ id="class-name-from-caller-string-source">
387
+ <pre>
388
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 29</span>
389
+ 29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">class_name_from_caller_string</span> <span class="ruby-identifier">caller_string</span>
390
+ 30: <span class="ruby-identifier">parts</span> = <span class="ruby-identifier">caller_string</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">' '</span>)
391
+ 31: <span class="ruby-identifier">long</span> = <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">pop</span>
392
+ 32: <span class="ruby-identifier">matched</span> = <span class="ruby-identifier">long</span>.<span class="ruby-identifier">match</span> <span class="ruby-regexp re">/&lt;class:([\w:]+)&gt;/</span>
393
+ 33: <span class="ruby-identifier">matched</span>[<span class="ruby-value">1</span>] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">matched</span>.<span class="ruby-identifier">nil?</span>
394
+ 34: <span class="ruby-keyword kw">end</span></pre>
395
+ </div>
396
+
397
+ </div>
398
+
399
+
400
+
401
+
402
+ </div>
403
+
404
+
405
+ <div id="parse-caller-string-method" class="method-detail ">
406
+ <a name="method-i-parse_caller_string"></a>
407
+
408
+ <div class="method-heading">
409
+
410
+ <span class="method-name">parse_caller_string</span><span
411
+ class="method-args">(caller_string)</span>
412
+ <span class="method-click-advice">click to toggle source</span>
413
+
414
+ </div>
415
+
416
+ <div class="method-description">
417
+
418
+ <p>
419
+ NOTE: Don&#8217;t forget that this string <b>sometimes</b> contains a colon
420
+ on Windows&#8230;
421
+ </p>
422
+
423
+
424
+
425
+ <div class="method-source-code"
426
+ id="parse-caller-string-source">
427
+ <pre>
428
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 19</span>
429
+ 19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_caller_string</span> <span class="ruby-identifier">caller_string</span>
430
+ 20: <span class="ruby-identifier">sections</span> = <span class="ruby-identifier">caller_string</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">' '</span>)
431
+ 21: <span class="ruby-identifier">parts</span> = <span class="ruby-identifier">sections</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">':'</span>)
432
+ 22: <span class="ruby-identifier">file_name</span> = <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">shift</span>
433
+ 23: <span class="ruby-identifier">line_number</span> = <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">shift</span>
434
+ 24: <span class="ruby-identifier">class_name</span> = <span class="ruby-identifier">class_name_from_caller_string</span> <span class="ruby-identifier">caller_string</span>
435
+ 25: <span class="ruby-comment cmt">#puts &quot;&gt;&gt; class_name: #{class_name} file_name: #{file_name} line_number: #{line_number}&quot;</span>
436
+ 26: [<span class="ruby-identifier">class_name</span>, <span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">line_number</span>]
437
+ 27: <span class="ruby-keyword kw">end</span></pre>
438
+ </div>
439
+
440
+ </div>
441
+
442
+
443
+
444
+
445
+ </div>
446
+
447
+
448
+ <div id="rdoc-description-for-method" class="method-detail ">
449
+ <a name="method-i-rdoc_description_for"></a>
450
+
451
+ <div class="method-heading">
452
+
453
+ <span class="method-name">rdoc_description_for</span><span
454
+ class="method-args">(class_name, file_name, line_number)</span>
455
+ <span class="method-click-advice">click to toggle source</span>
456
+
457
+ </div>
458
+
459
+ <div class="method-description">
460
+
461
+
462
+
463
+
464
+
465
+ <div class="method-source-code"
466
+ id="rdoc-description-for-source">
467
+ <pre>
468
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 36</span>
469
+ 36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rdoc_description_for</span> <span class="ruby-identifier">class_name</span>, <span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">line_number</span>
470
+ 37: <span class="ruby-identifier">rendered</span> = <span class="ruby-identifier">rendered_rdoc</span> <span class="ruby-identifier">file_name</span>
471
+ 38: <span class="ruby-keyword kw">end</span></pre>
472
+ </div>
473
+
474
+ </div>
475
+
476
+
477
+
478
+
479
+ </div>
480
+
481
+
482
+ <div id="render-rdoc-method" class="method-detail ">
483
+ <a name="method-i-render_rdoc"></a>
484
+
485
+ <div class="method-heading">
486
+
487
+ <span class="method-name">render_rdoc</span><span
488
+ class="method-args">(file)</span>
489
+ <span class="method-click-advice">click to toggle source</span>
490
+
491
+ </div>
492
+
493
+ <div class="method-description">
494
+
495
+
496
+
497
+
498
+
499
+ <div class="method-source-code"
500
+ id="render-rdoc-source">
501
+ <pre>
502
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 44</span>
503
+ 44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">render_rdoc</span> <span class="ruby-identifier">file</span>
504
+ 45: <span class="ruby-identifier">rdoc</span> = <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">RDoc</span>.<span class="ruby-identifier">new</span>
505
+ 46: <span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;===================================&quot;</span>
506
+ 47: <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;&gt;&gt; generating rdoc for: #{file}&quot;</span>
507
+ 48:
508
+ 49: <span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">document</span> [ <span class="ruby-identifier">file</span>, <span class="ruby-value str">&quot;--format=xml&quot;</span>, <span class="ruby-value str">&quot;--output=temp&quot;</span> ]
509
+ 50: {}
510
+ 51: <span class="ruby-keyword kw">end</span></pre>
511
+ </div>
512
+
513
+ </div>
514
+
515
+
516
+
517
+
518
+ </div>
519
+
520
+
521
+ <div id="render-rdoc-bak-method" class="method-detail ">
522
+ <a name="method-i-render_rdoc_bak"></a>
523
+
524
+ <div class="method-heading">
525
+
526
+ <span class="method-name">render_rdoc_bak</span><span
527
+ class="method-args">(file)</span>
528
+ <span class="method-click-advice">click to toggle source</span>
529
+
530
+ </div>
531
+
532
+ <div class="method-description">
533
+
534
+
535
+
536
+
537
+
538
+ <div class="method-source-code"
539
+ id="render-rdoc-bak-source">
540
+ <pre>
541
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 84</span>
542
+ 84: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">render_rdoc_bak</span> <span class="ruby-identifier">file</span>
543
+ 85: <span class="ruby-identifier">rdoc</span> = <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">RDoc</span>.<span class="ruby-identifier">new</span>
544
+ 86: <span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">options</span> = <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">Options</span>.<span class="ruby-identifier">new</span>
545
+ 87: <span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">parse_files</span> [<span class="ruby-identifier">file</span>]
546
+ 88: <span class="ruby-keyword kw">end</span></pre>
547
+ </div>
548
+
549
+ </div>
550
+
551
+
552
+
553
+
554
+ </div>
555
+
556
+
557
+ <div id="render-rdoc-from-files-method" class="method-detail ">
558
+ <a name="method-i-render_rdoc_from_files"></a>
559
+
560
+ <div class="method-heading">
561
+
562
+ <span class="method-name">render_rdoc_from_files</span><span
563
+ class="method-args">()</span>
564
+ <span class="method-click-advice">click to toggle source</span>
565
+
566
+ </div>
567
+
568
+ <div class="method-description">
569
+
570
+
571
+
572
+
573
+
574
+ <div class="method-source-code"
575
+ id="render-rdoc-from-files-source">
576
+ <pre>
577
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 53</span>
578
+ 53: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">render_rdoc_from_files</span>
579
+ 54: <span class="ruby-comment cmt"># This works to some extent...</span>
580
+ 55: <span class="ruby-comment cmt">#rdoc test/fixtures/examples/echo_inputs.rb --fmt=xml --op=tmp --all -q</span>
581
+ 56: <span class="ruby-comment cmt"># But the following does not do the same thing:</span>
582
+ 57: <span class="ruby-comment cmt">#response = rdoc.document [ file, '--fmt=xml', '--op=tmp', '--all', '-q' ]</span>
583
+ 58:
584
+ 59: <span class="ruby-identifier">options</span> = <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">Options</span>.<span class="ruby-identifier">new</span>
585
+ 60: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">files</span> = <span class="ruby-constant">FileList</span>[ <span class="ruby-identifier">file</span> ]
586
+ 61: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">formatter</span> = <span class="ruby-value str">'markup'</span>
587
+ 62: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">op_dir</span> = <span class="ruby-value str">'./tmp'</span>
588
+ 63: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">verbosity</span> = <span class="ruby-value">0</span>
589
+ 64:
590
+ 65: <span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">options</span> = <span class="ruby-identifier">options</span>
591
+ 66:
592
+ 67: <span class="ruby-comment cmt">#rdoc.stats = RDoc::Stats.new 1, options.verbosity</span>
593
+ 68: <span class="ruby-comment cmt">#response = rdoc.document []</span>
594
+ 69:
595
+ 70: <span class="ruby-identifier">response</span> = <span class="ruby-identifier">rdoc</span>.<span class="ruby-identifier">parse_files</span> [ <span class="ruby-identifier">file</span> ]
596
+ 71: <span class="ruby-identifier">render_rdoc_toplevel</span> <span class="ruby-identifier">response</span>
597
+ 72: <span class="ruby-keyword kw">end</span></pre>
598
+ </div>
599
+
600
+ </div>
601
+
602
+
603
+
604
+
605
+ </div>
606
+
607
+
608
+ <div id="render-rdoc-toplevel-method" class="method-detail ">
609
+ <a name="method-i-render_rdoc_toplevel"></a>
610
+
611
+ <div class="method-heading">
612
+
613
+ <span class="method-name">render_rdoc_toplevel</span><span
614
+ class="method-args">(toplevel)</span>
615
+ <span class="method-click-advice">click to toggle source</span>
616
+
617
+ </div>
618
+
619
+ <div class="method-description">
620
+
621
+
622
+
623
+
624
+
625
+ <div class="method-source-code"
626
+ id="render-rdoc-toplevel-source">
627
+ <pre>
628
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 74</span>
629
+ 74: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">render_rdoc_toplevel</span> <span class="ruby-identifier">toplevel</span>
630
+ 75: <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;&gt;&gt; toplevel: #{toplevel}&quot;</span>
631
+ 76: <span class="ruby-identifier">toplevel</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
632
+ 77: <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;&gt;&gt; file: #{file.name}&quot;</span>
633
+ 78: <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;&gt;&gt; pretty: #{file.pretty_print}&quot;</span>
634
+ 79: <span class="ruby-keyword kw">end</span>
635
+ 80:
636
+ 81: <span class="ruby-identifier">toplevel</span>
637
+ 82: <span class="ruby-keyword kw">end</span></pre>
638
+ </div>
639
+
640
+ </div>
641
+
642
+
643
+
644
+
645
+ </div>
646
+
647
+
648
+ <div id="rendered-rdoc-method" class="method-detail ">
649
+ <a name="method-i-rendered_rdoc"></a>
650
+
651
+ <div class="method-heading">
652
+
653
+ <span class="method-name">rendered_rdoc</span><span
654
+ class="method-args">(file)</span>
655
+ <span class="method-click-advice">click to toggle source</span>
656
+
657
+ </div>
658
+
659
+ <div class="method-description">
660
+
661
+
662
+
663
+
664
+
665
+ <div class="method-source-code"
666
+ id="rendered-rdoc-source">
667
+ <pre>
668
+ <span class="ruby-comment cmt"># File lib/sprout/rdoc_parser.rb, line 40</span>
669
+ 40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rendered_rdoc</span> <span class="ruby-identifier">file</span>
670
+ 41: <span class="ruby-ivar">@rendered_rdoc</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">render_rdoc</span> <span class="ruby-identifier">file</span>
671
+ 42: <span class="ruby-keyword kw">end</span></pre>
672
+ </div>
673
+
674
+ </div>
675
+
676
+
677
+
678
+
679
+ </div>
680
+
681
+
682
+ </div>
683
+
684
+
685
+ </div>
686
+
687
+
688
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
689
+
690
+ <p>Disabled; run with --debug to generate this.</p>
691
+
692
+ </div>
693
+
694
+ <div id="validator-badges">
695
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
696
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
697
+ Rdoc Generator</a> 1.1.6</small>.</p>
698
+ </div>
699
+
700
+ </body>
701
+ </html>
702
+