Skip to content

[DOC] Mods about markup formats #1143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/rdoc/markup_reference.rb
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,8 @@
#
# - Appears on a line by itself.
# - Specifies the format for the \RDoc input;
# parameter +type+ is one of +markdown+, +rd+, +rdoc+, +tomdoc+.
# parameter +type+ is one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
# See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
#
# ===== Directives for HTML Output
#
Expand Down
31 changes: 18 additions & 13 deletions lib/rdoc/markup.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,24 @@
# RDoc::Markup and other markup formats do no output formatting, this is
# handled by the RDoc::Markup::Formatter subclasses.
#
# = Supported Formats
#
# Besides the RDoc::Markup format, the following formats are built in to RDoc:
#
# markdown::
# The markdown format as described by
# http://daringfireball.net/projects/markdown/. See RDoc::Markdown for
# details on the parser and supported extensions.
# rd::
# The rdtool format. See RDoc::RD for details on the parser and format.
# tomdoc::
# The TomDoc format as described by http://tomdoc.org/. See RDoc::TomDoc
# for details on the parser and supported extensions.
# = Markup Formats
#
# +RDoc+ supports these markup formats:
#
# - +rdoc+:
# the +RDoc+ markup format;
# see RDoc::MarkupReference.
# - +markdown+:
# The +markdown+ markup format as described in
# the {Markdown Guide}[https://www.markdownguide.org];
# see RDoc::Markdown.
# - +rd+:
# the +rd+ markup format format;
# see RDoc::RD.
# - +tomdoc+:
# the TomDoc format as described in
# {TomDoc for Ruby}[http://tomdoc.org];
# see RDoc::TomDoc.
#
# You can choose a markup format using the following methods:
#
Expand Down
6 changes: 3 additions & 3 deletions lib/rdoc/options.rb
Original file line number Diff line number Diff line change
Expand Up @@ -233,9 +233,9 @@ class RDoc::Options
attr_accessor :main_page

##
# The default markup format. The default is 'rdoc'. 'markdown', 'tomdoc'
# and 'rd' are also built-in.

# The markup format.
# One of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
# See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
attr_accessor :markup

##
Expand Down
5 changes: 2 additions & 3 deletions lib/rdoc/task.rb
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,8 @@ class RDoc::Task < Rake::TaskLib
attr_accessor :name

##
# Comment markup format. rdoc, rd and tomdoc are supported. (default is
# 'rdoc')

# The markup format; one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
# See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
attr_accessor :markup

##
Expand Down
8 changes: 1 addition & 7 deletions lib/rdoc/tom_doc.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,7 @@

# A parser for TomDoc based on TomDoc 1.0.0-rc1 (02adef9b5a)
#
# The TomDoc specification can be found at:
#
# http://tomdoc.org
#
# The latest version of the TomDoc specification can be found at:
#
# https://github.com/mojombo/tomdoc/blob/master/tomdoc.md
# The TomDoc specification can be found at http://tomdoc.org.
#
# To choose TomDoc as your only default format see RDoc::Options@Saved+Options
# for instructions on setting up a <code>.rdoc_options</code> file to store
Expand Down