Skip to content

Commit 2f3f44c

Browse files
committed
Add :nodoc: for GeneratorMethods
1 parent b3ec252 commit 2f3f44c

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

ext/json/ext/generator/generator.c

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,76 @@ static char *fstrndup(const char *ptr, unsigned long len) {
324324
*
325325
*/
326326

327+
/* Explanation of the following: that's the only way to not pollute
328+
* standard library's docs with GeneratorMethods::<ClassName> which
329+
* are uninformative and take a large place in a list of classes
330+
*/
331+
332+
/*
333+
* Document-module: JSON::Ext::Generator::GeneratorMethods
334+
* :nodoc:
335+
*/
336+
337+
/*
338+
* Document-module: JSON::Ext::Generator::GeneratorMethods::Array
339+
* :nodoc:
340+
*/
341+
342+
/*
343+
* Document-module: JSON::Ext::Generator::GeneratorMethods::Bignum
344+
* :nodoc:
345+
*/
346+
347+
/*
348+
* Document-module: JSON::Ext::Generator::GeneratorMethods::FalseClass
349+
* :nodoc:
350+
*/
351+
352+
/*
353+
* Document-module: JSON::Ext::Generator::GeneratorMethods::Fixnum
354+
* :nodoc:
355+
*/
356+
357+
/*
358+
* Document-module: JSON::Ext::Generator::GeneratorMethods::Float
359+
* :nodoc:
360+
*/
361+
362+
/*
363+
* Document-module: JSON::Ext::Generator::GeneratorMethods::Hash
364+
* :nodoc:
365+
*/
366+
367+
/*
368+
* Document-module: JSON::Ext::Generator::GeneratorMethods::Integer
369+
* :nodoc:
370+
*/
371+
372+
/*
373+
* Document-module: JSON::Ext::Generator::GeneratorMethods::NilClass
374+
* :nodoc:
375+
*/
376+
377+
/*
378+
* Document-module: JSON::Ext::Generator::GeneratorMethods::Object
379+
* :nodoc:
380+
*/
381+
382+
/*
383+
* Document-module: JSON::Ext::Generator::GeneratorMethods::String
384+
* :nodoc:
385+
*/
386+
387+
/*
388+
* Document-module: JSON::Ext::Generator::GeneratorMethods::String::Extend
389+
* :nodoc:
390+
*/
391+
392+
/*
393+
* Document-module: JSON::Ext::Generator::GeneratorMethods::TrueClass
394+
* :nodoc:
395+
*/
396+
327397
/*
328398
* call-seq: to_json(state = nil)
329399
*

0 commit comments

Comments
 (0)