Re: [ruby-gnome2-devel-en] [ruby-gnome2-cvs] ruby-gnome2/ruby-gnome2@d479f90 [master] Fix broken links on GitHub

[Kouhei S. <ko...@co...>]

Hi,

In <53A...@gm...>
  "Re: [ruby-gnome2-devel-en] [ruby-gnome2-cvs] ruby-gnome2/ruby-gnome2@d479f90 [master] Fix broken links on GitHub" on Sun, 29 Jun 2014 10:23:32 +0200,
  Detlef Reichl <det...@gm...> wrote:

> Am 29.06.2014 05:43, schrieb Kouhei Sutou:
>> It is a broken markup in RD. Should we migrated to Markdown
>> from RD?

> do you mean it only for README file or for all docs? For the other docs
> I am in favor to switch to YARD, because with YARD we get the types of
> the parameters of methods and of the return values in a simple to pares
> format. This is very useful for tools which analyses code written with
> ruby-gtk.

I meant only for README files.

I have no objection for migrating to YARD. It is better that
we have a tool that imports documentations from GTK+ to YARD.
Most of Ruby-GNOME2 documentations are based on
documentations of GTK+.

Moreover, it is better that we can generate documentations
for GObject Introspection bindings such as Ruby/GIO2
automatically. .gir files provided by GObject Introspection
have documentations.


Thanks,
--
kou