1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[ruby/rdoc] Tweaks to Markup Reference

Browse Source 
https://github.com/ruby/rdoc/commit/05ac6dba66
This commit is contained in:
BurdetteLamar 2024-01-04 16:17:01 +00:00 committed by git
parent d65d2fb6b5
commit 10b9679fa6
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/rdoc/markup_reference.rb
View File

@ -463,8 +463,8 @@ require 'rdoc'
# #
# - Specifies that the defined object should not be documented. # - Specifies that the defined object should not be documented.
# #
# - For method definitions in C code, it must be placed before the # - For a method definition in C code, it the directive must be in the comment line
# implementation: # immediately preceding the definition:
# #
# /* :nodoc: */ # /* :nodoc: */
# static VALUE # static VALUE
@ -473,8 +473,8 @@ require 'rdoc'
# return self; # return self;
# } # }
# #
# Note that this directive has <em>no effect at all</em> at method # Note that this directive has <em>no effect at all</em>
# definition places. E.g., # when placed at the method declaration:
# #
# /* :nodoc: */ # /* :nodoc: */
# rb_define_method(cMyClass, "do_something", something_func, 0); # rb_define_method(cMyClass, "do_something", something_func, 0);
@ -483,8 +483,8 @@ require 'rdoc'
# Therefore, +do_something+ method will be reported as "undocumented" # Therefore, +do_something+ method will be reported as "undocumented"
# unless that method or function is documented elsewhere. # unless that method or function is documented elsewhere.
# #
# - For constant definitions in C code, this directive <em>can not work</em> # - For a constant definition in C code, this directive <em>can not work</em>
# because there is no "implementation" place for constants. # because there is no "implementation" place for a constant.
# #
# - <tt># :nodoc: all</tt>: # - <tt># :nodoc: all</tt>:
# #
@ -497,7 +497,7 @@ require 'rdoc'
# #
# - Appended to a line of code # - Appended to a line of code
# that defines a class, module, method, alias, constant, or attribute. # that defines a class, module, method, alias, constant, or attribute.
# - Specifies the defined object should be documented, even if otherwise # - Specifies the defined object should be documented, even if it otherwise
# would not be documented. # would not be documented.
# #
# - <tt># :notnew:</tt> (aliased as <tt>:not_new:</tt> and <tt>:not-new:</tt>): # - <tt># :notnew:</tt> (aliased as <tt>:not_new:</tt> and <tt>:not-new:</tt>):
@ -1209,26 +1209,26 @@ require 'rdoc'
# #
class RDoc::MarkupReference class RDoc::MarkupReference
# example class # Example class.
class DummyClass; end class DummyClass; end
# example module # Example module.
module DummyModule; end module DummyModule; end
# example singleton method # Example singleton method.
def self.dummy_singleton_method(foo, bar); end def self.dummy_singleton_method(foo, bar); end
# example instance method # Example instance method.
def dummy_instance_method(foo, bar); end; def dummy_instance_method(foo, bar); end;
alias dummy_instance_alias dummy_instance_method alias dummy_instance_alias dummy_instance_method
# example attribute # Example attribute.
attr_accessor :dummy_attribute attr_accessor :dummy_attribute
alias dummy_attribute_alias dummy_attribute alias dummy_attribute_alias dummy_attribute
# example constant # Example constant.
DUMMY_CONSTANT = '' DUMMY_CONSTANT = ''
# :call-seq: # :call-seq: