ruby.git/lib/rdoc/generator/template/darkfish/class.rhtml, branch v3_3_11

[ruby/rdoc] Omit descriptions and parameter lists for methods defined in C not mentioned in call-seq

2023-09-05T00:45:42+00:00

This allows RDoc to better generate documentation for methods
following the Ruby core documentation guide (which omits aliases
in call-seq in most cases).  This makes documentation for methods
defined in C more similar to methods defined in Ruby.  For methods
defined in Ruby, the method description of the aliased method is
already not used (you have to explicitly document the alias to
use it).

Internally, this adds AnyMethod#has_call_seq? and #skip_description?,
and updates Darkfish to:

* only show the method name if there is a call-seq for the method,
  but the call-seq omits the method
* to omit the method description if the method is an alias or has
  aliases and has a call-seq that does not include the method

See discussion in https://github.com/ruby/ruby/pull/7316 for
details.

https://github.com/ruby/rdoc/commit/e3688de49b

[ruby/rdoc] Darkfish: group method call-seq in div.method-header

2022-11-27T17:24:17+00:00

This way, custom CSS styles can be easily applied to the entire method
header at once.  Otherwise, it can be tricky to make a border that goes
around the entire set of method call-seq, but not the method
description.

https://github.com/ruby/rdoc/commit/5db4bce01e

[ruby/rdoc] Remove empty lines from html file by using ERB trim_mode flag

2020-07-21T17:34:58+00:00

https://github.com/ruby/rdoc/commit/9e27299a46

[ruby/rdoc] Treat multiple Ruby methods calling the same C method as aliases

2020-05-24T14:47:24+00:00

Previously, only calls to rb_define_alias were treated as aliases.
This treats calls to rb_define_method with the same C function as
aliases, with the first function defined being the primary method.

This move the dedup code from the C parser to AnyMethod, and has
AnyMethod look in its aliases to find the call_seq.

Switch the deduplication code to remove lines matching one of the
other aliases, instead of only keeping lines matching the current
alias.  The previous approach could eliminate all call_seq lines
in cases where no line matched.  This was necessary to pass
tests when call_seq does deduplication by default.

The only change to the darkfish template is to not perform
unnecessary work by deduplicating twice.

https://github.com/ruby/rdoc/commit/0ead78616b

Merge rdoc-6.0.0.beta3.

2017-10-10T02:01:00+00:00

  * It version introduced did you mean? feature for ri command:
    https://github.com/ruby/rdoc/pull/533
  * Removed obbsoleted ruby_token.rbb.
    [Bug #13990][ruby-core:83180]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60146 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Merge rdoc-6.0.0.beta1.

2017-08-29T11:52:50+00:00

  This version fixed strange behavior of ruby code parser.
  We will list all of impromovement to Changelog when 6.0.0 releasing.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59686 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

* lib/rdoc: Update to RDoc 4.1.0.preview.1

2013-09-18T23:33:36+00:00

  RDoc 4.1.0 contains a number of enhancements including a new default
  style and accessibility support.  You can see the changelog here:

  https://github.com/rdoc/rdoc/blob/v4.1.0.preview.1/History.rdoc

* test/rdoc:  ditto.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42971 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

* lib/rdoc*: Updated to RDoc 4.0 (pre-release)

2012-11-27T04:28:14+00:00

* bin/rdoc:  ditto
* test/rdoc:  ditto
* NEWS:  Updated with RDoc 4.0 information


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37889 b2dd03c8-39d4-4d8f-98ff-823fe69b080e