Skip to content

Commit 451630c

Browse files
authored
Use :nodoc: instead of :stopdoc: for internal C-defined classes (#123)
RDoc does not officially support :stopdoc:/:startdoc: in C files, and recent RDoc changes cause :stopdoc: to be incorrectly undone during file processing, making these classes appear as undocumented in coverage reports. Switch to :nodoc: which is properly supported in C comments and correctly marks these internal classes as intentionally undocumented.
1 parent 13e96d8 commit 451630c

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

ext/io/console/console.c

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2000,14 +2000,13 @@ InitVM_console(void)
20002000
rb_define_method(rb_cIO, "ttyname", console_ttyname, 0);
20012001
rb_define_singleton_method(rb_cIO, "console", console_dev, -1);
20022002
{
2003-
/* :stopdoc: */
2003+
/* :nodoc: */
20042004
VALUE mReadable = rb_define_module_under(rb_cIO, "generic_readable");
2005-
/* :startdoc: */
20062005
rb_define_method(mReadable, "getch", io_getch, -1);
20072006
rb_define_method(mReadable, "getpass", io_getpass, -1);
20082007
}
20092008
{
2010-
/* :stopdoc: */
2009+
/* :nodoc: */
20112010
cConmode = rb_define_class_under(rb_cIO, "ConsoleMode", rb_cObject);
20122011
rb_define_const(cConmode, "VERSION", rb_obj_freeze(rb_str_new_cstr(IO_CONSOLE_VERSION)));
20132012
rb_define_alloc_func(cConmode, conmode_alloc);
@@ -2016,6 +2015,5 @@ InitVM_console(void)
20162015
rb_define_method(cConmode, "echo=", conmode_set_echo, 1);
20172016
rb_define_method(cConmode, "raw!", conmode_set_raw, -1);
20182017
rb_define_method(cConmode, "raw", conmode_raw_new, -1);
2019-
/* :startdoc: */
20202018
}
20212019
}

0 commit comments

Comments
 (0)