diff options
author | BurdetteLamar <burdettelamar@yahoo.com> | 2024-01-04 16:17:01 +0000 |
---|---|---|
committer | git <svn-admin@ruby-lang.org> | 2024-01-04 21:27:58 +0000 |
commit | 10b9679fa61f40c08ec28ec34251f7ec8648054d (patch) | |
tree | 754c02f6c10046651e2fadc7b42a48e70ab68124 /doc | |
parent | d65d2fb6b5c56c495f2f98f8e6ac5994ad5d93dd (diff) | |
download | ruby-10b9679fa61f40c08ec28ec34251f7ec8648054d.tar.gz |
[ruby/rdoc] Tweaks to Markup Reference
https://github.com/ruby/rdoc/commit/05ac6dba66
Diffstat (limited to 'doc')
-rw-r--r-- | doc/rdoc/markup_reference.rb | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/rdoc/markup_reference.rb b/doc/rdoc/markup_reference.rb index 9e51cc4f0c..17da68bb1d 100644 --- a/doc/rdoc/markup_reference.rb +++ b/doc/rdoc/markup_reference.rb @@ -463,8 +463,8 @@ require 'rdoc' # # - Specifies that the defined object should not be documented. # -# - For method definitions in C code, it must be placed before the -# implementation: +# - For a method definition in C code, it the directive must be in the comment line +# immediately preceding the definition: # # /* :nodoc: */ # static VALUE @@ -473,8 +473,8 @@ require 'rdoc' # return self; # } # -# Note that this directive has <em>no effect at all</em> at method -# definition places. E.g., +# Note that this directive has <em>no effect at all</em> +# when placed at the method declaration: # # /* :nodoc: */ # rb_define_method(cMyClass, "do_something", something_func, 0); @@ -483,8 +483,8 @@ require 'rdoc' # Therefore, +do_something+ method will be reported as "undocumented" # unless that method or function is documented elsewhere. # -# - For constant definitions in C code, this directive <em>can not work</em> -# because there is no "implementation" place for constants. +# - For a constant definition in C code, this directive <em>can not work</em> +# because there is no "implementation" place for a constant. # # - <tt># :nodoc: all</tt>: # @@ -497,7 +497,7 @@ require 'rdoc' # # - Appended to a line of code # 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. # # - <tt># :notnew:</tt> (aliased as <tt>:not_new:</tt> and <tt>:not-new:</tt>): @@ -1209,26 +1209,26 @@ require 'rdoc' # class RDoc::MarkupReference - # example class + # Example class. class DummyClass; end - # example module + # Example module. module DummyModule; end - # example singleton method + # Example singleton method. def self.dummy_singleton_method(foo, bar); end - # example instance method + # Example instance method. def dummy_instance_method(foo, bar); end; alias dummy_instance_alias dummy_instance_method - # example attribute + # Example attribute. attr_accessor :dummy_attribute alias dummy_attribute_alias dummy_attribute - # example constant + # Example constant. DUMMY_CONSTANT = '' # :call-seq: |