diff options
| author | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2023-12-18 19:52:06 +0900 |
|---|---|---|
| committer | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2023-12-18 20:17:45 +0900 |
| commit | baf1403fba01c36b44dbd7bc658fed748ee7bc1e (patch) | |
| tree | 40c90a2cd4cb1e10c8805a853445db8a90f2daad /ext | |
| parent | 835f1461f7d34941c8163650eb94965533eba029 (diff) | |
[DOC] Show `PTY.getpty` as an alias of `PTY.spawn`
`:nodoc:` directive does not work at method definition in C, and must
be at the implementation function. That is, there is no way to make
one method visible and another method sharing the implementation
invisible at the same time.
Diffstat (limited to 'ext')
| -rw-r--r-- | ext/pty/pty.c | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/ext/pty/pty.c b/ext/pty/pty.c index 0aca10bfa0..8dca8ba281 100644 --- a/ext/pty/pty.c +++ b/ext/pty/pty.c @@ -745,8 +745,13 @@ void Init_pty(void) { cPTY = rb_define_module("PTY"); - /* :nodoc: */ - rb_define_module_function(cPTY,"getpty",pty_getpty,-1); +#if 1 + rb_define_module_function(cPTY,"get""pty",pty_getpty,-1); +#else /* for RDoc */ + /* show getpty as an alias of spawn */ + VALUE sPTY = rb_singleton_class(cPTY); + rb_define_alias(sPTY, "getpty", "spawn"); +#endif rb_define_module_function(cPTY,"spawn",pty_getpty,-1); rb_define_singleton_method(cPTY,"check",pty_check,-1); rb_define_singleton_method(cPTY,"open",pty_open,0); |