Nobuyoshi Nakada
51be2cf6d2
[ruby/rdoc] Parse also InitVM-prefixed functions
...
Initialization depending on VM is separated.
030d10fccd
2022-06-28 14:51:49 +09:00
Nobuyoshi Nakada
082c2d1b05
[ruby/rdoc] [DOC] Undocument internal constants [ci skip]
...
6d7bf24bb8
2022-06-07 11:44:58 +09:00
Nobuyoshi Nakada
dbfb3b1917
[ruby/rdoc] Allow boolean arguments to rb_attr
and rb_define_attr
...
Currently only literal `0` and `1` are accepted as `read`/`write`
flags.
This patch allows other boolean arguments, C macros (`FALSE`/`TRUE`),
Ruby `VALUE`s (`Qfalse`/`Qtrue`), and C99 `bool`s (`false`/`true`), as
well.
169dc02e3c
2022-06-07 10:42:10 +09:00
Nobuyoshi Nakada
5460675bbc
[ruby/rdoc] Use command array form of IO.popen
always
...
So that an exception raises by non-existent command, not via shell.
fd94dce69d
2022-06-04 20:32:27 +09:00
Nobuyoshi Nakada
2e6aee6ef2
[ruby/rdoc] Make all documents at the top level extra_rdoc_files
[ci skip]
...
6b1a011243
2022-06-04 16:53:12 +09:00
Nobuyoshi Nakada
9a7be959b1
[ruby/rdoc] Remove RDoc::RI::Driver#in_path?
...
83051403d6
2022-06-04 16:42:10 +09:00
Nobuyoshi Nakada
323acd263a
[ruby/rdoc] Stop checking if pager command found
...
`IO.popen` does that job.
3bbbc5ac84
2022-06-04 16:42:08 +09:00
Nobuyoshi Nakada
76479de159
[ruby/rdoc] Remove never used win32console
...
47a1aef447
2022-06-04 16:40:19 +09:00
Peter Zhu
4da0f7a7f5
[ruby/rdoc] Fix dead link in RDoc::Markup
...
521c9ebd29
2022-05-12 02:54:14 +09:00
Kazuhiro NISHIYAMA
392c952ab2
[ruby/rdoc] Fix a typo [ci skip]
...
b42c4a2fe2
2022-04-25 10:14:55 +09:00
Peter Zhu
92614111c0
[ruby/rdoc] Fix links in docs
...
www.ruby-lang.org without the leading https:// will generate an
incorrect link because it will be treated as a relative link.
28f32149b6
2022-04-15 13:24:48 +09:00
Nobuyoshi Nakada
5397dd2e76
[ruby/rdoc] Apply matching word pairs to underscore-methods
...
Protected characters with `PROTECT_ATTR` should not have special
roles.
c318af0ea2
2022-04-14 16:37:14 +09:00
Nobuyoshi Nakada
e06100d969
[ruby/rdoc] Allow cross references to methods including underscores
...
As underscores are masked to "protect" from the conversion, consider
also `PROTECT_ATTR` as a word character.
db58bb5170
2022-04-14 12:51:30 +09:00
Peter Zhu
aaac279de0
[ruby/rdoc] Only parse valid URLs
...
Only valid characters for URLs should be used for generating URLs.
A list of valid characters can be found in sections 2.2 and 2.3 of IETF
RFC 3986 (https://www.ietf.org/rfc/rfc3986.txt ).
2bd8fcdd4f
2022-04-13 22:25:33 +09:00
Nobuyoshi Nakada
92ef73a918
[ruby/rdoc] Expand the enclosing tree of the current file
...
f9f90ef2ff
2022-03-22 01:32:13 +09:00
Nobuyoshi Nakada
dafe5c1323
[ruby/rdoc] Fold files in the page directory
...
b7b4cdab6c
2022-03-22 01:32:12 +09:00
Nobuyoshi Nakada
73541cdc2f
[ruby/rdoc] Allow method source code to scroll [ci skip]
...
1bb0496c53
2022-03-20 15:42:56 +09:00
Nobuyoshi Nakada
20ad09e560
[ruby/rdoc] Use the custom style details summary
only in nav-section
...
7736d3a89c
2022-03-20 15:38:28 +09:00
Nobuyoshi Nakada
ebcbca96fb
[ruby/rdoc] Fix full name of known class
...
Properly set the name of `File::Constants`, which is the only name
with a namespace in `RDoc::KNOWN_CLASSES`, and fixes longstanding bug
that `File::Constants` becomes `File::File::Constants`.
When it is generated by `rb_file_const` in dir.c, `name` is set to the
qualified name as same as `full_name`, and generated in the normal way
in file.c later, already set `full_name` is cleared and `name` will be
constructed from the enclosing namespace and the `name`. It will
results in duplicated namespace, `File::File::Constants`.
3a8d6df562
2022-03-16 15:05:41 +09:00
Nobuyoshi Nakada
0bf194fb33
[ruby/rdoc] Start with open when only one visible class/module
...
6bb93001db
2022-03-14 14:48:13 +09:00
Nobuyoshi Nakada
976431d9ed
[ruby/rdoc] Fold class and module index
...
4c7c46fcc4
2022-03-14 14:48:12 +09:00
Nobuyoshi Nakada
416c63c118
[ruby/rdoc] Refine pretty_print
...
acb91ea74a
2022-03-13 21:15:08 +09:00
Nobuyoshi Nakada
0bcc3bd6ab
[ruby/rdoc] Clean documents for backwards compatibility
...
23e61a208e
2022-03-13 19:56:42 +09:00
Masafumi Koba
2e4516be26
[ruby/rdoc] Scrollable sidebar
...
This change makes the sidebar scrollable via `position: sticky` and `overflow: auto`;
See also <https://caniuse.com/?search=sticky >
4d52e24840
2022-03-11 17:38:13 +09:00
Peter Zhu
f62f913132
[ruby/rdoc] Support crossref of methods with multiple arguments
...
For example, consider the following markup:
C1#m(a, b)
Before this patch, it generated this HTML:
<p><a href=\"C1.html#method-i-m\"><code>C1#m</code></a>(a, b)</p>
Which places the method arguments outside of the link.
Now it generates this HTML:
<a href=\"C1.html#method-i-m\"><code>C1#m(a, b)</code></a>
05a2b2222b
2022-03-09 23:38:45 +09:00
Kazuhiro NISHIYAMA
fd2e1d3c4a
[ruby/rdoc] Use Marshal.load io
instead of Marshal.load io.read
...
135198a31c
2022-03-02 14:01:31 +09:00
Yusuke Endoh
ae8a8b184e
[ruby/rdoc] Prefer require 'cgi/util'
instead of require 'cgi'
...
RDoc is using only CGI.escape, escapeHTML, and unescape.
We don't have to load the whole source code of cgi gem.
d096222cc2
2022-02-22 17:08:52 +09:00
Nobuyoshi Nakada
3b3fb73d61
[ruby/rdoc] Dump plain objects as RDoc::Options
...
So that the generated `.rdoc_options` file is loadable.
6cf6e1647b
2022-02-12 16:15:08 +09:00
Nobuyoshi Nakada
e95ad70079
[ruby/rdoc] Update generated files
2022-02-12 15:22:47 +09:00
Ulysse Buonomo
5348a34504
[ruby/rdoc] Relative loading for easier development ( https://github.com/ruby/rdoc/pull/821 )
...
This patch makes sure we only load relative code. Hence when coding or
testing rdoc, we'll be sure to always be using the correct code.
Discussion started at https://github.com/ruby/rdoc/pull/817 .
Signed-off-by: Ulysse Buonomo <buonomo.ulysse@gmail.com>
aa41bd48eb
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
2022-02-12 15:06:06 +09:00
Yusuke Endoh
08137c5dd9
[ruby/rdoc] Optimize RawLine by using a regexp instead of negative look-ahead rule
...
This improves the performance in some cases.
`rdoc .../gems/sinatra-2.1.0/README.md` takes 10.5 sec. before this
change, and 7.1 sec. after this change.
`make rdoc` of ruby/ruby takes 19.3 sec. before this change, 18.1 sec.
after this change.
7cf8281e3e
2022-02-12 14:59:26 +09:00
Nobuyoshi Nakada
8013250136
[ruby/rdoc] Simplify attribute exclusiveness conditions
...
45e33c4b85
2022-02-09 22:22:46 +09:00
Nobuyoshi Nakada
ec6d1cf28f
[ruby/rdoc] Get rid of ruby-mode.el confusions
...
63fac51198
2022-02-09 22:22:45 +09:00
Nobuyoshi Nakada
994b3f1dc6
[ruby/rdoc] Allow cross references to negation operator method
...
69cafb213a
2022-02-09 19:41:12 +09:00
Nobuyoshi Nakada
8db06fe2c9
[ruby/rdoc] Allow cross references to logical operator methods
...
17c0da304d
2022-02-09 19:41:11 +09:00
Soutaro Matsumoto
cbd54cba03
[ruby/rdoc] Skip parentheses on singleton class declaration
...
b6c6d4f978
2022-02-09 18:45:05 +09:00
Nobuyoshi Nakada
88b1d21dbb
[ruby/rdoc] Allow cross references to backtick method
...
52c33157f1
2022-02-09 18:44:41 +09:00
Nobuyoshi Nakada
202f690a5e
[ruby/rdoc] Allow cross references to operator methods
...
Make operator methods, e.g., `Regexp#=~`, `Integer#<=>`, cross
reference targets.
5d332a4128
2022-02-09 18:44:40 +09:00
Nobuyoshi Nakada
dec96dd897
[ruby/rdoc] Support all struct definition functions
...
Currently only `rb_struct_define_without_accessor` is supported by
https://github.com/ruby/rdoc/pull/73 . We should support other
three functions too.
d42288f06c
2022-02-09 18:43:07 +09:00
gemmaro
d77f2ff5b4
[ruby/rdoc] Fix typo in RDoc::Task example
...
7a77e55c2a
2022-01-24 10:17:16 +09:00
aycabta
03f16d37bf
[ruby/rdoc] Version 6.4.0
...
4797f28df8
2021-12-24 17:04:11 +09:00
aycabta
2e50989ad3
[ruby/rdoc] Resolve class and method of the same name correctly
...
1e16284fe5
2021-12-09 18:16:05 +09:00
Mike Dalessio
4ffc3fb019
[ruby/rdoc] fix: alias to method with call-seq
...
This change fixes alias call-seq to return nil if the method's
call-seq does not specify the alias.
Previously, the alias's call-seq would be an empty string in this case
which broke darkfish rendering.
This change also backfills test coverage for 0ead786 which moved
call-seq deduplication into AnyMethod.
5ce2789b6f
2021-10-16 06:31:11 +09:00
Mike Dalessio
4c42540da2
[ruby/rdoc] Support linking #==
...
See related commits:
- ebc66662 for #===
- 4943d208 for #[], #[]=, #<<, and #>>
8e47f7840a
2021-10-16 01:40:47 +09:00
Mike Dalessio
7aec65add4
[ruby/rdoc] feat: add support for :category: on C functions
...
45c92005fe
2021-10-16 01:39:36 +09:00
Mike Dalessio
fbd0516afc
[ruby/rdoc] fix: comments in C files use the global markup option
...
Previously, Parser::C comments all defaulted to "rdoc" format, even
when the user had set a different default with the `--markup=<choice>`
option.
4643b08a26
2021-10-16 01:39:06 +09:00
Mike Dalessio
d4894e81c0
[ruby/rdoc] extract Comment creation in Parser::C
...
This is a prefactor for fixing comment format handling.
a3d366feed
2021-10-16 01:39:05 +09:00
aycabta
4b024234b2
[ruby/rdoc] Update SourceCodePro font files
...
d3201d0d47
2021-10-11 21:15:07 +09:00
Hiroshi SHIBATA
83662f1d99
Removed needless rake and bundler files for rdoc
2021-09-28 16:13:45 +09:00
Nobuyoshi Nakada
0fbde94b27
[ruby/rdoc] Convert upper case copyright and registered marks
...
3bca7dc093
2021-09-11 17:03:52 +09:00