rdoc 6.13.0 → 6.17.0

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
@@ -13,7 +14,7 @@ module RDoc::TokenStream
   # <tt><span></tt> elements. Some tokens types are wrapped in spans
   # with the given class names. Other token types are not wrapped in spans.
 
-  def self.to_html token_stream
+  def self.to_html(token_stream)
     starting_title = false
 
     token_stream.map do |t|
@@ -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
 
@@ -75,7 +75,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns an RDoc::Markup::Document representing the TomDoc format.
 
-  def self.parse text
+  def self.parse(text)
     parser = new
 
     parser.tokenize text
@@ -91,7 +91,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns a String containing the signature and nil if not
 
-  def self.signature comment
+  def self.signature(comment)
     return unless comment.tomdoc?
 
     document = comment.parse
@@ -134,7 +134,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns an RDoc::Markup::Heading
 
-  def build_heading level
+  def build_heading(level)
     heading = super
 
     @section = heading.text
@@ -150,7 +150,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns an RDoc::Markup::Verbatim
 
-  def build_verbatim margin
+  def build_verbatim(margin)
     verbatim = super
 
     verbatim.format = :ruby if @section == 'Examples'
@@ -164,7 +164,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns an RDoc::Markup::Paragraph.
 
-  def build_paragraph margin
+  def build_paragraph(margin)
     p :paragraph_start => margin if @debug
 
     paragraph = RDoc::Markup::Paragraph.new
@@ -204,7 +204,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   ##
   # Detects a section change to "Returns" and adds a heading
 
-  def parse_text parent, indent # :nodoc:
+  def parse_text(parent, indent) # :nodoc:
     paragraph = build_paragraph indent
 
     if false == @seen_returns and 'Returns' == @section then
@@ -222,7 +222,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
   #
   # Returns self.
 
-  def tokenize text
+  def tokenize(text)
     text = text.sub(/\A(Public|Internal|Deprecated):\s+/, '')
 
     setup_scanner text

data/lib/rdoc/version.rb

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

data/man/ri.1

@@ -36,6 +36,8 @@ can be:
 .It Class::method | Class#method | Class.method | method
 .Pp
 .It gem_name: | gem_name:README | gem_name:History
+.Pp
+.It ruby: | ruby:NEWS | ruby:globals
 .El
 .Pp
 All class names may be abbreviated to their minimum unambiguous form.

data/rdoc.gemspec

@@ -0,0 +1,72 @@
+begin
+  require_relative "lib/rdoc/version"
+rescue LoadError
+  # for Ruby repository
+  require_relative "version"
+end
+
+Gem::Specification.new do |s|
+  s.name = "rdoc"
+  s.version = RDoc::VERSION
+
+  s.authors = [
+    "Eric Hodel",
+    "Dave Thomas",
+    "Phil Hagelberg",
+    "Tony Strauss",
+    "Zachary Scott",
+    "Hiroshi SHIBATA",
+    "ITOYANAGI Sakura"
+  ]
+  s.email = ["drbrain@segment7.net", "", "", "", "mail@zzak.io", "hsbt@ruby-lang.org", "aycabta@gmail.com"]
+
+  s.summary = "RDoc produces HTML and command-line documentation for Ruby projects"
+  s.description = <<-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.
+  DESCRIPTION
+  s.homepage = "https://ruby.github.io/rdoc"
+  s.licenses = ["Ruby"]
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/ruby/rdoc"
+  s.metadata["changelog_uri"] = "#{s.metadata["source_code_uri"]}/releases"
+
+  s.bindir = "exe"
+  s.executables = ["rdoc", "ri"]
+  s.require_paths = ["lib"]
+  # 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",
+    "CVE-2013-0256.rdoc",
+    "ExampleMarkdown.md",
+    "ExampleRDoc.rdoc",
+    "History.rdoc",
+    "LEGAL.rdoc",
+    "LICENSE.rdoc",
+    "README.md",
+    "RI.md",
+    "TODO.rdoc",
+    "exe/rdoc",
+    "exe/ri",
+    "man/ri.1",
+    "rdoc.gemspec",
+  ]
+  base = __dir__
+  not_dir = ->(path) {!File.directory?(File.join(base, path))}
+  template_files = Dir.glob("lib/rdoc/generator/template/**/*", base: base).select(&not_dir)
+  lib_files = Dir.glob("lib/**/*.{rb,kpeg,ry}", base: base).select(&not_dir)
+
+  s.files = (non_lib_files + template_files + lib_files).uniq
+
+  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")
+  s.required_rubygems_version = Gem::Requirement.new(">= 2.2")
+
+  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.13.0
+  version: 6.17.0
 platform: ruby
 authors:
 - Eric Hodel
@@ -13,7 +13,7 @@ authors:
 - ITOYANAGI Sakura
 bindir: exe
 cert_chain: []
-date: 2025-03-23 00:00:00.000000000 Z
+date: 2025-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -29,6 +29,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: erb
+  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'
+- !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.
@@ -52,7 +80,7 @@ extra_rdoc_files:
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
-- README.rdoc
+- README.md
 - RI.md
 - TODO.rdoc
 files:
@@ -63,7 +91,7 @@ files:
 - History.rdoc
 - LEGAL.rdoc
 - LICENSE.rdoc
-- README.rdoc
+- README.md
 - RI.md
 - TODO.rdoc
 - exe/rdoc
@@ -96,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
@@ -104,6 +133,31 @@ 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.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
@@ -244,6 +298,7 @@ files:
 - lib/rdoc/version.rb
 - lib/rubygems_plugin.rb
 - man/ri.1
+- rdoc.gemspec
 homepage: https://ruby.github.io/rdoc
 licenses:
 - Ruby
@@ -253,7 +308,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
@@ -267,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.2'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: []

data/README.rdoc

@@ -1,142 +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
-  # 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@Bugs 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.