Skip to content

Commit 011de3f

Browse files
[DOC] Mods about markup formats (#1143)
1 parent 1bb3bec commit 011de3f

File tree

5 files changed

+26
-27
lines changed

5 files changed

+26
-27
lines changed

doc/rdoc/markup_reference.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,8 @@
532532
#
533533
# - Appears on a line by itself.
534534
# - Specifies the format for the \RDoc input;
535-
# parameter +type+ is one of +markdown+, +rd+, +rdoc+, +tomdoc+.
535+
# parameter +type+ is one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
536+
# See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
536537
#
537538
# ===== Directives for HTML Output
538539
#

lib/rdoc/markup.rb

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,24 @@
1010
# RDoc::Markup and other markup formats do no output formatting, this is
1111
# handled by the RDoc::Markup::Formatter subclasses.
1212
#
13-
# = Supported Formats
14-
#
15-
# Besides the RDoc::Markup format, the following formats are built in to RDoc:
16-
#
17-
# markdown::
18-
# The markdown format as described by
19-
# http://daringfireball.net/projects/markdown/. See RDoc::Markdown for
20-
# details on the parser and supported extensions.
21-
# rd::
22-
# The rdtool format. See RDoc::RD for details on the parser and format.
23-
# tomdoc::
24-
# The TomDoc format as described by http://tomdoc.org/. See RDoc::TomDoc
25-
# for details on the parser and supported extensions.
13+
# = Markup Formats
14+
#
15+
# +RDoc+ supports these markup formats:
16+
#
17+
# - +rdoc+:
18+
# the +RDoc+ markup format;
19+
# see RDoc::MarkupReference.
20+
# - +markdown+:
21+
# The +markdown+ markup format as described in
22+
# the {Markdown Guide}[https://www.markdownguide.org];
23+
# see RDoc::Markdown.
24+
# - +rd+:
25+
# the +rd+ markup format format;
26+
# see RDoc::RD.
27+
# - +tomdoc+:
28+
# the TomDoc format as described in
29+
# {TomDoc for Ruby}[http://tomdoc.org];
30+
# see RDoc::TomDoc.
2631
#
2732
# You can choose a markup format using the following methods:
2833
#

lib/rdoc/options.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,9 @@ class RDoc::Options
233233
attr_accessor :main_page
234234

235235
##
236-
# The default markup format. The default is 'rdoc'. 'markdown', 'tomdoc'
237-
# and 'rd' are also built-in.
238-
236+
# The markup format.
237+
# One of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
238+
# See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
239239
attr_accessor :markup
240240

241241
##

lib/rdoc/task.rb

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,8 @@ class RDoc::Task < Rake::TaskLib
104104
attr_accessor :name
105105

106106
##
107-
# Comment markup format. rdoc, rd and tomdoc are supported. (default is
108-
# 'rdoc')
109-
107+
# The markup format; one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
108+
# See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
110109
attr_accessor :markup
111110

112111
##

lib/rdoc/tom_doc.rb

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,7 @@
33

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

0 commit comments

Comments
 (0)