Commit graph

380 commits

Author SHA1 Message Date
Nobuyoshi Nakada
d6741572ef [ruby/rdoc] Undo accidentally deleted lines
4e14158255
2024-01-11 08:39:52 +00:00
Nobuyoshi Nakada
7558625be1 [ruby/rdoc] Respect modeline to detect parser
485468f06f
2024-01-11 06:55:39 +00:00
Nobuyoshi Nakada
7fcc6f04ac [ruby/rdoc] Visibility should begin from public for each scope
Even for singleton class definition such as `class << self` that
shares the same container with the outer scope, its visibility is
separated and set to `public` by default.

baf26363b9
2024-01-07 11:39:46 +00:00
Nobuyoshi Nakada
2325b72cf3 [ruby/rdoc] Singleton method visibility should be isolated
Each singleton method definition of the form `def recv.method` has
visibility separate from the outer scope and is set to `public` by
default.

810913a7ea
2024-01-07 11:39:45 +00:00
Nobuyoshi Nakada
d1de2a34c1 [ruby/rdoc] Rename and move the tests for --locale option [ci skip]
b2a35ee39d
2024-01-06 10:23:41 +00:00
Nobuyoshi Nakada
f6847e9456 [ruby/rdoc] Ignore locale at write_options
`@locale` is set from `@locale_name` and loaded from `@locale_dir`
after `write_options`, and `RDoc::I18n::Locale` does not seem to
expected to be loaded.

fd610f7023
2024-01-06 10:17:49 +00:00
Nobuyoshi Nakada
569a06aa2f [ruby/rdoc] Allow empty name rdoc-ref as a local link
914a6af137
2023-12-31 15:19:50 +00:00
Nobuyoshi Nakada
e324953090 [ruby/rdoc] Fix support for rb_file_const and rb_curses_define_const
Constant definitions using these functions have been supported, but
since RDoc::Parser::C#gen_const_table did not consider other than
`rb_define_const` the documents for them have not been found, without
`Document-const` direvtive.

Fixes https://github.com/ruby/rdoc/issues/1067

cdad51a60b
2023-12-25 21:12:49 +09:00
Nobuyoshi Nakada
e03e872eea [ruby/rdoc] Only word-ending colon separates new definition
When followed by non-space characters, rather it looks like a URL or a
path name on Windows.

72c6560773
2023-12-06 09:35:44 +00:00
Nobuyoshi Nakada
8105ff9ac4 [ruby/rdoc] Use single quotes to keep backslash literally
4ac9be7f48
2023-12-06 09:35:43 +00:00
Nobuyoshi Nakada
113f5d7fd7 [ruby/rdoc] Allow any single-word token upto 2 before C method implementation
Previously only unknown word `intern` is allowed between a single-word
token before a C method.  Now any single-word token, such as `inline`
which is used for `ArithmeticSequence` in enumerator.c, is allowed
instead.

3a214c1dd1
2023-12-05 08:48:19 +00:00
toshimaru
cda431f538 [ruby/rdoc] fix: fix NoMethodError when token_stream is nil
The change in #1055 might be a breaking change.
So, just simply wrap `token_stream` with `Array`

d8c19d7fa1

Co-authored-by: Jonathan Hefner <jonathan@hefner.pro>
2023-12-05 06:21:51 +00:00
Nobuyoshi Nakada
c9c1670f7e [ruby/rdoc] Markup punctuations need to be separated with a space
83f0149fc1
2023-12-02 12:40:12 +00:00
Nobuyoshi Nakada
cc393b4f80 [ruby/rdoc] Get rid of Kernel#open
dc56f6d0bd
2023-11-30 15:06:51 +00:00
Nobuyoshi Nakada
196c4aeb76 [ruby/rdoc] Place a space between certain character class letters only
1f568e049d
2023-11-27 15:58:31 +00:00
toshimaru
72242e69aa [ruby/rdoc] fix: Fix NoMethodError for tokens_to_s method
Calling `tokens_to_s` gets an error if `token_stream` is nil:

```
undefined method `compact' for nil:NilClass (NoMethodError)
```

So, fall back to an empty array if `@token_stream` is nil.

452e4a2600
2023-11-16 01:43:12 +00:00
Nobuyoshi Nakada
9935512275 [ruby/rdoc] Fix TIDYLINK after braces
(https://github.com/ruby/rdoc/pull/1015)

TIDYLINK multi-word label should not include braces.

41ad3191e9
2023-11-14 07:59:56 +00:00
Jun Aruga
1f1b9b0942 [ruby/rdoc] test/rdoc/test_rdoc_generator_json_index.rb: pend in test_generate in ppc64le.
We observed that this test randomly fails in the ruby/ruby Travis ppc64le case.
This commit is to pend the test_generate if the assertion for the generated
file's modified time fails in a ppc64le environment.

Note that I didn't use the word "Travis CI" or Travis CI specific environment variables
such as `TRAVIS` and `TRAVIS_CPU_ARCH`[1] in the code. Because I wanted to prioritize the
rdoc's independence from the ruby/ruby.

[1] https://docs.travis-ci.com/user/environment-variables/#default-environment-variables

42cdad1cf2
2023-11-03 10:30:28 +00:00
Jun Aruga
674db715f5 [ruby/rdoc] test/rdoc/test_rdoc_generator_json_index.rb: Use assert_equal instead of assert.
It's better because assert_equal prints the values when it fails.

91d40ce8f8
2023-10-30 16:21:28 +00:00
Jeremy Evans
3f6c92e9d5 [ruby/rdoc] Omit descriptions and parameter lists for methods defined in C not mentioned in call-seq
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.

e3688de49b
2023-09-05 00:45:42 +00:00
theo-squadracer
a14ba622da [ruby/rdoc] handle symbols declared with %s
ed91c4b784
2023-09-05 00:37:30 +00:00
Petrik
0c55ef1150 [ruby/rdoc] Use flat_map for better performance
76192a280d
2023-06-14 23:47:25 +00:00
Vinicius Stock
a4d92475f6 [ruby/rdoc] Auto-correct trailing new lines
4b68c0728a
2023-06-03 01:42:29 +00:00
Nobuyoshi Nakada
3833d0fee6 [ruby/rdoc] Fix references to nested label in table_of_contents
Fixes https://github.com/ruby/rdoc/pull/1000

291e2b7e8b
2023-05-02 04:19:46 +00:00
Nobuyoshi Nakada
c2871161b4 [ruby/rdoc] Fix polynominal backtracking
Fix https://github.com/ruby/rdoc/pull/995

1311ca8c50
2023-04-29 16:55:37 +00:00
Nobuyoshi Nakada
85a9fd1902 [ruby/rdoc] Fix polynominal backtracking
Fix https://github.com/ruby/rdoc/pull/995

adfa7db5b9
2023-04-29 16:55:36 +00:00
Nobuyoshi Nakada
5116e8bdf8 [ruby/rdoc] Read generated files in binary mode
So that fixes crash with "invalid byte sequence in US-ASCII" on
ci.rvm.jp and some RubyCIs.

4b416644f0
2023-03-31 01:14:34 +00:00
zzak
773d56b1c1 [ruby/rdoc] Add test coverage for -C flag
564be08f4b
2023-02-06 23:09:06 +00:00
zzak
e04d20bc48 [ruby/rdoc] Add rdoc:coverage default task
157fbaf575
2023-02-03 23:41:06 +00:00
Nobuyoshi Nakada
17b63ab6b1
[ruby/rdoc] Fix fragile tests
When the temporary path is long enough, the formatter may fold the
path and may hit a hyphen at the end of line, and miscounted.

5f46479543
2022-12-23 20:31:25 +09:00
Nobuyoshi Nakada
9c1f03a38a
Debug for zlinux CI [ci skip] 2022-12-23 16:57:15 +09:00
Nobuyoshi Nakada
792c50e917 [ruby/rdoc] Clean up home directories for each test
f067c174da
2022-12-23 11:05:09 +09:00
Nobuyoshi Nakada
99cad3fccd [ruby/rdoc] Non-RD part feature has not been imported to RDoc
fe0159de2f
2022-12-01 02:36:20 +09:00
Sven Riedel
e0901f46b7 [ruby/rdoc] Add --no-skipping-tests option
33925f885f
2022-11-28 04:36:29 +00:00
Takashi Kokubun
03b96319b4 Skip a broken RDoc test
http://ci.rvm.jp/results/trunk-yjit@phosphorus-docker/4309535
http://ci.rvm.jp/results/trunk-random0@phosphorus-docker/4309536
http://ci.rvm.jp/results/trunk-random1@phosphorus-docker/4309538
http://ci.rvm.jp/results/trunk-random2@phosphorus-docker/4309541
http://ci.rvm.jp/results/trunk-random3@phosphorus-docker/4309544
http://ci.rvm.jp/results/trunk-no-mjit@phosphorus-docker/4309550
http://ci.rvm.jp/results/trunk-yjit@phosphorus-docker/4309556
http://ci.rvm.jp/results/trunk-random0@phosphorus-docker/4309562
http://ci.rvm.jp/results/trunk-random1@phosphorus-docker/4309564
http://ci.rvm.jp/results/trunk-random2@phosphorus-docker/4309567
http://ci.rvm.jp/results/trunk-random3@phosphorus-docker/4309570
20221127T200003Z.fail.html.gz
http://ci.rvm.jp/results/trunk-random-repeat@phosphorus-docker/4309581
20221127T203002Z.fail.html.gz
http://ci.rvm.jp/results/trunk-yjit@phosphorus-docker/4309588
2022-11-27 13:02:43 -08:00
Nobuyoshi Nakada
5b1db79129 [ruby/rdoc] Revert "Refactor RDoc::Markup::Parser#tokenize"
This reverts commit 41ceae93b3.

5d2c47e8b8
2022-11-27 19:46:12 +00:00
Nobuyoshi Nakada
21977b95e2 [ruby/rdoc] Refactor RDoc::Markup::Parser#tokenize
Make verbatims text or newline only, and simplify `build_verbatim`.

41ceae93b3
2022-11-27 17:24:38 +00:00
nick evans
ae3817bc61 [ruby/rdoc] Darkfish: Nest sidebar ToC as a tree of headings
This uses `<details><summary>heading</summary><ul>nested</ul></detail>`,
similar to how the classes and pages lists are now nested.

e57beff287
2022-11-27 17:18:16 +00:00
Nobuyoshi Nakada
a87de5e3c1 [ruby/rdoc] Special characters are prohibited as filename on Windows
13b9da5932
2022-10-07 12:12:10 +09:00
Nobuyoshi Nakada
a3cb09c7d1 [ruby/rdoc] Escape file names
https://hackerone.com/reports/1321358

8c07cc4657
2022-10-07 12:12:08 +09:00
Nobuyoshi Nakada
8d0b2162a0 [ruby/rdoc] Escape main title
https://hackerone.com/reports/1187156

5dedb5741d
2022-10-07 12:09:23 +09:00
Nobuyoshi Nakada
586e18b946 [ruby/rdoc] Escape HYPERLINKs
ac35485be6
2022-10-07 12:09:22 +09:00
Nobuyoshi Nakada
9e3ab9da7f [ruby/rdoc] Escape RDOCLINKs
https://hackerone.com/reports/1187156

7cecf1efae
2022-10-07 12:09:21 +09:00
Nobuyoshi Nakada
deaa656608 [ruby/rdoc] Escape TIDYLINKs
https://hackerone.com/reports/1187156

1ad2dd3ca2
2022-10-07 12:09:20 +09:00
Nobuyoshi Nakada
cf3056be69 [ruby/rdoc] Add center align
512cc55a0e
2022-10-06 23:22:02 +09:00
Nobuyoshi Nakada
28e24ce355 [ruby/rdoc] Allow spaces around pipes
3b3a583580
2022-10-06 23:21:16 +09:00
Nobuyoshi Nakada
7c03c82444 [ruby/rdoc] Allow escaped pipes in cells
333952a62d
2022-10-06 23:17:49 +09:00
Nobuyoshi Nakada
f6c916c7ef [ruby/rdoc] Allow leading pipes to be ommitted
d263a2c9c4
2022-10-06 23:16:54 +09:00
Nobuyoshi Nakada
a19bf47d03 [ruby/rdoc] Allow trailing pipes to be ommitted
1318048877
2022-10-06 23:14:29 +09:00
Nobuyoshi Nakada
75a53f6be0 [ruby/rdoc] Allow RDoc markups in table cells
b16d3f1727
2022-10-06 18:24:44 +09:00