[DOC] Hide RubyVM::Shape that is for debug from RDoc totally

nobu · nobu · commit 13e6fe9bbc9d · 2024-12-24T21:31:52.000+09:00
diff --git a/shape.c b/shape.c
@@ -1024,7 +1024,6 @@ rb_shape_memsize(rb_shape_t *shape)
  * Exposing Shape to Ruby via RubyVM.debug_shape
  */
 
-/* :nodoc: */
 static VALUE
 rb_shape_too_complex(VALUE self)
 {
@@ -1073,7 +1072,6 @@ rb_edges_to_hash(ID key, VALUE value, void *ref)
     return ID_TABLE_CONTINUE;
 }
 
-/* :nodoc: */
 static VALUE
 rb_shape_edges(VALUE self)
 {
@@ -1108,7 +1106,6 @@ rb_shape_edge_name(rb_shape_t * shape)
     return Qnil;
 }
 
-/* :nodoc: */
 static VALUE
 rb_shape_export_depth(VALUE self)
 {
@@ -1117,7 +1114,6 @@ rb_shape_export_depth(VALUE self)
     return SIZET2NUM(rb_shape_depth(shape));
 }
 
-/* :nodoc: */
 static VALUE
 rb_shape_parent(VALUE self)
 {
@@ -1131,28 +1127,24 @@ rb_shape_parent(VALUE self)
     }
 }
 
-/* :nodoc: */
 static VALUE
 rb_shape_debug_shape(VALUE self, VALUE obj)
 {
     return rb_shape_t_to_rb_cShape(rb_shape_get_shape(obj));
 }
 
-/* :nodoc: */
 static VALUE
 rb_shape_root_shape(VALUE self)
 {
     return rb_shape_t_to_rb_cShape(rb_shape_get_root_shape());
 }
 
-/* :nodoc: */
 static VALUE
 rb_shape_shapes_available(VALUE self)
 {
     return INT2NUM(MAX_SHAPE_ID - (GET_SHAPE_TREE()->next_shape_id - 1));
 }
 
-/* :nodoc: */
 static VALUE
 rb_shape_exhaust(int argc, VALUE *argv, VALUE self)
 {
@@ -1183,7 +1175,6 @@ static VALUE edges(struct rb_id_table* edges)
     return hash;
 }
 
-/* :nodoc: */
 VALUE
 rb_obj_shape(rb_shape_t* shape)
 {
@@ -1203,14 +1194,12 @@ rb_obj_shape(rb_shape_t* shape)
     return rb_shape;
 }
 
-/* :nodoc: */
 static VALUE
 shape_transition_tree(VALUE self)
 {
     return rb_obj_shape(rb_shape_get_root_shape());
 }
 
-/* :nodoc: */
 static VALUE
 rb_shape_find_by_id(VALUE mod, VALUE id)
 {
@@ -1311,6 +1300,8 @@ void
 Init_shape(void)
 {
 #if SHAPE_DEBUG
+    /* Document-class: RubyVM::Shape
+     * :nodoc: */
     VALUE rb_cShape = rb_struct_define_under(rb_cRubyVM, "Shape",
             "id",
             "parent_id",

Original file line number	Diff line number	Diff line change
`@@ -1024,7 +1024,6 @@ rb_shape_memsize(rb_shape_t *shape)`
`1024`	`1024`	`* Exposing Shape to Ruby via RubyVM.debug_shape`
`1025`	`1025`	`*/`
`1026`	`1026`
`1027`		`-/* :nodoc: */`
`1028`	`1027`	`static VALUE`
`1029`	`1028`	`rb_shape_too_complex(VALUE self)`
`1030`	`1029`	`{`
`@@ -1073,7 +1072,6 @@ rb_edges_to_hash(ID key, VALUE value, void *ref)`
`1073`	`1072`	`return ID_TABLE_CONTINUE;`
`1074`	`1073`	`}`
`1075`	`1074`
`1076`		`-/* :nodoc: */`
`1077`	`1075`	`static VALUE`
`1078`	`1076`	`rb_shape_edges(VALUE self)`
`1079`	`1077`	`{`
`@@ -1108,7 +1106,6 @@ rb_shape_edge_name(rb_shape_t * shape)`
`1108`	`1106`	`return Qnil;`
`1109`	`1107`	`}`
`1110`	`1108`
`1111`		`-/* :nodoc: */`
`1112`	`1109`	`static VALUE`
`1113`	`1110`	`rb_shape_export_depth(VALUE self)`
`1114`	`1111`	`{`
`@@ -1117,7 +1114,6 @@ rb_shape_export_depth(VALUE self)`
`1117`	`1114`	`return SIZET2NUM(rb_shape_depth(shape));`
`1118`	`1115`	`}`
`1119`	`1116`
`1120`		`-/* :nodoc: */`
`1121`	`1117`	`static VALUE`
`1122`	`1118`	`rb_shape_parent(VALUE self)`
`1123`	`1119`	`{`
`@@ -1131,28 +1127,24 @@ rb_shape_parent(VALUE self)`
`1131`	`1127`	`}`
`1132`	`1128`	`}`
`1133`	`1129`
`1134`		`-/* :nodoc: */`
`1135`	`1130`	`static VALUE`
`1136`	`1131`	`rb_shape_debug_shape(VALUE self, VALUE obj)`
`1137`	`1132`	`{`
`1138`	`1133`	`return rb_shape_t_to_rb_cShape(rb_shape_get_shape(obj));`
`1139`	`1134`	`}`
`1140`	`1135`
`1141`		`-/* :nodoc: */`
`1142`	`1136`	`static VALUE`
`1143`	`1137`	`rb_shape_root_shape(VALUE self)`
`1144`	`1138`	`{`
`1145`	`1139`	`return rb_shape_t_to_rb_cShape(rb_shape_get_root_shape());`
`1146`	`1140`	`}`
`1147`	`1141`
`1148`		`-/* :nodoc: */`
`1149`	`1142`	`static VALUE`
`1150`	`1143`	`rb_shape_shapes_available(VALUE self)`
`1151`	`1144`	`{`
`1152`	`1145`	`return INT2NUM(MAX_SHAPE_ID - (GET_SHAPE_TREE()->next_shape_id - 1));`
`1153`	`1146`	`}`
`1154`	`1147`
`1155`		`-/* :nodoc: */`
`1156`	`1148`	`static VALUE`
`1157`	`1149`	`rb_shape_exhaust(int argc, VALUE *argv, VALUE self)`
`1158`	`1150`	`{`
`@@ -1183,7 +1175,6 @@ static VALUE edges(struct rb_id_table* edges)`
`1183`	`1175`	`return hash;`
`1184`	`1176`	`}`
`1185`	`1177`
`1186`		`-/* :nodoc: */`
`1187`	`1178`	`VALUE`
`1188`	`1179`	`rb_obj_shape(rb_shape_t* shape)`
`1189`	`1180`	`{`
`@@ -1203,14 +1194,12 @@ rb_obj_shape(rb_shape_t* shape)`
`1203`	`1194`	`return rb_shape;`
`1204`	`1195`	`}`
`1205`	`1196`
`1206`		`-/* :nodoc: */`
`1207`	`1197`	`static VALUE`
`1208`	`1198`	`shape_transition_tree(VALUE self)`
`1209`	`1199`	`{`
`1210`	`1200`	`return rb_obj_shape(rb_shape_get_root_shape());`
`1211`	`1201`	`}`
`1212`	`1202`
`1213`		`-/* :nodoc: */`
`1214`	`1203`	`static VALUE`
`1215`	`1204`	`rb_shape_find_by_id(VALUE mod, VALUE id)`
`1216`	`1205`	`{`
`@@ -1311,6 +1300,8 @@ void`
`1311`	`1300`	`Init_shape(void)`
`1312`	`1301`	`{`
`1313`	`1302`	`#if SHAPE_DEBUG`
	`1303`	`+ /* Document-class: RubyVM::Shape`
	`1304`	`+ * :nodoc: */`
`1314`	`1305`	`VALUE rb_cShape = rb_struct_define_under(rb_cRubyVM, "Shape",`
`1315`	`1306`	`"id",`
`1316`	`1307`	`"parent_id",`