search

dayflower / yard-padrino

A YARD plugin for parsing Padrino's controllers and helpers
MIT License
5 stars 4 forks source link

How does it work? #1

Open mrkaspa opened 10 years ago

mrkaspa commented 10 years ago

I need document a Padrino API, how can I use this gem?, do you have an example?

dayflower commented 10 years ago

This module itself does not provide document of Padrino API (that is available online http://www.padrinorb.com/api/index.html). This module is plugin for YARD documentation tool, and generates documentation for your Padrino application. Install this module with YARD, then type on your Padrino project directory.

$ yard doc yard-pardino lib
jorgefuertes commented 4 years ago

It doesn't works for me. It generates documentation for helpers but controllers and routes are invisible.