docspring 3.0.0 → 3.1.0

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/LEGAL.rdoc

@@ -0,0 +1,50 @@
+# coding: UTF-8
+
+= Legal Notice Information
+
+The files in this distribution are covered by the Ruby license (see LICENSE) except the features mentioned below:
+
+Darkfish::
+  Darkfish was written by Michael Granger and is included under the BSD 3-Clause
+  license.  Darkfish contains images from the Silk Icons set by Mark James.
+
+  See lib/rdoc/generator/darkfish.rb for license information.
+
+  * lib/rdoc/generator/darkfish.rb
+  * lib/rdoc/generator/template/darkfish/*
+  * lib/rdoc/generator/template/darkfish/images
+
+SDoc::
+  Portions of SDoc by (Володя Колесников) Vladimir Kolesnikov are included
+  under the MIT license as RDoc::Generator::JsonIndex.  See
+  lib/rdoc/generator/json_index.rb for license information.
+
+  * lib/rdoc/generator/json_index.rb
+  * lib/rdoc/generator/template/json_index/*
+  * The +#search_index+ methods on RDoc::CodeObject subclasses were derived
+    from sdoc.
+  * RDoc::ClassModule#document_self_or_methods comes from SDoc.
+
+peg-markdown::
+  RDoc's Markdown support is derived from peg-markdown by John MacFarlane.  It
+  is used under the MIT license.  See RDoc::Markdown for license details.
+
+MarkdownTest::
+  test/test_rdoc_markdown_test.rb uses MarkdownTest 1.0.3's source files which
+  are included as test/MarkdownTest_1.0.3/*.text which are Copyright (c)
+  2004-2005 John Gruber http://daringfireball.net and is included under the
+  same terms as Perl itself.
+
+  See http://dev.perl.org/licenses/ for the terms of the Perl license.
+
+Fonts::
+  Source Code Pro is (c) 2010, 2012 Adobe Systems Incorporated.
+
+  Lato is (c) 2010 Łukasz Dziedzic.
+
+  Both fonts are used under the SIL Open Font License, Version 1.1.  The
+  license is available at http://scripts.sil.org/OFL
+
+  See lib/rdoc/generator/template/darkfish/fonts.css for complete copyright
+  and license information, including a copy of the OFL.
+

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/LICENSE.rdoc

@@ -0,0 +1,59 @@
+= License
+
+RDoc is copyrighted free software.
+
+You can redistribute it and/or modify it under either the terms of the GPL
+version 2 (see the file GPL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. 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.

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/README.rdoc

@@ -0,0 +1,142 @@
+= \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.