search

bluepixelmike / rpg-maker-rgss

Built-in classes and modules for RPG Maker VX available as a gem for documentation and IDE usage.
https://bluepixelmike.github.io/rpg-maker-rgss/frames.html
6 stars 13 forks source link

Write documentation #1

Open bluepixelmike opened 9 years ago

bluepixelmike commented 9 years ago

There's no documentation for the classes and modules in this gem. Part of the purpose of this gem is the documentation.

bluepixelmike commented 9 years ago

I prefer YARD. There's GitHub pages that use YARD - https://bluepixelmike.github.io/rpg-maker-rgss/ . The latest commits on devel have a rake task to build the docs.

I'd appreciate some documentation help, since it isn't the most exciting thing to do.