Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 464 lines (354 sloc) 20.078 kb
7afd7e9 Loren Segal Update README formatting
authored
1 YARD: Yay! A Ruby Documentation Tool
2 ====================================
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
3
61e6769 Loren Segal Bump version to 0.5.5
authored
4 **Homepage**: [http://yardoc.org](http://yardoc.org)
395b15f Loren Segal Fix some markdown formatting errors
authored
5 **IRC**: [irc.freenode.net / #yard](irc://irc.freenode.net/yard)
61e6769 Loren Segal Bump version to 0.5.5
authored
6 **Git**: [http://github.com/lsegal/yard](http://github.com/lsegal/yard)
7 **Author**: Loren Segal
2e95dd9 Loren Segal Bump to version 0.5.8
authored
8 **Contributors**: See Contributors section below
61e6769 Loren Segal Bump version to 0.5.5
authored
9 **Copyright**: 2007-2010
10 **License**: MIT License
8b16023 Loren Segal Bump to version 0.6.4
authored
11 **Latest Version**: 0.6.4 (codename "Snowy White Picket Fences")
12 **Release Date**: December 21st 2010
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
13
7afd7e9 Loren Segal Update README formatting
authored
14 Synopsis
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
15 --------
16
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

21 summary of some of YARD's notable features.
22
23
7afd7e9 Loren Segal Update README formatting
authored
24 Feature List
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
25 ------------
26
d4dcea9 Loren Segal Fix broken formatting in README.markdown
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.

31
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

36 important information about objects, such as what parameters they take and what types
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
01461eb Loren Segal Add getting started guide
authored
39 consistently) organized
during the output generation phase. You can find a list
2164944 Loren Segal 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 Loren Segal Fix broken formatting in README.markdown
authored
41
01461eb Loren Segal Add getting started guide
authored
42 YARD also supports an optional "types" declarations for certain tags.

d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
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

47 following Yardoc'd method:

48
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 Loren Segal Add support for syntax highlighting with new RubyParser AST
authored
56 end
57
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
58 With the above @param tag, we learn that the contents parameter can either be
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.

7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
65
9b04160 Loren Segal Fix some typos in readme
authored
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
68 need to document the following code:

7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
69
9b04160 Loren Segal Fix some typos in readme
authored
70 class List
71 # Sets the publisher name for the list.
72 cattr_accessor :publisher
01461eb Loren Segal Add getting started guide
authored
73 end
74
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
75 This custom declaration provides dynamically generated code that is hard for a
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 Loren Segal Fix some typos in readme
authored
78 the developer to handle the `cattr_accessor` construct and automatically create
79 an attribute on the class with the associated documentation. This makes

d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
80 documenting external API's, especially dynamic ones, a lot more consistent for
81 consumption by the users.

9b04160 Loren Segal 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.
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
86
d4dcea9 Loren Segal Fix broken formatting in README.markdown
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

92 command line (text based) and possibly XML, this may still be useful for those
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

95 exploiting this raw data format would be to write tools that can auto generate
96 test cases, for example, or show possible unhandled exceptions in code.

52b8234 Loren Segal Add special installation instructions for some Ubuntu/Debian installatio...
authored
97
9b04160 Loren Segal 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
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
103 documentation a much faster process.
104
52b8234 Loren Segal Add special installation instructions for some Ubuntu/Debian installatio...
authored
105
106 Installing
107 ----------
108
109 To install YARD, use the following command:
110
111 $ gem install yard
112
113 (Add `sudo` if you're installing under a POSIX system as root)
114
115 Alternatively, if you've checked the source out directly, you can call
116 `rake install` from the root project directory.
117
118 **Important Note for Debian/Ubuntu users:** there's a possible chance your Ruby
119 install lacks RDoc, which is occasionally used by YARD to convert markup to HTML.
120 If running `which rdoc` turns up empty, install RDoc by issuing:
121
122 $ sudo apt-get install rdoc
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
123
124
7afd7e9 Loren Segal Update README formatting
authored
125 Usage
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
126 -----
127
128 There are a couple of ways to use YARD. The first is via command-line, and the
103a10e Loren Segal Update README for 0.6.0 release
authored
129 second is the Rake task.
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
130
103a10e Loren Segal Update README for 0.6.0 release
authored
131 **1. yard Command-line Tool**
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
132
103a10e Loren Segal Update README for 0.6.0 release
authored
133 YARD comes packaged with a executable named `yard` which can control the many
134 functions of YARD, including generating documentation, graphs running the
135 YARD server, and so on. To view a list of available YARD commands, type:
136
137 $ yard --help
138
139 Plugins can also add commands to the `yard` executable to provide extra
140 functionality.
141
142 #### Generating Documentation
143
144 <span class="note">The `yardoc` executable is a shortcut for `yard doc`.</span>
145
146 The most common command you will probably use is `yard doc`, or `yardoc`. You
147 can type `yardoc --help` to see the options that YARD provides, but the
148 easiest way to generate docs for your code is to simply type `yardoc` in your
149 project root. This will assume your files are
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
150 located in the `lib/` directory. If they are located elsewhere, you can specify
151 paths and globs from the commandline via:
152
01461eb Loren Segal Add getting started guide
authored
153 $ yardoc 'lib/**/*.rb' 'app/**/*.rb' ...etc...
103a10e Loren Segal Update README for 0.6.0 release
authored
154
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
155 The tool will generate a `.yardoc` file which will store the cached database
156 of your source code and documentation. If you want to re-generate your docs
157 with another template you can simply use the `--use-cache` (or -c)
158 option to speed up the generation process by skipping source parsing.
159
160 YARD will by default only document code in your public visibility. You can
161 document your protected and private code by adding `--protected` or
aee74c6 Loren Segal Update docs to reflect new YARD behaviours
authored
162 `--private` to the option switches. In addition, you can add `--no-private`
163 to also ignore any object that has the `@private` meta-tag. This is similar
164 to RDoc's ":nodoc:" behaviour, though the distinction is important. RDoc
165 implies that the object with :nodoc: would not be documented, whereas
166 YARD still recommends documenting private objects for the private API (for
167 maintainer/developer consumption).
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
168
aee74c6 Loren Segal Update docs to reflect new YARD behaviours
authored
169 You can also add extra informative files (README, LICENSE) by separating
170 the globs and the filenames with '-'.
01461eb Loren Segal Add getting started guide
authored
171
aee74c6 Loren Segal Update docs to reflect new YARD behaviours
authored
172 $ yardoc 'app/**/*.rb' - README LICENSE FAQ
173
395b15f Loren Segal Fix some markdown formatting errors
authored
174 If no globs preceed the '-' argument, the default glob (`lib/**/*.rb`) is
aee74c6 Loren Segal Update docs to reflect new YARD behaviours
authored
175 used:
01461eb Loren Segal Add getting started guide
authored
176
aee74c6 Loren Segal Update docs to reflect new YARD behaviours
authored
177 $ yardoc - README LICENSE FAQ
178
179 Note that the README file can be specified with its own `--readme` switch.
01461eb Loren Segal Add getting started guide
authored
180
181 You can also add a `.yardopts` file to your project directory which lists
182 the switches separated by whitespace (newlines or space) to pass to yardoc
1b8581f Loren Segal Tell users where to read information about .yardopts
authored
183 whenever it is run. A full overview of the `.yardopts` file can be found in
184 {YARD::CLI::Yardoc}.
01461eb Loren Segal Add getting started guide
authored
185
8849af3 Loren Segal Add info on yard server command
authored
186 #### Queries
abeac7d Loren Segal Document new --query parameter
authored
187
188 The `yardoc` tool also supports a `--query` argument to only include objects
189 that match a certain data or meta-data query. The query syntax is Ruby, though
190 a few shortcuts are available. For instance, to document only objects that have
191 an "@api" tag with the value "public", all of the following syntaxes would give
192 the same result:
193
194 --query '@api.text == "public"'
195 --query 'object.has_tag?(:api) && object.tag(:api).text == "public"'
196 --query 'has_tag?(:api) && tag(:api).text == "public"'
197
198 Note that the "@tag" syntax returns the first tag named "tag" on the object.
199 To return the array of all tags named "tag", use "@@tag".
200
201 Multiple `--query` arguments are allowed in the command line parameters. The
202 following two lines both check for the existence of a return and param tag:
203
204 --query '@return' --query '@param'
205 --query '@rturn && @param'
206
207 For more information about the query syntax, see the {YARD::Verifier} class.
208
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
209 **2. Rake Task**
210
211 The second most obvious is to generate docs via a Rake task. You can do this by
212 adding the following to your `Rakefile`:
213
01461eb Loren Segal Add getting started guide
authored
214 YARD::Rake::YardocTask.new do |t|
215 t.files = ['lib/**/*.rb', OTHER_PATHS] # optional
216 t.options = ['--any', '--extra', '--opts'] # optional
217 end
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
218
219 both the `files` and `options` settings are optional. `files` will default to
220 `lib/**/*.rb` and `options` will represents any options you might want
221 to add. Again, a full list of options is available by typing `yardoc --help`
222 in a shell. You can also override the options at the Rake command-line with the
223 OPTS environment variable:
224
aee74c6 Loren Segal Update docs to reflect new YARD behaviours
authored
225 $ rake yard OPTS='--any --extra --opts'
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
226
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
227 **3. `yri` RI Implementation**
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
228
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
229 The yri binary will use the cached .yardoc database to give you quick ri-style
230 access to your documentation. It's way faster than ri but currently does not
231 work with the stdlib or core Ruby libraries, only the active project. Example:
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
232
01461eb Loren Segal Add getting started guide
authored
233 $ yri YARD::Handlers::Base#register
abeac7d Loren Segal Document new --query parameter
authored
234 $ yri File.relative_path
235
236 Note that class methods must not be referred to with the "::" namespace
237 separator. Only modules, classes and constants should use "::".
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
238
303d15e Loren Segal Bump version to 0.5.0
authored
239 You can also do lookups on any installed gems. Just make sure to build the
240 .yardoc databases for installed gems with:
241
acd0fcf Loren Segal Fix yardoc --build gems command
authored
242 $ sudo yard gems
303d15e Loren Segal Bump version to 0.5.0
authored
243
244 If you don't have sudo access, it will write these files to your `~/.yard`
245 directory. `yri` will also cache lookups there.
246
8849af3 Loren Segal Add info on yard server command
authored
247 **4. `yard server` Documentation Server**
248
249 The `yard server` command serves documentation for a local project or all installed
250 RubyGems. To serve documentation for a project you are working on, simply run:
251
252 $ yard server
253
254 And the project inside the current directory will be parsed (if the source has
255 not yet been scanned by YARD) and served at [http://localhost:8808](http://localhost:8808).
256
257 #### Live Reloading
258
259 If you want to serve documentation on a project while you document it so that
260 you can preview the results, simply pass `--reload` (`-r`) to the above command
261 and YARD will reload any changed files on each request. This will allow you to
57293fe Loren Segal Fix server reloading docs, note no longer applies
authored
262 change any documentation in the source and refresh to see the new contents.
8849af3 Loren Segal Add info on yard server command
authored
263
264 #### Serving Gems
265
266 To serve documentation for all installed gems, call:
267
268 $ yard server --gems
269
270 This will also automatically build documentation for any gems that have not
271 been previously scanned. Note that in this case there will be a slight delay
272 between the first request of a newly parsed gem.
273
274
275 **5. `yard graph` Graphviz Generator**
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
276
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
277 You can use `yard-graph` to generate dot graphs of your code. This, of course,
278 requires [Graphviz](http://www.graphviz.org) and the `dot` binary. By default
279 this will generate a graph of the classes and modules in the best UML2 notation
280 that Graphviz can support, but without any methods listed. With the `--full`
281 option, methods and attributes will be listed. There is also a `--dependencies`
282 option to show mixin inclusions. You can output to stdout or a file, or pipe directly
283 to `dot`. The same public, protected and private visibility rules apply to yard-graph.
284 More options can be seen by typing `yard-graph --help`, but here is an example:
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
285
12c4daa Loren Segal Fix readme for yard graph command
authored
286 $ yard graph --protected --full --dependencies
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
287
288
7afd7e9 Loren Segal Update README formatting
authored
289 Changelog
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
290 ---------
291
8b16023 Loren Segal Bump to version 0.6.4
authored
292 - **December.21.10**: 0.6.4 release
293 - Fix yri tool crashing with new Config class (gh-217)
294 - Fix support for ::TopLevelConstants (gh-216)
295 - YARD's test suite is now RSpec2 compatible (gh-215)
296 - Improved documentation for YARD::Server features (gh-207)
297 - Fix displaying of collaped method summary lists (gh-204)
298 - Fix automatic loading of markup providers (gh-206)
299 - Fix keyboard shortcuts for Chrome (gh-203)
300 - Disallow `extend self` inside of a class (gh-202)
301 - Constants now recognized in C extensions (gh-201)
302
ba37b9e Loren Segal Bump to version 0.6.3
authored
303 - **November.21.10**: 0.6.3 release
304 - Fixed regression that caused `yardoc --markup` to silently exit
305
ad9cce0 Loren Segal Update ChangeLog and summarize in README
authored
306 - **November.15.10**: 0.6.2 release
307 - **Plugins no longer automatically load, use `--plugin` to load a plugin**
308 - Added YARD::Config and ~/.yard/config YAML configuration file
309 - Added `yard config` command to view/edit YARD configuration file
310 - Fixes for YARD in 1.8.6 (gh-178)
311 - Various HTML template adjustments and fixes (gh-198,199,200)
312 - Improved `yard server -m` multi-project stability (gh-193)
313 - Fixed handling of `yardoc --no-private` with missing class definitions (gh-197)
314 - Added support for constants defined in C extensions (gh-177)
315 - Added support for Structs defined as "Klass = Struct.new(...)" (gh-187)
316 - Improved parsing support for third-party gems (gh-174,180)
317 - Improved support for JRuby 1.6.4+. YARD now passes all specs in JRuby (gh-185)
318 - Improved YARD documentation (gh-172,191,196)
319
dce93ab Loren Segal Bump to version 0.6.1
authored
320 - **September.06.10**: 0.6.1 release
321 - Fixed TOC showing on top of class/method list in no-frames view
322 - A message now displays when running `yard server` with Rack/Mongrel installed
323 - Improved performance of JS inline search for large class/method lists
324 - Improved link titles for relative object links
325 - Removed `String#camelcase` and `String#underscore` for better Rails compat.
326 - Fixed support for loading .yardoc files under Windows
327 - Fixed inheritance tree arrows not displaying in certain environments
328
329 - **August.29.10**: 0.6.0 release
103a10e Loren Segal Update README for 0.6.0 release
authored
330 - Added dynamic local documentation server
331 - Added @group/@endgroup declarations to organize methods into groups
332 - Added `yard` executable to serve as main CLI tool with pluggable commands
333 - Added `--asset` switch to `yardoc` to copy files/dirs to output dir
334 - Added ability to register/manipulate tags via CLI (`--tag`, etc.)
335 - Added `yard diff` command
336 - Added statistics to `yardoc` output (and `yard stats` command)
337 - Added Javascript generated Table of Contents to file pages
338 - Updated various APIs
339 - Removed `yard-graph` executable
340 - See more changes in the {file:docs/WhatsNew.md what's new document}
341
2e95dd9 Loren Segal Bump to version 0.5.8
authored
342 - **June.22.10**: 0.5.8 release
343 - Merge fix from 0.6 branch for --no-private visibility checking
344
f9f6153 Loren Segal Bump to version 0.5.7
authored
345 - **June.21.10**: 0.5.7 release
346 - Fixed visibility flag parsing in `yardoc`
347 - Updated Parser Architecture documentation with new SourceParser API
348 - Improved Registry documentation for new load commands
349 - Fix loading of .yardoc file as cache (and preserving aliases)
350 - Fix "lib" directory missing when running YARD on installed gems
351
3a5cd0b Loren Segal Release 0.5.6
authored
352 - **June.12.10**: 0.5.6 release
353 - Bug fixes for RubyGems plugin, `has_rdoc=false` should now work
2164944 Loren Segal Update file: links to point to docs/ for server compatibility
authored
354 - New API for registering custom parsers. See {file:docs/WhatsNew.md}
3a5cd0b Loren Segal Release 0.5.6
authored
355
61e6769 Loren Segal Bump version to 0.5.5
authored
356 - **May.22.10**: 0.5.5 release
357 - Various bug fixes
358
218a790 Loren Segal Bump version 0.5.4
authored
359 - **March.22.10**: 0.5.4 release
360 - See {file:docs/WhatsNew.md what's new document} for changes
361
2e400cd Loren Segal Add info to changelog
authored
362 - **January.11.10**: 0.5.3 release
7a6ef0a Loren Segal Fix links in README
authored
363 - See {file:docs/WhatsNew.md what's new document} for changes
2e400cd Loren Segal Add info to changelog
authored
364
365 - **December.16.09**: 0.5.2 release
7a6ef0a Loren Segal Fix links in README
authored
366 - See {file:docs/WhatsNew.md what's new document} for changes
2e400cd Loren Segal Add info to changelog
authored
367
368 - **December.15.09**: 0.5.1 release
7a6ef0a Loren Segal Fix links in README
authored
369 - See {file:docs/WhatsNew.md what's new document} for changes
2e400cd Loren Segal Add info to changelog
authored
370
371 - **December.13.09**: 0.5.0 release
7a6ef0a Loren Segal Fix links in README
authored
372 - See {file:docs/WhatsNew.md what's new document} for changes
2e400cd Loren Segal Add info to changelog
authored
373
cf6ed42 Loren Segal Document new features in changelog section
authored
374 - **November.15.09**: 0.4.0 release
375 - Added new templating engine based on [tadpole](http://github.com/lsegal/tadpole)
376 - Added YARD queries (`--query` CLI argument to yardoc)
377 - Greatly expanded YARD documentation
378 - Added plugin support
379 - New `@abstract` and `@private` tags
380 - Changed default rake task to `rake yard`
2164944 Loren Segal Update file: links to point to docs/ for server compatibility
authored
381 - Read about changes in {file:docs/WhatsNew.md}
cf6ed42 Loren Segal Document new features in changelog section
authored
382
383 - **August.13.09**: 0.2.3.5 release
384 - Minor bug fixes.
385
386 - **August.07.09**: 0.2.3.4 release
387 - Minor bug fixes.
388
389 - **July.26.09**: 0.2.3.3 release
390 - Minor bug fixes.
391
eb287b9 Loren Segal Bump version to 0.2.3.2
authored
392 - **July.06.09**: 0.2.3.2 release
393 - Fix Textile hard-break issues
394 - Add description for @see tag to use as link title in HTML docs.
395 - Add --title CLI option to specify a title for HTML doc files.
396 - Add custom.css file that can be overridden with various custom
397 styelsheet declarations. To use this, simply add `default/fulldoc/html/custom.css`
398 inside your code directory and use the `-t` template directory yardoc CLI
399 option to point to that template directory (the dir holding 'default').
400 - Add support in `yardoc` CLI to specify extra files (formerly --files)
401 by appending "- extra files here" after regular source files. Example:
402
403 yardoc --private lib/**/*.rb - FAQ LICENSE
404
f39eaa6 Loren Segal Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
authored
405 - **Jun.13.09**: 0.2.3.1 release.
406 - Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
1e244ee Loren Segal Update changelog
authored
407 RDoc. To take advantage of this plugin, set `has_rdoc = 'yard'` in your
408 .gemspec file.
f39eaa6 Loren Segal Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
authored
409
2164944 Loren Segal Update file: links to point to docs/ for server compatibility
authored
410 - **Jun.07.09**: 0.2.3 release. See the {file:docs/WhatsNew.md} file for a
01461eb Loren Segal Add getting started guide
authored
411 list of important new features.
412
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
413 - **Jun.16.08**: 0.2.2 release. This is the largest changset since yard's
414 conception and involves a complete overhaul of the parser and API to make it
415 more robust and far easier to extend and use for the developer.
416
417 - **Feb.20.08**: 0.2.1 release.
418
419 - **Feb.24.07**: Released 0.1a experimental version for testing. The goal here is
420 to get people testing YARD on their code because there are too many possible
421 code styles to fit into a sane amount of test cases. It also demonstrates the
422 power of YARD and what to expect from the syntax (Yardoc style meta tags).
2e95dd9 Loren Segal Bump to version 0.5.8
authored
423
424
425 Contributors
426 ------------
427
428 Special thanks to the following people for submitting patches:
429
dd5878d Loren Segal Update contributors list
authored
430 * Nathan Weizenbaum
431 * Nick Plante
432 * Michael Edgar
433 * Yehuda Katz
2e95dd9 Loren Segal Bump to version 0.5.8
authored
434 * Duane Johnson
dd5878d Loren Segal Update contributors list
authored
435 * Postmodern
ebe40ae Loren Segal Add new contributors
authored
436 * Edward Muller
dd5878d Loren Segal Update contributors list
authored
437 * Pieter van de Bruggen
438 * Leonid Borisenko
ebe40ae Loren Segal Add new contributors
authored
439 * Arthur Schreiber
440 * Robert Wahler
441 * Mark Evans
8b16023 Loren Segal Bump to version 0.6.4
authored
442 * Lee Jarvis
443 * Franklin Webber
ebe40ae Loren Segal Add new contributors
authored
444 * David Turnbull
445 * Anthony Thibault
446 * Sam Rawlins
dd5878d Loren Segal Update contributors list
authored
447 * Jeff Rafter
2e95dd9 Loren Segal Bump to version 0.5.8
authored
448 * Elliottcable
449 * James Rosen
dd5878d Loren Segal Update contributors list
authored
450 * Jake Kerr
8b16023 Loren Segal Bump to version 0.6.4
authored
451 * Gioele Barabucci
dd5878d Loren Segal Update contributors list
authored
452 * Gabriel Horner
453 * Denis Defreyne
454 * Benjamin Bock
455 * Aman Gupta
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
456
7afd7e9 Loren Segal Update README formatting
authored
457 Copyright
d4dcea9 Loren Segal Fix broken formatting in README.markdown
authored
458 ---------
7910f84 Loren Segal Fix recognition of markdown in readme's, move default :readme option out...
authored
459
f822d84 Loren Segal Add Ruby/RDoc license information to YARD and update copyright years.
authored
460 YARD &copy; 2007-2010 by [Loren Segal](mailto:lsegal@soen.ca). YARD is
461 licensed under the MIT license except for some files which come from the
462 RDoc/Ruby distributions. Please see the {file:LICENSE} and {file:LEGAL}
463 documents for more information.
Something went wrong with that request. Please try again.