rdoc 3.9.3 → 3.9.4
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of rdoc might be problematic. Click here for more details.
- data.tar.gz.sig +0 -0
- data/History.txt +5 -0
- data/lib/rdoc.rb +1 -1
- data/lib/rdoc/markup.rb +6 -6
- data/lib/rdoc/parser.rb +10 -11
- metadata +5 -5
- metadata.gz.sig +0 -0
data.tar.gz.sig
CHANGED
Binary file
|
data/History.txt
CHANGED
data/lib/rdoc.rb
CHANGED
data/lib/rdoc/markup.rb
CHANGED
@@ -36,7 +36,7 @@ require 'rdoc'
|
|
36
36
|
# sequences, and to add special processing for text that matches a
|
37
37
|
# regular expression. Here we make WikiWords significant to the parser,
|
38
38
|
# and also make the sequences {word} and \<no>text...</no> signify
|
39
|
-
# strike-through text.
|
39
|
+
# strike-through text. We then subclass the HTML output class to deal
|
40
40
|
# with these:
|
41
41
|
#
|
42
42
|
# require 'rdoc/markup'
|
@@ -61,7 +61,7 @@ require 'rdoc'
|
|
61
61
|
#
|
62
62
|
# == Encoding
|
63
63
|
#
|
64
|
-
# Where Encoding support is available RDoc will automatically convert all
|
64
|
+
# Where Encoding support is available, RDoc will automatically convert all
|
65
65
|
# documents to the same output encoding. The output encoding can be set via
|
66
66
|
# RDoc::Options#encoding and defaults to Encoding.default_external.
|
67
67
|
#
|
@@ -127,7 +127,7 @@ require 'rdoc'
|
|
127
127
|
# === Simple Lists
|
128
128
|
#
|
129
129
|
# If a paragraph starts with a "*", "-", "<digit>." or "<letter>.",
|
130
|
-
# then it is taken to be the start of a list. The margin
|
130
|
+
# then it is taken to be the start of a list. The margin is increased to be
|
131
131
|
# the first non-space following the list start flag. Subsequent lines
|
132
132
|
# should be indented to this new margin until the list ends. For example:
|
133
133
|
#
|
@@ -444,10 +444,10 @@ require 'rdoc'
|
|
444
444
|
#
|
445
445
|
# [+:nodoc:+ / <tt>:nodoc: all</tt>]
|
446
446
|
# This directive prevents documentation for the element from
|
447
|
-
# being generated. For classes and modules,
|
447
|
+
# being generated. For classes and modules, methods, aliases,
|
448
448
|
# constants, and attributes directly within the affected class or
|
449
449
|
# module also will be omitted. By default, though, modules and
|
450
|
-
# classes within that class
|
450
|
+
# classes within that class or module _will_ be documented. This is
|
451
451
|
# turned off by adding the +all+ modifier.
|
452
452
|
#
|
453
453
|
# module MyModule # :nodoc:
|
@@ -591,7 +591,7 @@ class RDoc::Markup
|
|
591
591
|
attr_reader :attribute_manager
|
592
592
|
|
593
593
|
##
|
594
|
-
# Take a block of text and use various heuristics to determine
|
594
|
+
# Take a block of text and use various heuristics to determine its
|
595
595
|
# structure (paragraphs, lists, and so on). Invoke an event handler as we
|
596
596
|
# identify significant chunks.
|
597
597
|
|
data/lib/rdoc/parser.rb
CHANGED
@@ -4,9 +4,9 @@ require 'rdoc/markup/pre_process'
|
|
4
4
|
require 'rdoc/stats'
|
5
5
|
|
6
6
|
##
|
7
|
-
# A parser is
|
7
|
+
# A parser is a class that subclasses RDoc::Parser and implements
|
8
8
|
#
|
9
|
-
# #initialize
|
9
|
+
# #initialize top_level, file_name, body, options, stats
|
10
10
|
#
|
11
11
|
# and
|
12
12
|
#
|
@@ -16,17 +16,16 @@ require 'rdoc/stats'
|
|
16
16
|
# and an RDoc::Options object. The scan method is then called to return an
|
17
17
|
# appropriately parsed TopLevel code object.
|
18
18
|
#
|
19
|
-
#
|
20
|
-
# filename extension.
|
21
|
-
#
|
22
|
-
# following incantation
|
19
|
+
# RDoc::Parser::for is a factory that creates the correct parser for a
|
20
|
+
# given filename extension. Parsers have to register themselves RDoc::Parser
|
21
|
+
# using parse_files_matching as when they are loaded:
|
23
22
|
#
|
24
23
|
# require "rdoc/parser"
|
25
24
|
#
|
26
25
|
# class RDoc::Parser::Xyz < RDoc::Parser
|
27
26
|
# parse_files_matching /\.xyz$/ # <<<<
|
28
27
|
#
|
29
|
-
# def initialize
|
28
|
+
# def initialize top_level, file_name, body, options, stats
|
30
29
|
# ...
|
31
30
|
# end
|
32
31
|
#
|
@@ -35,8 +34,8 @@ require 'rdoc/stats'
|
|
35
34
|
# end
|
36
35
|
# end
|
37
36
|
#
|
38
|
-
#
|
39
|
-
#
|
37
|
+
# If a plain text file is detected, RDoc also looks for a shebang line in case
|
38
|
+
# the file is a shell script.
|
40
39
|
|
41
40
|
class RDoc::Parser
|
42
41
|
|
@@ -45,8 +44,8 @@ class RDoc::Parser
|
|
45
44
|
class << self
|
46
45
|
|
47
46
|
##
|
48
|
-
#
|
49
|
-
# will
|
47
|
+
# An Array of arrays that maps file extension (or name) regular
|
48
|
+
# expressions to parser classes that will parse matching filenames.
|
50
49
|
#
|
51
50
|
# Use parse_files_matching to register a parser's file extensions.
|
52
51
|
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rdoc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
hash:
|
4
|
+
hash: 43
|
5
5
|
prerelease:
|
6
6
|
segments:
|
7
7
|
- 3
|
8
8
|
- 9
|
9
|
-
-
|
10
|
-
version: 3.9.
|
9
|
+
- 4
|
10
|
+
version: 3.9.4
|
11
11
|
platform: ruby
|
12
12
|
authors:
|
13
13
|
- Eric Hodel
|
@@ -39,7 +39,7 @@ cert_chain:
|
|
39
39
|
x52qPcexcYZR7w==
|
40
40
|
-----END CERTIFICATE-----
|
41
41
|
|
42
|
-
date: 2011-08-
|
42
|
+
date: 2011-08-26 00:00:00 Z
|
43
43
|
dependencies:
|
44
44
|
- !ruby/object:Gem::Dependency
|
45
45
|
name: minitest
|
@@ -351,7 +351,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
351
351
|
requirements: []
|
352
352
|
|
353
353
|
rubyforge_project: rdoc
|
354
|
-
rubygems_version: 1.8.
|
354
|
+
rubygems_version: 1.8.9
|
355
355
|
signing_key:
|
356
356
|
specification_version: 3
|
357
357
|
summary: RDoc produces HTML and command-line documentation for Ruby projects
|
metadata.gz.sig
CHANGED
Binary file
|