{
    "mode": "ri",
    "parameter": "RDoc",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/ri/RDoc/json",
    "generated": "2026-06-02T15:01:46Z",
    "sections": {
        "RDoc": {
            "content": "(from gem rdoc-7.2.0)\n------------------------------------------------------------------------\nRDoc produces documentation for Ruby source files by parsing the source\nand extracting the definition for classes, modules, methods, includes\nand requires.  It associates these with optional documentation contained\nin an immediately preceding comment block then renders the result using\nan output formatter.\n\nFor a simple introduction to writing or generating documentation using\nRDoc see the README.\n",
            "subsections": [
                {
                    "name": "Roadmap",
                    "content": "If you think you found a bug in RDoc see CONTRIBUTING@Bugs\n\nIf you want to use RDoc to create documentation for your Ruby source\nfiles, see RDoc::Markup and refer to rdoc --help for command line usage.\n\nIf you want to set the default markup format see\nRDoc::Markup@Markup+Formats\n\nIf you want to store rdoc configuration in your gem (such as the default\nmarkup format) see RDoc::Options@Saved+Options\n\nIf you want to write documentation for Ruby files see RDoc::Parser::Ruby\n\nIf you want to write documentation for extensions written in C see\nRDoc::Parser::C\n\nIf you want to generate documentation using rake see RDoc::Task.\n\nIf you want to drive RDoc programmatically, see RDoc::RDoc.\n\nIf you want to use the library to format text blocks into HTML or other\nformats, look at RDoc::Markup.\n\nIf you want to make an RDoc plugin such as a generator or directive\nhandler see RDoc::RDoc.\n\nIf you want to write your own output generator see RDoc::Generator.\n\nIf you want an overview of how RDoc works see CONTRIBUTING\n"
                },
                {
                    "name": "Credits",
                    "content": "RDoc is currently being maintained by Eric Hodel <drbrain@segment7.net>.\n\nDave Thomas <dave@pragmaticprogrammer.com> is the original author of\nRDoc.\n\n* The Ruby parser in rdoc/parse.rb is based heavily on the outstanding\nwork of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby\nparser for irb and the rtags package.\n\n\n\n\n\n\n\n\nThis class is referenced by RubyGems to create documents. All\nimplementations are moved to the above RubyGemsHook.\n\nThis class does nothing when this RDoc is installed as a normal gem or a\nbundled gem.\n\nThis class does generate/remove documents for compatibility when this\nRDoc is installed as a default gem.\n\nWe can remove this when all maintained RubyGems remove rubygems/rdoc.rb.\n\n------------------------------------------------------------------------"
                }
            ]
        },
        "Constants:": {
            "content": "ATTRMODIFIERS:\nRDoc modifiers for attributes\n\nCLASSMODIFIERS:\nRDoc modifiers for classes\n\nCONSTANTMODIFIERS:\nRDoc modifiers for constants\n\nDOTDOCFILENAME:\nName of the dotfile that contains the description of files to be\nprocessed in the current directory\n\nGENERALMODIFIERS:\nGeneral RDoc modifiers\n\nKNOWNCLASSES:\nRuby's built-in classes, modules and exceptions\n\nMETHODMODIFIERS:\nRDoc modifiers for methods\n\nVERSION:\nRDoc version you are using\n\nVISIBILITIES:\nMethod visibilities\n\n",
            "subsections": []
        },
        "Class methods:": {
            "content": "home\nloadyaml\n",
            "subsections": []
        }
    },
    "flags": [],
    "examples": [],
    "see_also": []
}