yard 0.9.28 → 0.9.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a014685561249bd72bd38eea2db5386c7a3f5d814ec2cbd0218fc76803d4d88
-  data.tar.gz: fbbb78841e6f41798c14cde55e5d55da409bc550005a1f8d67a2491332a9378c
+  metadata.gz: 92d411c4d39cc74df916cbac8719ebd7ac6ed1fb17b37022148f584440bda554
+  data.tar.gz: 9582c48d6c1949c055e22035f325abc957ec31900613f5b04307f7f27fc011a4
 SHA512:
-  metadata.gz: 37666343d2e629ce4cd1c9c1d7e82b678ade120151e79b52ce3110bdbd9c0bdf65c76aa3661a5d6ffd34fe40f9ff90f100b1f7b2c898951737e6ba14f4bacaa3
-  data.tar.gz: 6235690efed8749d45e513842f689a273c68ef6424a4881a9e77db2a1590ebc1fb7d55d6d68c2f6013bda045e49e1285169c93a9c7736f3b2ef7a6e8fe1fc4de
+  metadata.gz: d566d6989e868b3bc4959037309c9c07a89608f07a39ad2719ead8765fca6ab3ae6240bfe7d56394ad47c8d75c5999d02313f6f7eaedb056a2ea584750d15cc1
+  data.tar.gz: 641e462842732b47a67ff95eda6cfdb0373de7b2f487ceb7aa827815c0f8201fa55639979f7df17ec4d12864de60c4cc631fc7921cc787b20a04f5493cd86033

data/CHANGELOG.md

@@ -1,5 +1,143 @@
 # main
 
+# [0.9.43] - April 17th, 2026
+
+[0.9.43]: https://github.com/lsegal/yard/compare/v0.9.42...v0.9.43
+
+- Fix attribute registration in .rbs files (#1583)
+
+# [0.9.42] - April 16th, 2026
+
+[0.9.42]: https://github.com/lsegal/yard/compare/v0.9.41...v0.9.42
+
+- Fix alternating rows when loading a module in default HTML templates with subelements in the nav frame
+- Fix reliability of keypresses and copy/paste in search box (#1174)
+- Fix regression in `yard server` search box styling
+- Fix possible path traversal with document_root (`--docroot`) set in `yard server` ([GHSA-xfhh-rx56-rxcr](https://github.com/lsegal/yard/security/advisories/GHSA-xfhh-rx56-rxcr))
+
+# [0.9.41] - April 14th, 2026
+
+[0.9.41]: https://github.com/lsegal/yard/compare/v0.9.40...v0.9.41
+
+- Add support for `rdoc-image:...` syntax in HybridMarkup (#1676)
+- Add support for colon suffix code blocks in HybridMarkup (rdoc compatibility)
+- Fix responsiveness and state issues with nav frame links in `yard server`
+
+# [0.9.40] - April 12th, 2026
+
+[0.9.40]: https://github.com/lsegal/yard/compare/v0.9.39...v0.9.40
+
+- Add support for Ruby .rbs files (docstrings included) (#1673)
+- Add built-in hybrid RDoc/Markdown renderer (`HybridMarkdown`) requiring no external gems (#1674)
+- Add support for `#-` as a comment-block separator. See Getting Started Guide.
+- Add support for `commonmarker` version `>= 1.0`.
+- Remove usage of jQuery in default templates. jQuery library is still packaged in templates for backward compatibility (#1675)
+- Fix false self-referential mixin when bare name matches ancestor namespace (#1672)
+- Fix bracket/brace map corruption from Ruby 3.0+ pattern matching deconstruction (#1671)
+- Fix `@!scope class` on attributes (#1582, #1655, #1666)
+- Fix `@!parse` directives not including source for block (#1665)
+- Fix inherited methods not appearing in groups (#1656)
+
+# [0.9.39] - April 8th, 2026
+
+[0.9.39]: https://github.com/lsegal/yard/compare/v0.9.38...v0.9.39
+
+- Add support for Ruby 4.0 (#1663)
+- Add changelog URI to gemspec metadata (#1641)
+- Fix issues with source ranges (#1642)
+- Fix an issue loading relative links from file list in HTML template (#1660)
+- Various test fixes (#1650, #1651)
+
+
+# [0.9.38] - December 5th, 2025
+
+[0.9.38]: https://github.com/lsegal/yard/compare/v0.9.37...v0.9.38
+
+- Add support for complex constant assignment (#1599)
+- Add support for Data type structs (#1600)
+- Support multi method duck type syntax in type explainer (#1631)
+- Improve Ruby 3.5 compatibility (#1616)
+- Update documentation for various type annotations (#1615)
+- JavaScript frontend updates (resizer, JS bugs, reduce console verbosity) for default template
+- Fix beginless/endless range errors (#1549, #1625)
+- Fix path structure in Templates.md documentation (#1588)
+- Fix signature handling in overload (#1590)
+- Fix handling of **nil with named block (#1623)
+- Fix directives in empty class bodies (#1624)
+- Fix parsing of array within array syntax (#1604)
+- Fix parsing of visibility keywords in front of class methods (#1632)
+
+# [0.9.37] - September 4th, 2024
+
+[0.9.37]: https://github.com/lsegal/yard/compare/v0.9.36...v0.9.37
+
+- Fix JavaScript errors in `--one-file` template (#1426)
+- Fix heredoc parsing and add support for squiggly heredocs (#1315, #1495)
+- Accessibility improvements to the default template (#1501)
+- Improved YARD documentation (#1410, #1512, #1516, #1544)
+- Fix error when parsing `@option` tags (#1515)
+- Fix issue parsing UTF-8 filenames (#1517)
+- Replace OpenStruct with optimized YARD::OpenStruct to avoid ostruct performance warnings (#1545)
+- Add support for `private attr_*` syntax (#1541)
+- Remove logger dependency (#1546)
+
+# [0.9.36] - February 29th, 2024
+
+[0.9.36]: https://github.com/lsegal/yard/compare/v0.9.35...v0.9.36
+
+- Further XSS fixes for generated frameset pages (#1538)
+- Improve tests for Ruby 3.3 compatibility (#1519, #1531)
+- Documentation improvements (#1524)
+
+# [0.9.35] - February 28th, 2024
+
+[0.9.35]: https://github.com/lsegal/yard/compare/v0.9.34...v0.9.35
+
+- Fix possible XSS on generated YARD frameset pages (thanks to @RedYetiDev for finding and patching) (2069e2b).
+- Fix errors when using `@option` on non-method objects (#1508)
+- Support Ruby 3.3 changes in Ripper parser (#1510)
+
+# [0.9.34] - April 12nd, 2023
+
+[0.9.34]: https://github.com/lsegal/yard/compare/v0.9.33...v0.9.34
+
+- Add changelog to yard.gemspec
+- Fix fork behavior in `yard server --fork`
+
+# [0.9.33] - April 11st, 2023
+
+[0.9.33]: https://github.com/lsegal/yard/compare/v0.9.32...v0.9.33
+
+- Ensure .yardopts is present in gem package (internal YARD documentation change)
+
+# 0.9.32 - April 9th, 2023
+
+[0.9.32]: https://github.com/lsegal/yard/compare/v0.9.31...v0.9.32
+
+- Fix issue with custom Rack::Request attributes in `yard server`
+
+# [0.9.31] - April 9th, 2023
+
+[0.9.31]: https://github.com/lsegal/yard/compare/v0.9.30...v0.9.31
+
+- Remove dependency on webrick in YARD::Server::Commands::StaticFileHelpers
+
+# [0.9.30] - April 9th, 2023
+
+[0.9.30]: https://github.com/lsegal/yard/compare/v0.9.29...v0.9.30
+
+- Hot release fix to correct issue with gem packaging missing templates (#1490)
+
+# [0.9.29] - April 8th, 2023
+
+[0.9.29]: https://github.com/lsegal/yard/compare/v0.9.28...v0.9.29
+
+- Enable table support for CommonMarker (#1443)
+- Parser performance improvements (#1452, #1453, #1454, #1455)
+- Fix autoload of RipperParser (#1460)
+- Remove dependency on webrick for better Ruby 3.1+ support
+- Improvements for mixin resolution (#1467, #1468)
+
 # [0.9.28] - June 1st, 2022
 
 [0.9.28]: https://github.com/lsegal/yard/compare/v0.9.27...v0.9.28
@@ -758,7 +896,7 @@ contributions to this version.
 
 [0.4.0]: https://github.com/lsegal/yard/compare/v0.2.3.5...v0.4.0
 
-- Added new templating engine based on [tadpole](http://github.com/lsegal/tadpole)
+- Added new templating engine based on [tadpole](https://github.com/lsegal/tadpole)
 - Added YARD queries (`--query` CLI argument to yardoc)
 - Greatly expanded YARD documentation
 - Added plugin support

data/LEGAL

@@ -4,7 +4,7 @@ LEGAL NOTICE INFORMATION
 All the files in this distribution are covered under either the MIT
 license (see the file LICENSE) except some files mentioned below.
 
-lib/parser/ruby/legacy/ruby_lex.rb:
+lib/yard/parser/ruby/legacy/ruby_lex.rb:
 
   This file is under the Ruby license. YARD uses a modified version of it.
 
@@ -64,3 +64,31 @@ lib/parser/ruby/legacy/ruby_lex.rb:
          IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
          WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
          PURPOSE.
+
+lib/yard/server/http_utils.rb:
+
+   This file is vendored and slightly modified from WEBrick because it was
+   removed from Ruby core in Ruby 3.x.
+
+      Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+
+      Redistribution and use in source and binary forms, with or without
+      modification, are permitted provided that the following conditions
+      are met:
+      1. Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+      2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+      THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+      ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+      IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+      ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+      FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+      DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+      OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+      HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+      LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+      OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+      SUCH DAMAGE.

data/README.md

@@ -1,10 +1,10 @@
 # YARD: Yay! A Ruby Documentation Tool
 
-[![Homepage](https://img.shields.io/badge/home-yardoc.org-blue.svg)](http://yardoc.org)
-[![GitHub](https://img.shields.io/badge/github-lsegal/yard-blue.svg)](http://github.com/lsegal/yard)
-[![Documentation](https://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/yard/frames)
+[![Homepage](https://img.shields.io/badge/home-yardoc.org-blue.svg)](https://yardoc.org)
+[![GitHub](https://img.shields.io/badge/github-lsegal/yard-blue.svg)](https://github.com/lsegal/yard)
+[![Documentation](https://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://rubydoc.org/gems/yard/frames)
 
-[![Gem Version](https://badge.fury.io/rb/yard.svg)](http://github.com/lsegal/yard/releases)
+[![Gem Version](https://badge.fury.io/rb/yard.svg)](https://github.com/lsegal/yard/releases)
 [![Unit Tests](https://github.com/lsegal/yard/actions/workflows/ci.yml/badge.svg)](https://github.com/lsegal/yard/actions/workflows/ci.yml)
 [![Coverage Status](https://coveralls.io/repos/github/lsegal/yard/badge.svg)](https://coveralls.io/github/lsegal/yard)
 [![License](https://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
@@ -19,10 +19,10 @@ summary of some of YARD's notable features.
 
 ## Feature List
 
-**1. RDoc/SimpleMarkup Formatting Compatibility**: YARD is made to be compatible
-with RDoc formatting. In fact, YARD does no processing on RDoc documentation
-strings, and leaves this up to the output generation tool to decide how to
-render the documentation.
+**1. Builtin RDoc/Markdown Hybrid Support**: YARD ships with a builtin markup
+renderer that supports both RDoc and Markdown formatting out of the box—no
+external gem required. You can freely mix RDoc-style and Markdown-style
+documentation without installing any additional libraries.
 
 **2. Yardoc Meta-tag Formatting Like Python, Java, Objective-C and other
 languages**: YARD uses a '@tag' style definition syntax for meta tags alongside
@@ -114,20 +114,24 @@ $ gem install yard
 Alternatively, if you've checked the source out directly, you can call
 `rake install` from the root project directory.
 
-**Important Note for Debian/Ubuntu users:** there's a possible chance your Ruby
-install lacks RDoc, which is occasionally used by YARD to convert markup to
-HTML. If running `which rdoc` turns up empty, install RDoc by issuing:
+### Markup rendering
 
-```sh
-$ sudo apt-get install rdoc
-```
+YARD includes a builtin renderer that handles both RDoc and Markdown markup
+types without any external dependencies. To switch the default markup type,
+pass `-m markdown` (or `-m rdoc`) to `yard doc`, or add it to your `.yardopts`
+file.
+
+For optional extra rendering features (e.g. GitHub-Flavoured Markdown fenced
+code blocks, tables, or specific Markdown extensions), you can install an
+additional provider gem such as `redcarpet`, `commonmarker`, or `kramdown` and
+select it explicitly with `-M PROVIDER` (e.g. `yard doc -m markdown -M redcarpet`).
 
 ## Usage
 
 There are a couple of ways to use YARD. The first is via command-line, and the
 second is the Rake task.
 
-**1. yard Command-line Tool**
+### 1. yard Command-line Tool
 
 YARD comes packaged with a executable named `yard` which can control the many
 functions of YARD, including generating documentation, graphs running the YARD
@@ -140,7 +144,7 @@ $ yard --help
 Plugins can also add commands to the `yard` executable to provide extra
 functionality.
 
-### Generating Documentation
+#### Generating Documentation
 
 <span class="note">The `yardoc` executable is a shortcut for `yard doc`.</span>
 
@@ -185,9 +189,9 @@ Note that the README file can be specified with its own `--readme` switch.
 You can also add a `.yardopts` file to your project directory which lists the
 switches separated by whitespace (newlines or space) to pass to yardoc whenever
 it is run. A full overview of the `.yardopts` file can be found in
-{YARD::CLI::Yardoc}.
+[YARD::CLI::Yardoc](https://rubydoc.info/gems/yard/YARD/CLI/Yardoc#label-Options+File+-28.yardopts-29).
 
-### Queries
+#### Queries
 
 The `yardoc` tool also supports a `--query` argument to only include objects
 that match a certain data or meta-data query. The query syntax is Ruby, though a
@@ -214,7 +218,7 @@ following two lines both check for the existence of a return and param tag:
 
 For more information about the query syntax, see the {YARD::Verifier} class.
 
-**2. Rake Task**
+### 2. Rake Task
 
 The second most obvious is to generate docs via a Rake task. You can do this by
 adding the following to your `Rakefile`:
@@ -240,7 +244,7 @@ environment variable:
 $ rake yard OPTS='--any --extra --opts'
 ```
 
-**3. `yri` RI Implementation**
+### 3. `yri` RI Implementation
 
 The yri binary will use the cached .yardoc database to give you quick ri-style
 access to your documentation. It's way faster than ri but currently does not
@@ -264,7 +268,7 @@ $ yard gems
 If you don't have sudo access, it will write these files to your `~/.yard`
 directory. `yri` will also cache lookups there.
 
-**4. `yard server` Documentation Server**
+### 4. `yard server` Documentation Server
 
 The `yard server` command serves documentation for a local project or all
 installed RubyGems. To serve documentation for a project you are working on,
@@ -278,14 +282,14 @@ And the project inside the current directory will be parsed (if the source has
 not yet been scanned by YARD) and served at
 [http://localhost:8808](http://localhost:8808).
 
-### Live Reloading
+#### Live Reloading
 
 If you want to serve documentation on a project while you document it so that
 you can preview the results, simply pass `--reload` (`-r`) to the above command
 and YARD will reload any changed files on each request. This will allow you to
 change any documentation in the source and refresh to see the new contents.
 
-### Serving Gems
+#### Serving Gems
 
 To serve documentation for all installed gems, call:
 
@@ -297,10 +301,10 @@ This will also automatically build documentation for any gems that have not been
 previously scanned. Note that in this case there will be a slight delay between
 the first request of a newly parsed gem.
 
-**5. `yard graph` Graphviz Generator**
+### 5. `yard graph` Graphviz Generator
 
 You can use `yard graph` to generate dot graphs of your code. This, of course,
-requires [Graphviz](http://www.graphviz.org) and the `dot` binary. By default
+requires [Graphviz](https://www.graphviz.org) and the `dot` binary. By default
 this will generate a graph of the classes and modules in the best UML2 notation
 that Graphviz can support, but without any methods listed. With the `--full`
 option, methods and attributes will be listed. There is also a `--dependencies`

data/docs/GettingStarted.md

@@ -61,15 +61,41 @@ Using tags we can add semantic metadata to our code without worrying about
 presentation. YARD will handle presentation for us when we decide to generate
 documentation later.
 
+### Disconnecting Comment Blocks
+
+YARD attaches a comment block to the next relevant object by default. That is
+usually what you want, but file headers are a common exception. If you keep a
+copyright notice, license note or general file-level description at the top of
+the file, it can accidentally become the docstring for the first class or
+module unless you explicitly break the block.
+
+To disconnect the block, end the header with an attached `#-` line:
+
+    # Copyright (c) Example Corp
+    # Shared support code for the client layer.
+    #-
+
+    class Client
+    end
+
+In this example, the header comment is not attached to `Client`.
+
+This only works with `#-`. If you write `# -` with a space before the hyphen,
+YARD treats it as a normal comment line and it remains part of the docstring.
+
 ## Which Markup Format?
 
-YARD does not impose a specific markup. The above example uses standard RDoc
-markup formatting, but YARD also supports textile and markdown via the
-command-line switch or `.yardopts` file (see below). This means that you are
-free to use whatever formatting you like. This guide is actually written
-using markdown. YARD, however, does add a few important syntaxes that are
-processed no matter which markup formatting you use, such as tag support
-and inter-document linking. These syntaxes are discussed below.
+YARD does not impose a specific markup format. YARD ships with a builtin
+renderer that supports both RDoc and Markdown out of the box—no external gem
+required. You can use either format (or switch between them) without installing
+anything extra. YARD also supports textile, asciidoc, and other formats via
+optional gems.
+
+To select a markup format, use the command-line switch `-m FORMAT` or add
+`--markup FORMAT` to your `.yardopts` file. This guide is written in Markdown.
+YARD adds a few important syntaxes that are processed regardless of which
+markup format you choose, such as tag support and inter-document linking.
+These syntaxes are discussed below.
 
 ## Adding Tags to Documentation
 
@@ -182,7 +208,7 @@ Symbols:
 We mentioned that these type fields are "mostly" free-form. In truth, they
 are defined "by convention". To view samples of common type specifications
 and recommended conventions for writing type specifications, see
-[http://yardoc.org/types.html](http://yardoc.org/types.html). Note that these
+[https://yardoc.org/types.html](https://yardoc.org/types.html). Note that these
 conventions may change every now and then, although we are working on a more
 "formal" type specification proposal.
 
@@ -200,7 +226,7 @@ YARD will automatically wire up the correct method types and information
 by simply defining documentation in the `@return` tag. For example,
 the following declaration will show the correct information for the
 `waveform` attribute, both for the getter's return type and the
-setter's value parameter type: 
+setter's value parameter type:
 
     # @return [Numeric] the amplitude of the waveform
     attr_accessor :amplitude
@@ -248,7 +274,7 @@ The most common is the `attr_accessor` method, which of course has built-in
 support in YARD. However, frameworks and libraries often expose custom
 methods that perform similar metaprogramming tasks, and it is often useful
 to document their functionality in your application. Consider the `property`
-method in a project like [DataMapper](http://datamapper.org), which creates
+method in a project like [DataMapper](https://datamapper.org), which creates
 a typed attribute for a database model. The code might look like:
 
     class Post
@@ -386,11 +412,11 @@ If you want to use a Hash, prefix the first { with "!":
 
    # !{ :some_key => 'value' }
 
-### Linking URLs `{http://...}`
+### Linking URLs `{https://...}`
 
 URLs are also linked using this `{...}` syntax:
 
-    {http://example.com Optional Title}
+    {https://example.com Optional Title}
     {mailto:email@example.com}
 
 ### Linking Files `{file:...}`
@@ -672,8 +698,8 @@ not exist, so you may need to create it.
 You may find some useful YARD plugins on [RubyGems][RubyGemsQuery] or with
 a [Google advanced query][GoogleAdvancedQuery].
 
-[graphviz]:http://www.graphviz.org
-[yard-rspec]:http://github.com/lsegal/yard-spec-plugin
-[rspec]:http://rspec.info
+[graphviz]:https://www.graphviz.org
+[yard-rspec]:https://github.com/lsegal/yard-spec-plugin
+[rspec]:https://rspec.info
 [GoogleAdvancedQuery]:https://www.google.com/search?q=site%3Arubygems.org+intitle%3A%22yard-%22+OR+intitle%3A%22yard_%22
 [RubyGemsQuery]:https://rubygems.org/search?utf8=%E2%9C%93&query=name%3A+yard

data/docs/Parser.md

@@ -55,49 +55,10 @@ You can also provide the parser type explicitly as the second argument:
 Note that these two methods are aliased as {YARD.parse} and {YARD.parse_string} for
 convenience.
 
-## Implementing and Registering a Custom Parser
-
-To implement a custom parser, subclass {YARD::Parser::Base}. Documentation on which
-abstract methods should be implemented are documented in that class. After the class
-is implemented, it is registered with the {YARD::Parser::SourceParser} factory class
-to be called when a file of the right extension needs to be parsed, or when a user
-selects that parser type explicitly. To register your new parser class, call the
-method {YARD::Parser::SourceParser.register_parser_type}:
-
-    SourceParser.register_parser_type(:my_parser, MyParser, 'my_parser_ext')
-
-The last argument can be a single extension, a list of extensions (Array), a single Regexp, or a
-list of Regexps. Do not include the '.' in the extension.
-
-
-## The Two Ruby Parser Types
-
-When parsing Ruby, the SourceParser can either instantiate the new {YARD::Parser::Ruby::RubyParser}
-class or the {YARD::Parser::Ruby::Legacy::StatementList} class. The first of the
-two, although faster, more robust and more efficient, is only available for
-Ruby 1.9. The legacy parser parser is available in both 1.8.x and 1.9, if
-compatibility is required. The choice of parser will affect which handlers
-ultimately get used, since new handlers can only use the new parser and the
-same requirement applies to the legacy parser & handlers.
-
-## Switching to Legacy Parser
-
-By default, running YARD under Ruby 1.9 will automatically select the new parser
-and new handlers by extension. Although YARD supports both handler styles, plugins
-may choose to only implement one of the two (though this is not recommended). If
-only the legacy handlers are implemented, the `SourceParser` class should force
-the use of the legacy parser by setting the `parser_type` attribute as such:
+## RubyParser
 
-    YARD::Parser::SourceParser.parser_type = :ruby18
-
-The default value is `:ruby`. Note that this cannot be forced the other way around,
-a parser type of `:ruby` cannot be set under Ruby 1.8.x as the new parser is not
-supported under 1.8.
-
-## RubyParser (the New Parser)
-
-The new Ruby parser uses the Ripper library that is packaged as part of stdlib
-in Ruby 1.9. Because of this, it can generate an AST from a string of Ruby input
+The Ruby parser uses the Ripper library that is packaged as part of stdlib.
+Because of this, it can generate an AST from a string of Ruby input
 that is similar to the style of other sexp libraries (such as ParseTree). Each
 node generated in the tree is of the base type {YARD::Parser::Ruby::AstNode},
 which has some subclasses for common node types.
@@ -163,6 +124,20 @@ to quickly get at a node of a specific type in such a situation:
 Multiple types can be searched for at once. If none are found, the original root
 node is returned so that it may be chained.
 
+## Implementing and Registering a Custom Parser
+
+To implement a custom parser, subclass {YARD::Parser::Base}. Documentation on which
+abstract methods should be implemented are documented in that class. After the class
+is implemented, it is registered with the {YARD::Parser::SourceParser} factory class
+to be called when a file of the right extension needs to be parsed, or when a user
+selects that parser type explicitly. To register your new parser class, call the
+method {YARD::Parser::SourceParser.register_parser_type}:
+
+    SourceParser.register_parser_type(:my_parser, MyParser, 'my_parser_ext')
+
+The last argument can be a single extension, a list of extensions (Array), a single Regexp, or a
+list of Regexps. Do not include the '.' in the extension.
+
 ## The Legacy Parser
 
 The goal of the legacy parser is much the same as the new parser, but it is far

data/docs/Tags.md

@@ -141,7 +141,7 @@ a set of conventions for how to list types is described below.
 
 <p class="note">
   A list of examples of common type listings and what they translate into is
-  available at <a href="http://yardoc.org/types">http://yardoc.org/types</a>.
+  available at <a href="https://yardoc.org/types">https://yardoc.org/types</a>.
 </p>
 
 Typically, a type list contains a list of classes or modules that are associated
@@ -206,16 +206,17 @@ also be a list of types separated by commas.
 An order dependent list is a set of types surrounded by "()" and separated by
 commas. This list must contain exactly those types in exactly the order specified.
 For instance, an Array containing a String, Fixnum and Hash in that order (and
-having exactly those 3 elements) would be listed as: `Array<(String, Fixnum, Hash)>`.
+having exactly those 3 elements) would be listed as: `Array(String, Fixnum, Hash)`.
 
 #### Literals
 
 Some literals are accepted by virtue of being Ruby literals, but also by YARD
 conventions. Here is a non-exhaustive list of certain accepted literal values:
 
-* `true`, `false`, `nil` &mdash; used when a method returns these explicit literal
-  values. Note that if your method returns both `true` or `false`, you should use
-  the `Boolean` conventional type instead.
+* `true`, `false`, `nil`, `:foo` &mdash; used when a method returns
+  these explicit literal values. Note that if your method returns both
+  `true` or `false`, you should use the `Boolean` conventional type
+  instead.
 * `self` &mdash; has the same meaning as Ruby's "self" keyword in the context of
   parameters or return types. Recommended mostly for {tag:return} tags that are
   chainable.
@@ -280,4 +281,3 @@ Note that you might not need a tag title if you are hiding it. The title
 part can be omitted.
 
 {yard:include_tags}
-

data/docs/Templates.md

@@ -280,10 +280,11 @@ seen above by creating such a path in our '/path/to/mytemplates' custom template
 path:
 
     /path/to/mytemplates/:
-    |-- class
-    |   |-- html
-    |   |   |-- customsection.erb
-    |   |-- setup.rb
+    |--default
+    |   |-- class
+    |   |   |-- html
+    |   |   |   |-- customsection.erb
+    |   |   |-- setup.rb
 
 The `setup.rb` file would look like: