Libguestfs - May 2014 - Re: [PATCH] ruby: add :nodoc: comment for internal methods

This way they are ignored by rdoc.
---
 generator/ruby.ml | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/generator/ruby.ml b/generator/ruby.ml
index 1111993..88762ca 100644
--- a/generator/ruby.ml
+++ b/generator/ruby.ml
@@ -522,6 +522,15 @@ get_all_event_callbacks (guestfs_h *g, size_t *len_rtn)
  * +guestfs_%s+[http://libguestfs.org/guestfs.3.html#guestfs_%s]).
  */
 " f.name args ret f.shortdesc doc f.name f.name
+      ) else (
+        pr "\
+/*
+ * call-seq:
+ *   g.%s
+ *
+ * :nodoc:
+ */
+" f.name
       );
 
       (* Generate the function.  Prototype is completely different
-- 
1.9.3

On Tue, May 27, 2014 at 10:45:38AM +0200, Pino Toscano
wrote:
> This way they are ignored by rdoc.
> ---
>  generator/ruby.ml | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/generator/ruby.ml b/generator/ruby.ml
> index 1111993..88762ca 100644
> --- a/generator/ruby.ml
> +++ b/generator/ruby.ml
> @@ -522,6 +522,15 @@ get_all_event_callbacks (guestfs_h *g, size_t
*len_rtn)
>   * +guestfs_%s+[http://libguestfs.org/guestfs.3.html#guestfs_%s]).
>   */
>  " f.name args ret f.shortdesc doc f.name f.name
> +      ) else (
> +        pr "\
> +/*
> + * call-seq:
> + *   g.%s
> + *
> + * :nodoc:
> + */
> +" f.name
>        );
>  
>        (* Generate the function.  Prototype is completely different
> -- 
> 1.9.3
Good idea, ACK.

Hopefully this will (slightly) improve the very long build times in
the ruby subdirectory due to documentation being regenerated.

Rich.

-- 
Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones
Read my programming and virtualization blog: http://rwmj.wordpress.com
libguestfs lets you edit virtual machines.  Supports shell scripting,
bindings from many languages.  http://libguestfs.org

On Tuesday 27 May 2014 10:01:46 Richard W.M. Jones
wrote:
> On Tue, May 27, 2014 at 10:45:38AM +0200, Pino Toscano wrote:
> > This way they are ignored by rdoc.
> > ---
> > 
> >  generator/ruby.ml | 9 +++++++++
> >  1 file changed, 9 insertions(+)
> > 
> > diff --git a/generator/ruby.ml b/generator/ruby.ml
> > index 1111993..88762ca 100644
> > --- a/generator/ruby.ml
> > +++ b/generator/ruby.ml
> > @@ -522,6 +522,15 @@ get_all_event_callbacks (guestfs_h *g, size_t
> > *len_rtn)> 
> >   * +guestfs_%s+[http://libguestfs.org/guestfs.3.html#guestfs_%s]).
> >   */
> >  
> >  " f.name args ret f.shortdesc doc f.name f.name
> > 
> > +      ) else (
> > +        pr "\
> > +/*
> > + * call-seq:
> > + *   g.%s
> > + *
> > + * :nodoc:
> > + */
> > +" f.name
> > 
> >        );
> >        
> >        (* Generate the function.  Prototype is completely different
> 
> Good idea, ACK.
> 
> Hopefully this will (slightly) improve the very long build times in
> the ruby subdirectory due to documentation being regenerated.
I have not noticed any time difference in the documentation generation, 
but at least now rdoc reports no undocumented methods, and those methods 
do not appear anymore in the generated documentation.

-- 
Pino Toscano