Skip to content

Commit f7dd147

Browse files
committed
[DOC] nodoc for probably internal methods
1 parent e4c9034 commit f7dd147

File tree

7 files changed

+16
-1
lines changed

7 files changed

+16
-1
lines changed

lib/rdoc/generator/pot.rb

+1
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ def generate
8181
end
8282
end
8383

84+
# :nodoc:
8485
def class_dir
8586
nil
8687
end

lib/rdoc/markup/attribute_manager.rb

+3
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ def copy_string(start_pos, end_pos)
138138
res
139139
end
140140

141+
# :nodoc:
141142
def exclusive?(attr)
142143
(attr & @exclusive_bitmap) != 0
143144
end
@@ -155,6 +156,7 @@ def convert_attrs(str, attrs, exclusive = false)
155156
convert_attrs_word_pair_map(str, attrs, exclusive)
156157
end
157158

159+
# :nodoc:
158160
def convert_attrs_matching_word_pairs(str, attrs, exclusive)
159161
# first do matching ones
160162
tags = @matching_word_pairs.select { |start, bitmap|
@@ -179,6 +181,7 @@ def convert_attrs_matching_word_pairs(str, attrs, exclusive)
179181
str.delete!(NON_PRINTING_START + NON_PRINTING_END)
180182
end
181183

184+
# :nodoc:
182185
def convert_attrs_word_pair_map(str, attrs, exclusive)
183186
# then non-matching
184187
unless @word_pair_map.empty? then

lib/rdoc/markup/parser.rb

+4
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,8 @@ def peek_token
420420
# A simple wrapper of StringScanner that is aware of the current column and lineno
421421

422422
class MyStringScanner
423+
# :stopdoc:
424+
423425
def initialize(input)
424426
@line = @column = 0
425427
@s = StringScanner.new input
@@ -456,6 +458,8 @@ def matched
456458
def [](i)
457459
@s[i]
458460
end
461+
462+
#:startdoc:
459463
end
460464

461465
##

lib/rdoc/markup/table.rb

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ def initialize header, align, body
1717
@header, @align, @body = header, align, body
1818
end
1919

20+
# :stopdoc:
2021
def == other
2122
self.class == other.class and
2223
@header == other.header and
@@ -28,7 +29,7 @@ def accept visitor
2829
visitor.accept_table @header, @body, @align
2930
end
3031

31-
def pretty_print q # :nodoc:
32+
def pretty_print q
3233
q.group 2, '[Table: ', ']' do
3334
q.group 2, '[Head: ', ']' do
3435
q.seplist @header.zip(@align) do |text, align|

lib/rdoc/markup/to_html.rb

+1
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ def initialize options, markup = nil
6161
#
6262
# These methods are used by regexp handling markup added by RDoc::Markup#add_regexp_handling.
6363

64+
# :nodoc:
6465
URL_CHARACTERS_REGEXP_STR = /[A-Za-z0-9\-._~:\/\?#\[\]@!$&'\(\)*+,;%=]/.source
6566

6667
##

lib/rdoc/markup/to_html_crossref.rb

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ def initialize(options, from_path, context, markup = nil)
4242
@cross_reference = RDoc::CrossReference.new @context
4343
end
4444

45+
# :nodoc:
4546
def init_link_notation_regexp_handlings
4647
add_regexp_handling_RDOCLINK
4748

lib/rdoc/parser/ripper_state_lex.rb

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
# Wrapper for Ripper lex states
66

77
class RDoc::Parser::RipperStateLex
8+
# :stopdoc:
9+
810
# TODO: Remove this constants after Ruby 2.4 EOL
911
RIPPER_HAS_LEX_STATE = Ripper::Filter.method_defined?(:state)
1012

@@ -568,6 +570,8 @@ def get_squashed_tk
568570
tk
569571
end
570572

573+
# :startdoc:
574+
571575
# New lexer for +code+.
572576
def initialize(code)
573577
@buf = []

0 commit comments

Comments
 (0)