Class: RDoc::Generator::Mdoc

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/generator/mdoc.rb,
lib/rdoc/generator/mdoc/unknown_module.rb,
lib/rdoc/generator/mdoc/render_context.rb,
lib/rdoc/generator/mdoc/unknown_class.rb,
lib/rdoc/generator/mdoc/formatter.rb,
lib/rdoc/generator/mdoc/attribute.rb,
lib/rdoc/generator/mdoc/constant.rb,
lib/rdoc/generator/mdoc/section.rb,
lib/rdoc/generator/mdoc/helpers.rb,
lib/rdoc/generator/mdoc/comment.rb,
lib/rdoc/generator/mdoc/module.rb,
lib/rdoc/generator/mdoc/method.rb,
lib/rdoc/generator/mdoc/class.rb

Overview

An mdoc(7) generator for RDoc.

This generator will create man pages in mdoc(7) format for classes, modules and methods parsed by RDoc.

Defined Under Namespace

Modules: Helpers Classes: Attribute, Class, Comment, Constant, Formatter, Method, Module, RenderContext, Section, UnknownClass, UnknownModule

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(store, options) ⇒ Mdoc

Create an instance usign the provided RDoc::Store and RDoc::Options.



27
28
29
30
31
32
33
34
 
# File 'lib/rdoc/generator/mdoc.rb', line 27

def initialize(store, options)
  @store = store
  @mandb_section = sanitize_mandb_section(
    options.mandb_section || "3-rdoc",
  )
  @output_directory = File.expand_path(File.join(options.op_dir, "man#{mandb_section.split('-').first}"))
  FileUtils.mkdir_p output_directory
end

Class Method Details

.setup_options(options) ⇒ Object 



19
20
21
22
23
 
# File 'lib/rdoc/generator/mdoc.rb', line 19

def self.setup_options(options)
  options.option_parser.on("--section SECTION", String) do |mandb_section|
    options.mandb_section = mandb_section
  end
end

Instance Method Details

#generate ⇒ Object

Generate man pages.

Every class, module and method gets their own man page in the “manSECTION_PREFIX” subdirectory of the output directory.



41
42
43
44
 
# File 'lib/rdoc/generator/mdoc.rb', line 41

def generate
  generate_class_and_module_pages
  generate_method_pages
end