YARD GObject Plugin
This is a YARD plugin that assists in the documentation of Ruby bindings that make use of GObject, i.e. the Ruby-GNOME2 bindings.
Features
For now, it supports only one tag: @properties
. This tag can be applied to any Class (G_DEF_CLASS
macros), or Module (G_DEF_INTERFACE
macros). It provides meta-data for the various GObject properties belonging to a GObject Class or GObject Interface.
Syntax
# @properties property-name [PropertyType] description,
# another-property [PropertyType] description...
PropertyType
is formatted the same way YARD formats types. description
can be ommited.
License
This plugin is Copyright © 2010 Stojan Dimitrovski, licensed under the MIT License. See the LICENSE.txt file included in this distribution for more information.