Skip to content

Commit effa79f

Browse files
committed
Added an RDoc glossary
1 parent 39fe750 commit effa79f

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

DEVELOPERS.rdoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,46 @@ the issue. Here are some examples of good issues:
1717
* https://github.com/rdoc/rdoc/issues/55
1818
* https://github.com/rdoc/rdoc/issues/61
1919

20+
== Glossary
21+
22+
Here are definitions for some common terms in the RDoc documentation. The
23+
list also briefly describes how the components of RDoc interact.
24+
25+
parser::
26+
Parses files and creates a documentation tree from the contents.
27+
28+
documentation tree::
29+
The documentation tree represents files, classes, modules, methods,
30+
constants, includes, comments and other ruby syntax features as a tree.
31+
RDoc walks this tree with a generator to create documentation.
32+
33+
generator::
34+
Walks the documentation tree and generates output.
35+
36+
RDoc ships with two generators, the Darkfish generator creates HTML and the
37+
RI generator creates an RI data store.
38+
39+
markup parser::
40+
Parses comments from a file into a generic markup tree.
41+
42+
The markup parsers allow RDoc to handle RDoc, TomDoc, rd and Markdown format
43+
documentation with common formatters.
44+
45+
markup tree::
46+
Each parsed comment has a markup tree that represents common markup items
47+
such as headings, paragraphs, lists orverbatim text sections for example
48+
code or output.
49+
50+
A generator uses a formatters to walks the tree to create output. Some
51+
generators use multiple formatters on a markup tree to produce the output.
52+
53+
formatter::
54+
Converts a parsed markup tree into some form other form of markup.
55+
56+
Formatters can either produce a one-to-one conversion, such as ToHtml, or
57+
extract part of the parsed result, such as ToHtmlSnippet which outputs the
58+
first 100 characters as HTML.
59+
2060
== Plugins
2161

2262
When 'rdoc/rdoc' is loaded RDoc looks for 'rdoc/discover' files in your

0 commit comments

Comments
 (0)