Re: [PATCH] Add some RDoc comments to the SWIG/Ruby bindings, part 1

Hi,

In <20060619.181649.108761683.nori1@dolphin.c.u-tokyo.ac.jp>
  "[PATCH] Add some RDoc comments to the SWIG/Ruby bindings, part 1" on Mon, 19 Jun 2006 18:16:49 +0900 (JST),
  Kobayashi Noritada <nori1@dolphin.c.u-tokyo.ac.jp> wrote:

> I'm writing RDoc comments for the SWIG/Ruby bindings and present the
> patch here.

Great works, nori!

> # FYI: RDoc is a system for generating documentation from Ruby source files.
> # By running '(cd subversion/bindings/swig/ruby; rdoc svn)', you will find
> # HTML documents generated in subversion/bindings/swig/ruby/doc.

I added install-swig-rb-doc target in r20166. This target
generates documents for ri instead of HTML format documents.

There are some comments in your patch.

> [[[
> Add some RDoc comments to the SWIG/Ruby bindings.
>
> * subversion/bindings/swig/ruby/svn/client.rb
> (Svn::Client::Context#cat,
> (Svn::Client::Context#diff_summarize,
    ^
    There is a needless right parenthesis.

> ]]]

> Index: subversion/bindings/swig/ruby/svn/client.rb
> ===================================================================
> --- subversion/bindings/swig/ruby/svn/client.rb (revision 20165)
> +++ subversion/bindings/swig/ruby/svn/client.rb (working copy)
> @@ -30,6 +30,21 @@

> + # [prop_hash]
> + # Returns a Hash of properties, such as
> + # <tt>{ propname1 => propval1, propname2 => propval2, ... }</tt>.
                ^ ^
I want to remove spaces beside braces.

> + # Other methods are:
> + # * node_name=
> + # * prop_hash=

I think those methods shouldn't document. User should use
PropListItem as read only object.

> @@ -158,6 +173,8 @@

> + # Returns a value of a property, with _name_ attached to _target_,

RDoc's RDoc uses +XXX+ markup as method argument. It's
better that we use +XXX+ markup instead of _XXX_.

Regards,

--
kou
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org