YARD plugin to retrieve documentation from GObject Introspection data
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
tools
COPYING.LIB
README.md
yard-gobject-introspection.gemspec

README.md

yard-gobject-instropection

yard plugin for building documentation of libraries based on GObject-Intropection.

Requirements

Try it

git clone https://github.com/ruby-gnome2/yard-gobject-introspection
cd yard-gobject-introspection
yard doc --load lib/yard-gobject-introspection.rb ~/.gem/ruby/2.x.x/gems/gtk3-3.x.x/lib/gtk3.rb
firefox doc/index.html

Install (when we will push it)

gem install yard-gobject-introspection

License

Copyright (c) 2016 Ruby-GNOME2 Project Team

This program is free software. You can distribute/modify this program under the terms of the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1.

Project Website