rdoc 6.14.2 → 7.0.3

data/lib/rdoc/token_stream.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 ##
 # A TokenStream is a list of tokens, gathered during the parse of some entity
 # (say a method). Entities populate these streams by being registered with the
@@ -87,9 +88,11 @@ module RDoc::TokenStream
 
   ##
   # Starts collecting tokens
+  #
 
-  def collect_tokens
+  def collect_tokens(language)
     @token_stream = []
+    @token_stream_language = language
   end
 
   alias start_collecting_tokens collect_tokens
@@ -115,4 +118,13 @@ module RDoc::TokenStream
     (token_stream or return '').compact.map { |token| token[:text] }.join ''
   end
 
+  ##
+  # Returns the source language of the token stream as a string
+  #
+  # Returns 'c' or 'ruby'
+
+  def source_language
+    @token_stream_language == :c ? 'c' : 'ruby'
+  end
+
 end

data/lib/rdoc/tom_doc.rb

@@ -49,7 +49,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
       next unless code_object and
                   RDoc::Comment === comment and comment.format == 'tomdoc'
 
-      comment.text.gsub!(/(\A\s*# )(Public|Internal|Deprecated):\s+/) do
+      comment.text.gsub!(/\A(\s*# |)(Public|Internal|Deprecated):\s+/) do
         section = code_object.add_section $2
         code_object.temporary_section = section
 

data/lib/rdoc/version.rb

@@ -5,6 +5,6 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '6.14.2'
+  VERSION = '7.0.3'
 
 end

data/rdoc.gemspec

@@ -38,14 +38,14 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
   # for ruby core repository. It was generated by
   # `git ls-files -z`.split("\x0").each {|f| puts "    #{f.dump}," unless f.start_with?(*%W[test/ spec/ features/ .]) }
   non_lib_files = [
-    "CONTRIBUTING.rdoc",
+    "CONTRIBUTING.md",
     "CVE-2013-0256.rdoc",
     "ExampleMarkdown.md",
     "ExampleRDoc.rdoc",
     "History.rdoc",
     "LEGAL.rdoc",
     "LICENSE.rdoc",
-    "README.rdoc",
+    "README.md",
     "RI.md",
     "TODO.rdoc",
     "exe/rdoc",
@@ -60,7 +60,7 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
 
   s.files = (non_lib_files + template_files + lib_files).uniq
 
-  s.rdoc_options = ["--main", "README.rdoc"]
+  s.rdoc_options = ["--main", "README.md"]
   s.extra_rdoc_files += s.files.grep(%r[\A[^\/]+\.(?:rdoc|md)\z])
 
   s.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
@@ -68,4 +68,5 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
 
   s.add_dependency 'psych', '>= 4.0.0'
   s.add_dependency 'erb'
+  s.add_dependency 'tsort'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 6.14.2
+  version: 7.0.3
 platform: ruby
 authors:
 - Eric Hodel
@@ -13,7 +13,7 @@ authors:
 - ITOYANAGI Sakura
 bindir: exe
 cert_chain: []
-date: 2025-07-03 00:00:00.000000000 Z
+date: 2025-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -43,6 +43,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tsort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   RDoc produces HTML and command-line documentation for Ruby projects.
   RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.
@@ -59,25 +73,25 @@ executables:
 - ri
 extensions: []
 extra_rdoc_files:
-- CONTRIBUTING.rdoc
+- CONTRIBUTING.md
 - CVE-2013-0256.rdoc
 - ExampleMarkdown.md
 - ExampleRDoc.rdoc
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
-- README.rdoc
+- README.md
 - RI.md
 - TODO.rdoc
 files:
-- CONTRIBUTING.rdoc
+- CONTRIBUTING.md
 - CVE-2013-0256.rdoc
 - ExampleMarkdown.md
 - ExampleRDoc.rdoc
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
-- README.rdoc
+- README.md
 - RI.md
 - TODO.rdoc
 - exe/rdoc
@@ -110,6 +124,7 @@ files:
 - lib/rdoc/erb_partial.rb
 - lib/rdoc/erbio.rb
 - lib/rdoc/generator.rb
+- lib/rdoc/generator/aliki.rb
 - lib/rdoc/generator/darkfish.rb
 - lib/rdoc/generator/json_index.rb
 - lib/rdoc/generator/markup.rb
@@ -118,6 +133,33 @@ files:
 - lib/rdoc/generator/pot/po.rb
 - lib/rdoc/generator/pot/po_entry.rb
 - lib/rdoc/generator/ri.rb
+- lib/rdoc/generator/template/aliki/_aside_toc.rhtml
+- lib/rdoc/generator/template/aliki/_footer.rhtml
+- lib/rdoc/generator/template/aliki/_head.rhtml
+- lib/rdoc/generator/template/aliki/_header.rhtml
+- lib/rdoc/generator/template/aliki/_icons.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_ancestors.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_classes.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_methods.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_search.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml
+- lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml
+- lib/rdoc/generator/template/aliki/class.rhtml
+- lib/rdoc/generator/template/aliki/css/rdoc.css
+- lib/rdoc/generator/template/aliki/index.rhtml
+- lib/rdoc/generator/template/aliki/js/aliki.js
+- lib/rdoc/generator/template/aliki/js/c_highlighter.js
+- lib/rdoc/generator/template/aliki/js/search_controller.js
+- lib/rdoc/generator/template/aliki/js/search_navigation.js
+- lib/rdoc/generator/template/aliki/js/search_ranker.js
+- lib/rdoc/generator/template/aliki/js/theme-toggle.js
+- lib/rdoc/generator/template/aliki/page.rhtml
+- lib/rdoc/generator/template/aliki/servlet_not_found.rhtml
+- lib/rdoc/generator/template/aliki/servlet_root.rhtml
 - lib/rdoc/generator/template/darkfish/_footer.rhtml
 - lib/rdoc/generator/template/darkfish/_head.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml
@@ -192,6 +234,7 @@ files:
 - lib/rdoc/markup/blank_line.rb
 - lib/rdoc/markup/block_quote.rb
 - lib/rdoc/markup/document.rb
+- lib/rdoc/markup/element.rb
 - lib/rdoc/markup/formatter.rb
 - lib/rdoc/markup/hard_break.rb
 - lib/rdoc/markup/heading.rb
@@ -268,7 +311,7 @@ metadata:
   changelog_uri: https://github.com/ruby/rdoc/releases
 rdoc_options:
 - "--main"
-- README.rdoc
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -282,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []

data/CONTRIBUTING.rdoc

@@ -1,219 +0,0 @@
-= Developer Introduction
-
-So you want to write a generator, fix a bug, or otherwise work with RDoc.  This
-document provides an overview of how RDoc works from parsing options to
-generating output.  Most of the documentation can be found in the specific
-classes for each feature.
-
-== Bugs
-
-If you think you found a bug, file a ticket on the {issues
-tracker}[https://github.com/ruby/rdoc/issues] on github.
-
-If your bug involves an error RDoc produced please include a sample file that
-illustrates the problem or link to the repository or gem that is associated
-with the bug.
-
-Please include steps to reproduce the issue.  Here are some examples of good
-issues:
-
-* https://github.com/ruby/rdoc/issues/55
-* https://github.com/ruby/rdoc/issues/61
-
-== Developer Quick Start
-
-RDoc uses bundler for development.  To get ready to work on RDoc run:
-
-  $ gem install bundler
-  [...]
-  $ bundle install
-  [...]
-  $ rake
-  [...]
-
-This will install all the necessary dependencies for development with rake,
-generate documentation and run the tests for the first time.
-
-If the tests don't pass on the first run check the {GitHub Actions page}[https://github.com/ruby/rdoc/actions] to see if there are any known failures
-(there shouldn't be).
-
-You can now use `rake` and `autotest` to run the tests.
-
-Note: the `rake` command must be used first before running any tests, because
-it's used to generate various parsers implemented in RDoc. Also `rake clean` is
-helpful to delete these generated files.
-
-== Glossary
-
-Here are definitions for some common terms in the RDoc documentation.  The
-list also briefly describes how the components of RDoc interact.
-
-parser::
-  Parses files and creates a documentation tree from the contents.
-
-documentation tree::
-  The documentation tree represents files, classes, modules, methods,
-  constants, includes, comments and other ruby syntax features as a tree.
-  RDoc walks this tree with a generator to create documentation.
-
-generator::
-  Walks the documentation tree and generates output.
-
-  RDoc ships with two generators, the Darkfish generator creates HTML and the
-  RI generator creates an RI data store.
-
-markup parser::
-  Parses comments from a file into a generic markup tree.
-
-  The markup parsers allow RDoc to handle RDoc, TomDoc, rd and Markdown format
-  documentation with common formatters.
-
-markup tree::
-  Each parsed comment has a markup tree that represents common markup items
-  such as headings, paragraphs, lists or verbatim text sections for example
-  code or output.
-
-  A generator uses a formatters to walks the tree to create output.  Some
-  generators use multiple formatters on a markup tree to produce the output.
-
-formatter::
-  Converts a parsed markup tree into some form other form of markup.
-
-  Formatters can either produce a one-to-one conversion, such as ToHtml, or
-  extract part of the parsed result, such as ToHtmlSnippet which outputs the
-  first 100 characters as HTML.
-
-== Plugins
-
-When 'rdoc/rdoc' is loaded RDoc looks for 'rdoc/discover' files in your
-installed gems.  This can be used to load parsers, alternate generators, or
-additional preprocessor directives.  An rdoc plugin layout should look
-something like this:
-
-  lib/rdoc/discover.rb
-  lib/my/rdoc/plugin.rb
-  # etc.
-
-In your rdoc/discover.rb file you will want to wrap the loading of your plugin
-in an RDoc version check like this:
-
-  begin
-    gem 'rdoc', '~> 3'
-    require 'my/rdoc/plugin'
-  rescue Gem::LoadError
-  end
-
-=== Plugin Types
-
-In RDoc you can change the following behaviors:
-
-* Add a parser for a new file format
-* Add a new output generator
-* Add a new markup directive
-* Add a new type of documentation markup
-* Add a new type of formatter
-
-All of these are described below
-
-== Option Parsing
-
-Option parsing is handled by RDoc::Options.  When you're writing a generator
-you can provide the user with extra options by providing a class method
-+setup_options+.  The option parser will call this after your generator is
-loaded.  See RDoc::Generator for details.
-
-== File Parsing
-
-After options are parsed, RDoc parses files from the files and directories in
-ARGV.  RDoc compares the filename against what each parser claims it can parse
-via RDoc::Parser#parse_files_matching.  For example, RDoc::Parser::C can parse
-C files, C headers, C++ files, C++ headers and yacc grammars.
-
-Once a matching parser class is found it is instantiated and +scan+ is called.
-The parser needs to extract documentation from the file and add it to the RDoc
-document tree.  Usually this involves starting at the root and adding a class
-or a module (RDoc::TopLevel#add_class and RDoc::TopLevel#add_module) and
-proceeding to add classes, modules and methods to each nested item.
-
-When the parsers are finished the document tree is cleaned up to remove
-dangling references to aliases and includes that were not found (and may exist
-in a separate library) through RDoc::ClassModule#complete.
-
-To write your own parser for a new file format see RDoc::Parser.
-
-=== Documentation Tree
-
-The parsers build a documentation tree that is composed of RDoc::CodeObject and
-its subclasses.  There are various methods to walk the tree to extract
-information, see RDoc::Context and its subclasses.
-
-Within a class or module, attributes, methods and constants are divided into
-sections.  The section represents a functional grouping of parts of the class.
-TomDoc uses the sections "Public", "Internal" and "Deprecated".  The sections
-can be enumerated using RDoc::Context#each_section.
-
-== Output Generation
-
-An RDoc generator turns the documentation tree into some other kind of output.
-RDoc comes with an HTML generator (RDoc::Generator::Darkfish) and an RI
-database generator (RDoc::Generator::RI).  The output a generator creates does
-not have to be human-readable.
-
-To create your own generator see RDoc::Generator.
-
-=== Comments
-
-In RDoc 3.10 and newer the comment on an RDoc::CodeObject is now an
-RDoc::Comment object instead of a String.  This is to support various
-documentation markup formats like rdoc, TomDoc and rd.  The comments are
-normalized to remove comment markers and remove indentation then parsed lazily
-via RDoc::Comment#document to create a generic markup tree that can be
-processed by a formatter.
-
-To add your own markup format see RDoc::Markup@Other+directives
-
-==== Formatters
-
-To transform a comment into some form of output an RDoc::Markup::Formatter
-subclass is used like RDoc::Markup::ToHtml.  A formatter is a visitor that
-walks a parsed comment tree (an RDoc::Markup::Document) of any format.  To help
-write a formatter RDoc::Markup::FormatterTestCase exists for generic parsers,
-and RDoc::Markup::TextFormatterTestCase which contains extra test cases for
-text-type output (like +ri+ output).
-
-RDoc ships with formatters that will turn a comment into HTML, rdoc-markup-like
-text, ANSI or terminal backspace highlighted text, HTML, cross-referenced HTML,
-an HTML snippet free of most markup, an HTML label for use in id attributes, a
-table-of-contents page, and text with only code blocks.
-
-The output of the formatter does not need to be text or text-like.
-RDoc::Markup::ToLabel creates an HTML-safe label for use in an HTML id
-attribute.  A formatter could count the number of words and the average word
-length for a comment, for example.
-
-==== Directives
-
-For comments in markup you can add new directives (:nodoc: is a directive).
-Directives may replace text or store it off for later use.
-
-See RDoc::Markup::PreProcess::register for details.
-
-=== JSONIndex
-
-RDoc contains a special generator, RDoc::Generator::JSONIndex, which creates a
-JSON-based search index and includes a search engine for use with HTML output.
-This generator can be used to add searching to any HTML output and is designed
-to be called from inside an HTML generator.
-
-== Markup
-
-Additional documentation markup formats can be added to RDoc.  A markup
-parsing class must respond to \::parse and accept a String argument containing
-the markup format.  An RDoc::Document containing documentation items
-(RDoc::Markup::Heading, RDoc::Markup::Paragraph, RDoc::Markup::Verbatim, etc.)
-must be returned.
-
-To register the parser with rdoc, add the markup type's name and class to the
-RDoc::Text::MARKUP_FORMAT hash like:
-
-  RDoc::Text::MARKUP_FORMAT['rdoc'] = RDoc::Markup

data/README.rdoc

@@ -1,144 +0,0 @@
-= \RDoc - Ruby Documentation System
-
-home :: https://github.com/ruby/rdoc
-rdoc :: https://ruby.github.io/rdoc
-bugs :: https://github.com/ruby/rdoc/issues
-code quality :: https://codeclimate.com/github/ruby/rdoc
-
-== Description
-
-RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
-includes the +rdoc+ and +ri+ tools for generating and displaying documentation
-from the command-line.
-
-== Generating Documentation
-
-Once installed, you can create documentation using the +rdoc+ command
-
-  $ rdoc [options] [names...]
-
-For an up-to-date option summary, type
-
-  $ rdoc --help
-
-A typical use might be to generate documentation for a package of Ruby
-source (such as RDoc itself).
-
-  $ rdoc
-
-This command generates documentation for all the Ruby and C source
-files in and below the current directory.  These will be stored in a
-documentation tree starting in the subdirectory +doc+.
-
-You can make this slightly more useful for your readers by having the
-index page contain the documentation for the primary file.  In our
-case, we could type
-
-  % rdoc --main README.rdoc
-
-You'll find information on the various formatting tricks you can use
-in comment blocks in the documentation this generates.
-
-RDoc uses file extensions to determine how to process each file.  File names
-ending +.rb+ and +.rbw+ are assumed to be Ruby source.  Files
-ending +.c+ are parsed as C files.  All other files are assumed to
-contain just Markup-style markup (with or without leading '#' comment
-markers).  If directory names are passed to RDoc, they are scanned
-recursively for C and Ruby source files only.
-
-To generate documentation using +rake+ see RDoc::Task[https://ruby.github.io/rdoc/RDoc/Task.html].
-
-To generate documentation programmatically:
-
-  gem 'rdoc'
-  require 'rdoc/rdoc'
-
-  options = RDoc::Options.new
-  options.files = ['a.rb', 'b.rb']
-  options.setup_generator 'darkfish'
-  # see RDoc::Options
-
-  rdoc = RDoc::RDoc.new
-  rdoc.document options
-  # see RDoc::RDoc
-
-You can specify the target files for document generation with +.document+ file in the project root directory.
-+.document+ file contains a list of file and directory names including comment lines starting with '#'.
-See https://github.com/ruby/rdoc/blob/master/.document as an example.
-
-== Writing Documentation
-
-To write documentation for RDoc place a comment above the class, module,
-method, constant, or attribute you want documented:
-
-  ##
-  # This class represents an arbitrary shape by a series of points.
-
-  class Shape
-
-    ##
-    # Creates a new shape described by a +polyline+.
-    #
-    # If the +polyline+ does not end at the same point it started at the
-    # first pointed is copied and placed at the end of the line.
-    #
-    # An ArgumentError is raised if the line crosses itself, but shapes may
-    # be concave.
-
-    def initialize polyline
-      # ...
-    end
-
-  end
-
-The default comment markup format is the RDoc::Markup format.
-TomDoc[rdoc-ref:RDoc::TomDoc], Markdown[rdoc-ref:RDoc::Markdown] and
-RD[rdoc-ref:RDoc::RD] format comments are also supported.  You can set the
-default comment format for your entire project by creating a
-<tt>.rdoc_options</tt> file.  See RDoc::Options@Saved+Options for instructions
-on creating one.  You can also set the comment format for a single file
-through the +:markup:+ directive, but this is only recommended if you wish to
-switch markup formats.  See RDoc::Markup@Other+directives.
-
-Comments can contain directives that tell RDoc information that it cannot
-otherwise discover through parsing.  See RDoc::Markup@Directives to control
-what is or is not documented, to define method arguments or to break up
-methods in a class by topic.  See RDoc::Parser::Ruby for directives used to
-teach RDoc about metaprogrammed methods.
-
-See RDoc::Parser::C for documenting C extensions with RDoc.
-
-To determine how well your project is documented run <tt>rdoc -C lib</tt> to
-get a documentation coverage report.  <tt>rdoc -C1 lib</tt> includes parameter
-names in the documentation coverage report.
-
-== Theme Options
-
-There are a few community-maintained themes for \RDoc:
-
-- rorvswild-theme-rdoc[https://github.com/BaseSecrete/rorvswild-theme-rdoc]
-- hanna[https://github.com/jeremyevans/hanna] (a fork maintained by {Jeremy Evans}[https://github.com/jeremyevans])
-
-Please follow the theme's README for usage instructions.
-
-== Bugs
-
-See CONTRIBUTING.rdoc for information on filing a bug report.  It's OK to file
-a bug report for anything you're having a problem with.  If you can't figure
-out how to make RDoc produce the output you like that is probably a
-documentation bug.
-
-== License
-
-RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
-Portions (c) 2007-2011 Eric Hodel.  Portions copyright others, see individual
-files and LEGAL.rdoc for details.
-
-RDoc is free software, and may be redistributed under the terms specified in
-LICENSE.rdoc.
-
-== Warranty
-
-This software is provided "as is" and without any express or implied
-warranties, including, without limitation, the implied warranties of
-merchantability and fitness for a particular purpose.