Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 559 lines (435 sloc) 25.562 kb
7afd7e9 @lsegal Update README formatting
authored
1 YARD: Yay! A Ruby Documentation Tool
2 ====================================
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
3
61e6769 @lsegal Bump version to 0.5.5
authored
4 **Homepage**: [http://yardoc.org](http://yardoc.org)
395b15f @lsegal Fix some markdown formatting errors
authored
5 **IRC**: [irc.freenode.net / #yard](irc://irc.freenode.net/yard)
61e6769 @lsegal Bump version to 0.5.5
authored
6 **Git**: [http://github.com/lsegal/yard](http://github.com/lsegal/yard)
7 **Author**: Loren Segal
2e95dd9 @lsegal Bump to version 0.5.8
authored
8 **Contributors**: See Contributors section below
737f561 @lsegal Change copyright year and version
authored
9 **Copyright**: 2007-2012
61e6769 @lsegal Bump version to 0.5.5
authored
10 **License**: MIT License
9e5a174 @lsegal Bump to 0.8.2.1
authored
11 **Latest Version**: 0.8.2.1 (codename "Shave It")
12 **Release Date**: June 10th 2012
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
13
7afd7e9 @lsegal Update README formatting
authored
14 Synopsis
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
15 --------
16
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
17 YARD is a documentation generation tool for the Ruby programming language.
18 It enables the user to generate consistent, usable documentation that can be
19 exported to a number of formats very easily, and also supports extending for
20 custom Ruby constructs such as custom class level definitions. Below is a
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
21 summary of some of YARD's notable features.
22
23
7afd7e9 @lsegal Update README formatting
authored
24 Feature List
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
25 ------------
fa147d9 @lsegal The great whitespace fix of 2012
authored
26
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
27 **1. RDoc/SimpleMarkup Formatting Compatibility**: YARD is made to be compatible
28 with RDoc formatting. In fact, YARD does no processing on RDoc documentation
29 strings, and leaves this up to the output generation tool to decide how to
30 render the documentation.
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
31
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
32 **2. Yardoc Meta-tag Formatting Like Python, Java, Objective-C and other languages**:
33 YARD uses a '@tag' style definition syntax for meta tags alongside regular code
34 documentation. These tags should be able to happily sit side by side RDoc formatted
35 documentation, but provide a much more consistent and usable way to describe
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
36 important information about objects, such as what parameters they take and what types
fa147d9 @lsegal The great whitespace fix of 2012
authored
37 they are expected to be, what type a method should return, what exceptions it can
38 raise, if it is deprecated, etc.. It also allows information to be better (and more
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
39 consistently) organized during the output generation phase. You can find a list
2164944 @lsegal Update file: links to point to docs/ for server compatibility
authored
40 of tags in the {file:docs/Tags.md#taglist Tags.md} file.
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
41
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
42 YARD also supports an optional "types" declarations for certain tags.
43 This allows the developer to document type signatures for ruby methods and
44 parameters in a non intrusive but helpful and consistent manner. Instead of
45 describing this data in the body of the description, a developer may formally
46 declare the parameter or return type(s) in a single line. Consider the
49ec039 @lsegal Sentence rewording
authored
47 following method documented with YARD formatting:
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
48
fa147d9 @lsegal The great whitespace fix of 2012
authored
49 # Reverses the contents of a String or IO object.
50 #
51 # @param [String, #read] contents the contents to reverse
52 # @return [String] the contents reversed lexically
53 def reverse(contents)
54 contents = contents.read if respond_to? :read
55 contents.reverse
379227a @lsegal Add support for syntax highlighting with new RubyParser AST
authored
56 end
fa147d9 @lsegal The great whitespace fix of 2012
authored
57
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
58 With the above @param tag, we learn that the contents parameter can either be
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
59 a String or any object that responds to the 'read' method, which is more
60 powerful than the textual description, which says it should be an IO object.
61 This also informs the developer that they should expect to receive a String
62 object returned by the method, and although this may be obvious for a
63 'reverse' method, it becomes very useful when the method name may not be as
64 descriptive.
fa147d9 @lsegal The great whitespace fix of 2012
authored
65
66 **3. Custom Constructs and Extensibility of YARD**: YARD is designed to be
67 extended and customized by plugins. Take for instance the scenario where you
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
68 need to document the following code:
fa147d9 @lsegal The great whitespace fix of 2012
authored
69
9b04160 @lsegal Fix some typos in readme
authored
70 class List
71 # Sets the publisher name for the list.
72 cattr_accessor :publisher
01461eb @lsegal Add getting started guide
authored
73 end
fa147d9 @lsegal The great whitespace fix of 2012
authored
74
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
75 This custom declaration provides dynamically generated code that is hard for a
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
76 documentation tool to properly document without help from the developer. To
77 ease the pains of manually documenting the procedure, YARD can be extended by
9b04160 @lsegal Fix some typos in readme
authored
78 the developer to handle the `cattr_accessor` construct and automatically create
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
79 an attribute on the class with the associated documentation. This makes
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
80 documenting external API's, especially dynamic ones, a lot more consistent for
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
81 consumption by the users.
9b04160 @lsegal Fix some typos in readme
authored
82
83 YARD is also designed for extensibility everywhere else, allowing you to add
84 support for new programming languages, new data structures and even where/how
85 data is stored.
fa147d9 @lsegal The great whitespace fix of 2012
authored
86
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
87 **4. Raw Data Output**: YARD also outputs documented objects as raw data (the
88 dumped Namespace) which can be reloaded to do generation at a later date, or
89 even auditing on code. This means that any developer can use the raw data to
90 perform output generation for any custom format, such as YAML, for instance.
91 While YARD plans to support XHTML style documentation output as well as
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
92 command line (text based) and possibly XML, this may still be useful for those
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
93 who would like to reap the benefits of YARD's processing in other forms, such
94 as throwing all the documentation into a database. Another useful way of
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
95 exploiting this raw data format would be to write tools that can auto generate
a9d98e0 @lsegal Get rid of those unicode characters in README
authored
96 test cases, for example, or show possible unhandled exceptions in code.
52b8234 @lsegal Add special installation instructions for some Ubuntu/Debian installa…
authored
97
9b04160 @lsegal Fix some typos in readme
authored
98 **5. Local Documentation Server**: YARD can serve documentation for projects
99 or installed gems (similar to `gem server`) with the added benefit of dynamic
100 searching, as well as live reloading. Using the live reload feature, you can
fa147d9 @lsegal The great whitespace fix of 2012
authored
101 document your code and immediately preview the results by refreshing the page;
102 YARD will do all the work in re-generating the HTML. This makes writing
9b04160 @lsegal Fix some typos in readme
authored
103 documentation a much faster process.
104
52b8234 @lsegal Add special installation instructions for some Ubuntu/Debian installa…
authored
105
737f561 @lsegal Change copyright year and version
authored
106 ## Installing
52b8234 @lsegal Add special installation instructions for some Ubuntu/Debian installa…
authored
107
108 To install YARD, use the following command:
109
110 $ gem install yard
fa147d9 @lsegal The great whitespace fix of 2012
authored
111
52b8234 @lsegal Add special installation instructions for some Ubuntu/Debian installa…
authored
112 (Add `sudo` if you're installing under a POSIX system as root)
fa147d9 @lsegal The great whitespace fix of 2012
authored
113
114 Alternatively, if you've checked the source out directly, you can call
52b8234 @lsegal Add special installation instructions for some Ubuntu/Debian installa…
authored
115 `rake install` from the root project directory.
116
117 **Important Note for Debian/Ubuntu users:** there's a possible chance your Ruby
fa147d9 @lsegal The great whitespace fix of 2012
authored
118 install lacks RDoc, which is occasionally used by YARD to convert markup to HTML.
52b8234 @lsegal Add special installation instructions for some Ubuntu/Debian installa…
authored
119 If running `which rdoc` turns up empty, install RDoc by issuing:
120
121 $ sudo apt-get install rdoc
fa147d9 @lsegal The great whitespace fix of 2012
authored
122
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
123
737f561 @lsegal Change copyright year and version
authored
124 ## Usage
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
125
126 There are a couple of ways to use YARD. The first is via command-line, and the
fa147d9 @lsegal The great whitespace fix of 2012
authored
127 second is the Rake task.
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
128
103a10e @lsegal Update README for 0.6.0 release
authored
129 **1. yard Command-line Tool**
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
130
103a10e @lsegal Update README for 0.6.0 release
authored
131 YARD comes packaged with a executable named `yard` which can control the many
132 functions of YARD, including generating documentation, graphs running the
133 YARD server, and so on. To view a list of available YARD commands, type:
134
135 $ yard --help
fa147d9 @lsegal The great whitespace fix of 2012
authored
136
103a10e @lsegal Update README for 0.6.0 release
authored
137 Plugins can also add commands to the `yard` executable to provide extra
138 functionality.
139
d624990 @lsegal Fix formatting in readme / doc files
authored
140 ### Generating Documentation
103a10e @lsegal Update README for 0.6.0 release
authored
141
142 <span class="note">The `yardoc` executable is a shortcut for `yard doc`.</span>
143
fa147d9 @lsegal The great whitespace fix of 2012
authored
144 The most common command you will probably use is `yard doc`, or `yardoc`. You
145 can type `yardoc --help` to see the options that YARD provides, but the
146 easiest way to generate docs for your code is to simply type `yardoc` in your
103a10e @lsegal Update README for 0.6.0 release
authored
147 project root. This will assume your files are
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
148 located in the `lib/` directory. If they are located elsewhere, you can specify
149 paths and globs from the commandline via:
150
01461eb @lsegal Add getting started guide
authored
151 $ yardoc 'lib/**/*.rb' 'app/**/*.rb' ...etc...
fa147d9 @lsegal The great whitespace fix of 2012
authored
152
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
153 The tool will generate a `.yardoc` file which will store the cached database
154 of your source code and documentation. If you want to re-generate your docs
fa147d9 @lsegal The great whitespace fix of 2012
authored
155 with another template you can simply use the `--use-cache` (or -c)
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
156 option to speed up the generation process by skipping source parsing.
157
158 YARD will by default only document code in your public visibility. You can
159 document your protected and private code by adding `--protected` or
aee74c6 @lsegal Update docs to reflect new YARD behaviours
authored
160 `--private` to the option switches. In addition, you can add `--no-private`
161 to also ignore any object that has the `@private` meta-tag. This is similar
162 to RDoc's ":nodoc:" behaviour, though the distinction is important. RDoc
163 implies that the object with :nodoc: would not be documented, whereas
164 YARD still recommends documenting private objects for the private API (for
165 maintainer/developer consumption).
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
166
aee74c6 @lsegal Update docs to reflect new YARD behaviours
authored
167 You can also add extra informative files (README, LICENSE) by separating
168 the globs and the filenames with '-'.
01461eb @lsegal Add getting started guide
authored
169
aee74c6 @lsegal Update docs to reflect new YARD behaviours
authored
170 $ yardoc 'app/**/*.rb' - README LICENSE FAQ
fa147d9 @lsegal The great whitespace fix of 2012
authored
171
4d46cf3 fix a typo.
yuta yamada authored
172 If no globs precede the '-' argument, the default glob (`lib/**/*.rb`) is
aee74c6 @lsegal Update docs to reflect new YARD behaviours
authored
173 used:
01461eb @lsegal Add getting started guide
authored
174
aee74c6 @lsegal Update docs to reflect new YARD behaviours
authored
175 $ yardoc - README LICENSE FAQ
176
177 Note that the README file can be specified with its own `--readme` switch.
01461eb @lsegal Add getting started guide
authored
178
179 You can also add a `.yardopts` file to your project directory which lists
fa147d9 @lsegal The great whitespace fix of 2012
authored
180 the switches separated by whitespace (newlines or space) to pass to yardoc
1b8581f @lsegal Tell users where to read information about .yardopts
authored
181 whenever it is run. A full overview of the `.yardopts` file can be found in
182 {YARD::CLI::Yardoc}.
01461eb @lsegal Add getting started guide
authored
183
d624990 @lsegal Fix formatting in readme / doc files
authored
184 ### Queries
abeac7d @lsegal Document new --query parameter
authored
185
186 The `yardoc` tool also supports a `--query` argument to only include objects
187 that match a certain data or meta-data query. The query syntax is Ruby, though
188 a few shortcuts are available. For instance, to document only objects that have
189 an "@api" tag with the value "public", all of the following syntaxes would give
190 the same result:
191
192 --query '@api.text == "public"'
193 --query 'object.has_tag?(:api) && object.tag(:api).text == "public"'
194 --query 'has_tag?(:api) && tag(:api).text == "public"'
195
fa147d9 @lsegal The great whitespace fix of 2012
authored
196 Note that the "@tag" syntax returns the first tag named "tag" on the object.
abeac7d @lsegal Document new --query parameter
authored
197 To return the array of all tags named "tag", use "@@tag".
fa147d9 @lsegal The great whitespace fix of 2012
authored
198
abeac7d @lsegal Document new --query parameter
authored
199 Multiple `--query` arguments are allowed in the command line parameters. The
200 following two lines both check for the existence of a return and param tag:
201
202 --query '@return' --query '@param'
ceed0a8 @jellybob Fix a type in the query documentation.
jellybob authored
203 --query '@return && @param'
fa147d9 @lsegal The great whitespace fix of 2012
authored
204
abeac7d @lsegal Document new --query parameter
authored
205 For more information about the query syntax, see the {YARD::Verifier} class.
206
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
207 **2. Rake Task**
208
fa147d9 @lsegal The great whitespace fix of 2012
authored
209 The second most obvious is to generate docs via a Rake task. You can do this by
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
210 adding the following to your `Rakefile`:
211
01461eb @lsegal Add getting started guide
authored
212 YARD::Rake::YardocTask.new do |t|
213 t.files = ['lib/**/*.rb', OTHER_PATHS] # optional
214 t.options = ['--any', '--extra', '--opts'] # optional
215 end
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
216
217 both the `files` and `options` settings are optional. `files` will default to
218 `lib/**/*.rb` and `options` will represents any options you might want
219 to add. Again, a full list of options is available by typing `yardoc --help`
220 in a shell. You can also override the options at the Rake command-line with the
221 OPTS environment variable:
222
aee74c6 @lsegal Update docs to reflect new YARD behaviours
authored
223 $ rake yard OPTS='--any --extra --opts'
fa147d9 @lsegal The great whitespace fix of 2012
authored
224
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
225 **3. `yri` RI Implementation**
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
226
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
227 The yri binary will use the cached .yardoc database to give you quick ri-style
228 access to your documentation. It's way faster than ri but currently does not
229 work with the stdlib or core Ruby libraries, only the active project. Example:
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
230
01461eb @lsegal Add getting started guide
authored
231 $ yri YARD::Handlers::Base#register
abeac7d @lsegal Document new --query parameter
authored
232 $ yri File.relative_path
fa147d9 @lsegal The great whitespace fix of 2012
authored
233
234 Note that class methods must not be referred to with the "::" namespace
abeac7d @lsegal Document new --query parameter
authored
235 separator. Only modules, classes and constants should use "::".
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
236
303d15e @lsegal Bump version to 0.5.0
authored
237 You can also do lookups on any installed gems. Just make sure to build the
238 .yardoc databases for installed gems with:
239
acd0fcf @lsegal Fix yardoc --build gems command
authored
240 $ sudo yard gems
fa147d9 @lsegal The great whitespace fix of 2012
authored
241
303d15e @lsegal Bump version to 0.5.0
authored
242 If you don't have sudo access, it will write these files to your `~/.yard`
243 directory. `yri` will also cache lookups there.
244
8849af3 @lsegal Add info on yard server command
authored
245 **4. `yard server` Documentation Server**
246
247 The `yard server` command serves documentation for a local project or all installed
248 RubyGems. To serve documentation for a project you are working on, simply run:
249
250 $ yard server
fa147d9 @lsegal The great whitespace fix of 2012
authored
251
8849af3 @lsegal Add info on yard server command
authored
252 And the project inside the current directory will be parsed (if the source has
253 not yet been scanned by YARD) and served at [http://localhost:8808](http://localhost:8808).
254
d624990 @lsegal Fix formatting in readme / doc files
authored
255 ### Live Reloading
8849af3 @lsegal Add info on yard server command
authored
256
257 If you want to serve documentation on a project while you document it so that
258 you can preview the results, simply pass `--reload` (`-r`) to the above command
259 and YARD will reload any changed files on each request. This will allow you to
57293fe @lsegal Fix server reloading docs, note no longer applies
authored
260 change any documentation in the source and refresh to see the new contents.
8849af3 @lsegal Add info on yard server command
authored
261
d624990 @lsegal Fix formatting in readme / doc files
authored
262 ### Serving Gems
8849af3 @lsegal Add info on yard server command
authored
263
264 To serve documentation for all installed gems, call:
265
266 $ yard server --gems
fa147d9 @lsegal The great whitespace fix of 2012
authored
267
8849af3 @lsegal Add info on yard server command
authored
268 This will also automatically build documentation for any gems that have not
269 been previously scanned. Note that in this case there will be a slight delay
270 between the first request of a newly parsed gem.
271
272
273 **5. `yard graph` Graphviz Generator**
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
274
4c2d67d @lsegal Update docs to reflect removed yard-graph
authored
275 You can use `yard graph` to generate dot graphs of your code. This, of course,
d4dcea9 @lsegal Fix broken formatting in README.markdown
authored
276 requires [Graphviz](http://www.graphviz.org) and the `dot` binary. By default
277 this will generate a graph of the classes and modules in the best UML2 notation
278 that Graphviz can support, but without any methods listed. With the `--full`
279 option, methods and attributes will be listed. There is also a `--dependencies`
280 option to show mixin inclusions. You can output to stdout or a file, or pipe directly
4c2d67d @lsegal Update docs to reflect removed yard-graph
authored
281 to `dot`. The same public, protected and private visibility rules apply to `yard graph`.
282 More options can be seen by typing `yard graph --help`, but here is an example:
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
283
12c4daa @lsegal Fix readme for yard graph command
authored
284 $ yard graph --protected --full --dependencies
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
285
286
236a216 @lsegal Update README/WhatsNew
authored
287 ## Changelog
288
9e5a174 @lsegal Bump to 0.8.2.1
authored
289 - **June.9.12**: 0.8.2.1 release
290 - Fix a set of regressions in yard server search and dynamic generation
291
bf10762 @lsegal Bump to version 0.8.2
authored
292 - **June.7.12**: 0.8.2 release
168fbb8 @lsegal Add changelog information that was omitted from release
authored
293 - Added progress style output in tty terminals
bf10762 @lsegal Bump to version 0.8.2
authored
294 - Embedded mixins should ignore methods defined on module (#539)
295 - Fixed permalinks for embedded mixins in `yard server` (#540)
296 - Improve parsing in CRuby code (#543)
297 - Ensure Registry.resolve picks module when parsing mixins (#545)
168fbb8 @lsegal Add changelog information that was omitted from release
authored
298 - Fixed regression that caused various commands to not show output (#548)
bf10762 @lsegal Bump to version 0.8.2
authored
299 - Respect current visibility when parsing class conditions (#551)
300
b084f83 @lsegal Bump to 0.8.1, update README, WhatsNew
authored
301 - **May.2.12**: 0.8.1 release
302 - Added `--[no-]api` switch to generate docs for API sets (see {file:docs/WhatsNew.md} for details) (#532)
303 - The `yard list` command now uses cache by default (#533)
304 - Fix `yardoc` generating incorrectly named method list file (#528)
305 - Fix HTML output occasionally showing trailing mdash on options list (#522)
306
236a216 @lsegal Update README/WhatsNew
authored
307 - **April.30.12**: 0.8.0 release
308 - See {file:docs/WhatsNew.md} for a list of added features
309 - Over 20 bug fixes:
310 - Properly filter hidden setter/getter attributes (#394)
311 - Fix test failures in Linux environments (#397, #472, #473, #512, #513)
312 - Fix attribute inheritance and @private (#432)
313 - Fix attribute parsing (#435)
314 - Allow aliases for attributes (#436)
315 - Fix namespace fetching in `handle_alias()` (#437)
316 - Fix overwritten attributes marked as inherited (#442)
317 - Fix documenting constants defined from C code with `rb_define_const()` (#443)
318 - Do not escape snippets twice (#445)
319 - Ajax method/class search should not fire when a non-printable character is pressed (#446)
320 - Fix yard server crashing when RDoc is not installed (#456)
321 - Fix tags ignored when `(see #foo)` is used (#457)
322 - Fix three "Returns" for two `@overload` tags (#458)
323 - Do not auto-detect DSL methods as method objects if parameter name is not a valid method name (#464)
324 - Fix attaching of macros to Object (#465)
325 - Fix handling of `%w()` source in `[]/[]=` parsed context. (#461, pull in #468)
326 - Don't add default `@return` if `@overload` has `@return`. (#458, pull in #469)
327 - Don't discard tags by (see ...). (#457, pull in #470)
328 - Fix constants listed as inherited when overwritten (#474)
329 - Fix `yardoc --asset` behaving differently on first and subsequent calls. (#477)
330 - `!!!lang` code blocks should set the lang in `<pre>`'s class. (#478, #479)
331 - Fix "File List" search tab error. (#502)
332 - Fix search bar not redirecting to method page. (#509)
333 - Fix server returning exception message bodies as String (#518)
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
334
a4707aa @lsegal Add note about 0.7.5 release
authored
335 - **January.31.12**: 0.7.5 release
336 - Various minor bug fixes
337
bc73f4b @lsegal Bump to version 0.7.4 and update README/ChangeLog/WhatsNew
authored
338 - **December.2.11**: 0.7.4 release
339 - Redcarpet is now the default Markdown formatting library. GFM now works out-of-box (#404)
340 - Fix server side searching for elements that are marked private (#420)
341 - Add 'textile_strict' and 'pre' markup types, reorganize text and none (#416)
342 - Improve encoding line detection (#415)
343 - Add support for `rb_define_alias` in CRuby code (#413)
344 - Fix rendering of some keywords in source view (#410)
345 - Add support for RDoc 3.10+ (#406, #407)
346 - Fix typewriter text being processed in code blocks (#403)
347 - Improve support for has_rdoc in RubyGems 1.8.x (#401)
348 - See the {file:docs/WhatsNew.md} document for details on added features
349
7fec945 @lsegal Update README, ChangeLog and bump to 0.7.3 for release
authored
350 - **October.15.11**: 0.7.3 release
351 - Improve support for parsing under Ruby 1.9.2p290 and 1.9.3 (#365, #370)
352 - Add support for SWIG generated CRuby code (#369)
353 - Add support for `rb_define_attr` calls in CRuby code (#362)
354 - Handle file pointers in CRuby code (#358)
355
0a078bd @lsegal 0.7.2 release
authored
356 - **June.14.11**: 0.7.2 release
357 - Fix `yard --help` not showing proper output
358 - YARD now expands path to `.yardoc` file in daemon mode for server (#328)
359 - Fix `@overload` tag linking to wrong method (#330)
360 - Fix incorrect return type when using `@macro` (#334)
361 - YARD now requires 'thread' to support RubyGems 1.7+ (#338)
362 - Fix bug in constant documentation when using `%w()` (#348)
363 - Fix YARD style URL links when using autolinking markdown (#353)
364
7c73a4d @lsegal Bump to 0.7.1
authored
365 - **May.18.11**: 0.7.1 release
366 - Fixes a bug in `yard server` not displaying class list properly.
367
8a0469f @lsegal Update readme for release
authored
368 - **May.17.11**: 0.7.0 release
bc73f4b @lsegal Bump to version 0.7.4 and update README/ChangeLog/WhatsNew
authored
369 - See the {file:docs/WhatsNew.md} document for details on added features
8a0469f @lsegal Update readme for release
authored
370 - Make sure that Docstring#line_range is filled when possible (#243)
371 - Set #verifier in YardocTask (#282)
372 - Parse BOM in UTF-8 files (#288)
373 - Fix instance attributes not showing up in method list (#302)
374 - Fix rendering of %w() literals in constants (#306)
375 - Ignore keyboard shortcuts when an input is active (#312)
376 - And more...
377
bc43e8b @lsegal 0.6.8 release
authored
378 - **April.14.11**: 0.6.8 release
379 - Fix regression in RDoc 1.x markup loading
380 - Fix regression in loading of markup libraries for `yard server`
381
5b0ef4c @lsegal 0.6.7 release (fix issue with gem plugin)
authored
382 - **April.6.11**: 0.6.7 release
b028d4e @lsegal Fix tabs formatting in README
authored
383 - Fix has_rdoc gem specification issue with new RubyGems plugin API (oops!)
5b0ef4c @lsegal 0.6.7 release (fix issue with gem plugin)
authored
384
4926d91 @lsegal 0.6.6 release
authored
385 - **April.6.11**: 0.6.6 release
b028d4e @lsegal Fix tabs formatting in README
authored
386 - Fix error message when RDoc is not present (#270)
387 - Add markup type 'none' to perform basic HTML translation (fallback when RDoc is not present)
388 - Add support for RubyGems 1.7.x (#272)
389 - Fix rendering of `{url description}` syntax when description contains newline
4926d91 @lsegal 0.6.6 release
authored
390
0eabebb @lsegal Update to 0.6.5
authored
391 - **March.13.11**: 0.6.5 release
392 - Support `ripper` gem in Ruby 1.8.7
393 - Upgrade jQuery to 1.5.1
394 - Fix handling of alias statements with quoted symbols (#262)
395 - Add CSS styles (#260)
396 - Unhandled exception in YARD::Handlers::Ruby::MixinHandler indexing documentation for eventmachine (#248)
397 - Splice any alias references on method re-definitions into separate methods (#247)
398 - Fix "yard graph" (#245)
399 - Don't process ++ typewriter text inside of HTML attributes (#244)
400 - Prioritize loading of Kramdown before Maruku (#241)
401 - Skip shebang encoding in docstrings (#238)
402 - Fix truncation of references in @deprecated (#232)
403 - Show @api private note when no other tags are present (#231)
404 - Detect docstrings starting with "##" as `Docstring#hash_flag` (#230)
405 - Remove trailing whitespace from freeform tags (#229)
406 - Fix line through for deprecated methods (#225)
407 - Mistake in Tags.md (#223)
408 - Improve database storage by being more efficient with filesystem usage (#222)
409 - Make Registry thread local (#221)
410 - Support `private_constant` class method for 1.9.3 (#219)
411 - Do not assume RDoc is installed (#214)
412
8b16023 @lsegal Bump to version 0.6.4
authored
413 - **December.21.10**: 0.6.4 release
414 - Fix yri tool crashing with new Config class (gh-217)
415 - Fix support for ::TopLevelConstants (gh-216)
416 - YARD's test suite is now RSpec2 compatible (gh-215)
417 - Improved documentation for YARD::Server features (gh-207)
418 - Fix displaying of collaped method summary lists (gh-204)
419 - Fix automatic loading of markup providers (gh-206)
420 - Fix keyboard shortcuts for Chrome (gh-203)
421 - Disallow `extend self` inside of a class (gh-202)
422 - Constants now recognized in C extensions (gh-201)
423
ba37b9e @lsegal Bump to version 0.6.3
authored
424 - **November.21.10**: 0.6.3 release
425 - Fixed regression that caused `yardoc --markup` to silently exit
426
ad9cce0 @lsegal Update ChangeLog and summarize in README
authored
427 - **November.15.10**: 0.6.2 release
428 - **Plugins no longer automatically load, use `--plugin` to load a plugin**
429 - Added YARD::Config and ~/.yard/config YAML configuration file
430 - Added `yard config` command to view/edit YARD configuration file
431 - Fixes for YARD in 1.8.6 (gh-178)
432 - Various HTML template adjustments and fixes (gh-198,199,200)
433 - Improved `yard server -m` multi-project stability (gh-193)
434 - Fixed handling of `yardoc --no-private` with missing class definitions (gh-197)
435 - Added support for constants defined in C extensions (gh-177)
436 - Added support for Structs defined as "Klass = Struct.new(...)" (gh-187)
437 - Improved parsing support for third-party gems (gh-174,180)
438 - Improved support for JRuby 1.6.4+. YARD now passes all specs in JRuby (gh-185)
439 - Improved YARD documentation (gh-172,191,196)
440
dce93ab @lsegal Bump to version 0.6.1
authored
441 - **September.06.10**: 0.6.1 release
442 - Fixed TOC showing on top of class/method list in no-frames view
443 - A message now displays when running `yard server` with Rack/Mongrel installed
444 - Improved performance of JS inline search for large class/method lists
445 - Improved link titles for relative object links
446 - Removed `String#camelcase` and `String#underscore` for better Rails compat.
447 - Fixed support for loading .yardoc files under Windows
448 - Fixed inheritance tree arrows not displaying in certain environments
449
450 - **August.29.10**: 0.6.0 release
103a10e @lsegal Update README for 0.6.0 release
authored
451 - Added dynamic local documentation server
452 - Added @group/@endgroup declarations to organize methods into groups
453 - Added `yard` executable to serve as main CLI tool with pluggable commands
454 - Added `--asset` switch to `yardoc` to copy files/dirs to output dir
455 - Added ability to register/manipulate tags via CLI (`--tag`, etc.)
456 - Added `yard diff` command
457 - Added statistics to `yardoc` output (and `yard stats` command)
458 - Added Javascript generated Table of Contents to file pages
459 - Updated various APIs
460 - Removed `yard-graph` executable
461 - See more changes in the {file:docs/WhatsNew.md what's new document}
462
2e95dd9 @lsegal Bump to version 0.5.8
authored
463 - **June.22.10**: 0.5.8 release
464 - Merge fix from 0.6 branch for --no-private visibility checking
465
f9f6153 @lsegal Bump to version 0.5.7
authored
466 - **June.21.10**: 0.5.7 release
467 - Fixed visibility flag parsing in `yardoc`
468 - Updated Parser Architecture documentation with new SourceParser API
469 - Improved Registry documentation for new load commands
470 - Fix loading of .yardoc file as cache (and preserving aliases)
471 - Fix "lib" directory missing when running YARD on installed gems
472
3a5cd0b @lsegal Release 0.5.6
authored
473 - **June.12.10**: 0.5.6 release
474 - Bug fixes for RubyGems plugin, `has_rdoc=false` should now work
2164944 @lsegal Update file: links to point to docs/ for server compatibility
authored
475 - New API for registering custom parsers. See {file:docs/WhatsNew.md}
3a5cd0b @lsegal Release 0.5.6
authored
476
61e6769 @lsegal Bump version to 0.5.5
authored
477 - **May.22.10**: 0.5.5 release
478 - Various bug fixes
479
218a790 @lsegal Bump version 0.5.4
authored
480 - **March.22.10**: 0.5.4 release
481 - See {file:docs/WhatsNew.md what's new document} for changes
482
2e400cd @lsegal Add info to changelog
authored
483 - **January.11.10**: 0.5.3 release
7a6ef0a @lsegal Fix links in README
authored
484 - See {file:docs/WhatsNew.md what's new document} for changes
2e400cd @lsegal Add info to changelog
authored
485
486 - **December.16.09**: 0.5.2 release
7a6ef0a @lsegal Fix links in README
authored
487 - See {file:docs/WhatsNew.md what's new document} for changes
2e400cd @lsegal Add info to changelog
authored
488
489 - **December.15.09**: 0.5.1 release
7a6ef0a @lsegal Fix links in README
authored
490 - See {file:docs/WhatsNew.md what's new document} for changes
2e400cd @lsegal Add info to changelog
authored
491
492 - **December.13.09**: 0.5.0 release
7a6ef0a @lsegal Fix links in README
authored
493 - See {file:docs/WhatsNew.md what's new document} for changes
2e400cd @lsegal Add info to changelog
authored
494
cf6ed42 @lsegal Document new features in changelog section
authored
495 - **November.15.09**: 0.4.0 release
496 - Added new templating engine based on [tadpole](http://github.com/lsegal/tadpole)
497 - Added YARD queries (`--query` CLI argument to yardoc)
498 - Greatly expanded YARD documentation
499 - Added plugin support
500 - New `@abstract` and `@private` tags
501 - Changed default rake task to `rake yard`
2164944 @lsegal Update file: links to point to docs/ for server compatibility
authored
502 - Read about changes in {file:docs/WhatsNew.md}
cf6ed42 @lsegal Document new features in changelog section
authored
503
504 - **August.13.09**: 0.2.3.5 release
505 - Minor bug fixes.
506
507 - **August.07.09**: 0.2.3.4 release
508 - Minor bug fixes.
509
510 - **July.26.09**: 0.2.3.3 release
511 - Minor bug fixes.
512
eb287b9 @lsegal Bump version to 0.2.3.2
authored
513 - **July.06.09**: 0.2.3.2 release
514 - Fix Textile hard-break issues
515 - Add description for @see tag to use as link title in HTML docs.
516 - Add --title CLI option to specify a title for HTML doc files.
517 - Add custom.css file that can be overridden with various custom
518 styelsheet declarations. To use this, simply add `default/fulldoc/html/custom.css`
519 inside your code directory and use the `-t` template directory yardoc CLI
520 option to point to that template directory (the dir holding 'default').
521 - Add support in `yardoc` CLI to specify extra files (formerly --files)
522 by appending "- extra files here" after regular source files. Example:
523
524 yardoc --private lib/**/*.rb - FAQ LICENSE
525
f39eaa6 @lsegal Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
authored
526 - **Jun.13.09**: 0.2.3.1 release.
527 - Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
1e244ee @lsegal Update changelog
authored
528 RDoc. To take advantage of this plugin, set `has_rdoc = 'yard'` in your
529 .gemspec file.
f39eaa6 @lsegal Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
authored
530
fa147d9 @lsegal The great whitespace fix of 2012
authored
531 - **Jun.07.09**: 0.2.3 release. See the {file:docs/WhatsNew.md} file for a
01461eb @lsegal Add getting started guide
authored
532 list of important new features.
533
fa147d9 @lsegal The great whitespace fix of 2012
authored
534 - **Jun.16.08**: 0.2.2 release. This is the largest changset since yard's
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
535 conception and involves a complete overhaul of the parser and API to make it
536 more robust and far easier to extend and use for the developer.
537
fa147d9 @lsegal The great whitespace fix of 2012
authored
538 - **Feb.20.08**: 0.2.1 release.
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
539
540 - **Feb.24.07**: Released 0.1a experimental version for testing. The goal here is
fa147d9 @lsegal The great whitespace fix of 2012
authored
541 to get people testing YARD on their code because there are too many possible
542 code styles to fit into a sane amount of test cases. It also demonstrates the
543 power of YARD and what to expect from the syntax (Yardoc style meta tags).
2e95dd9 @lsegal Bump to version 0.5.8
authored
544
545
236a216 @lsegal Update README/WhatsNew
authored
546 ## Contributors
2e95dd9 @lsegal Bump to version 0.5.8
authored
547
06323d1 @lsegal Point contributors section to github's contributors page (easier main…
authored
548 Special thanks to all contributors for submitting patches. A full list of
fa147d9 @lsegal The great whitespace fix of 2012
authored
549 contributors including their patches can be found at:
06323d1 @lsegal Point contributors section to github's contributors page (easier main…
authored
550
551 http://github.com/lsegal/yard/contributors
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
552
236a216 @lsegal Update README/WhatsNew
authored
553 ## Copyright
7910f84 @lsegal Fix recognition of markdown in readme's, move default :readme option …
authored
554
737f561 @lsegal Change copyright year and version
authored
555 YARD &copy; 2007-2012 by [Loren Segal](mailto:lsegal@soen.ca). YARD is
f822d84 @lsegal Add Ruby/RDoc license information to YARD and update copyright years.
authored
556 licensed under the MIT license except for some files which come from the
fa147d9 @lsegal The great whitespace fix of 2012
authored
557 RDoc/Ruby distributions. Please see the {file:LICENSE} and {file:LEGAL}
f822d84 @lsegal Add Ruby/RDoc license information to YARD and update copyright years.
authored
558 documents for more information.
Something went wrong with that request. Please try again.