зеркало из https://github.com/github/ruby.git
[ruby/rdoc] Don't document aliases with trailing `:nodoc` directive
Attribute readers and writers can be marked as `:nodoc` to keep them undocumented: ```ruby attr_reader :name # :nodoc: ``` For aliases this behaviour should be the same: ```ruby alias_method :old :new # :nodoc: ``` https://github.com/ruby/rdoc/commit/30f14e8271
This commit is contained in:
Родитель
5d32e328d9
Коммит
2a57e6e6ed
|
@ -789,8 +789,10 @@ class RDoc::Parser::Ruby < RDoc::Parser
|
||||||
al.line = line_no
|
al.line = line_no
|
||||||
|
|
||||||
read_documentation_modifiers al, RDoc::ATTR_MODIFIERS
|
read_documentation_modifiers al, RDoc::ATTR_MODIFIERS
|
||||||
|
if al.document_self or not @track_visibility
|
||||||
context.add_alias al
|
context.add_alias al
|
||||||
@stats.add_alias al
|
@stats.add_alias al
|
||||||
|
end
|
||||||
|
|
||||||
al
|
al
|
||||||
end
|
end
|
||||||
|
|
|
@ -3065,6 +3065,28 @@ RUBY
|
||||||
assert_nil m.params, 'Module parameter not removed'
|
assert_nil m.params, 'Module parameter not removed'
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def test_parse_statements_nodoc_identifier_alias
|
||||||
|
klass = @top_level.add_class RDoc::NormalClass, 'Foo'
|
||||||
|
|
||||||
|
util_parser "\nalias :old :new # :nodoc:"
|
||||||
|
|
||||||
|
@parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil
|
||||||
|
|
||||||
|
assert_empty klass.aliases
|
||||||
|
assert_empty klass.unmatched_alias_lists
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_parse_statements_nodoc_identifier_alias_method
|
||||||
|
klass = @top_level.add_class RDoc::NormalClass, 'Foo'
|
||||||
|
|
||||||
|
util_parser "\nalias_method :old :new # :nodoc:"
|
||||||
|
|
||||||
|
@parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil
|
||||||
|
|
||||||
|
assert_empty klass.aliases
|
||||||
|
assert_empty klass.unmatched_alias_lists
|
||||||
|
end
|
||||||
|
|
||||||
def test_parse_statements_stopdoc_alias
|
def test_parse_statements_stopdoc_alias
|
||||||
klass = @top_level.add_class RDoc::NormalClass, 'Foo'
|
klass = @top_level.add_class RDoc::NormalClass, 'Foo'
|
||||||
|
|
||||||
|
|
Загрузка…
Ссылка в новой задаче