[Dbix-class] Documentation of DBIx::Class schemas

[Jason Kohles]

On Nov 7, 2007, at 12:24 PM, Pedro Melo wrote:

> Hi,
>
> I was wondering how do you document your schemas?
>
> I started adding 'docs' keys to the extra hash for each column. I've  
> also added a Doc component that allows me to set up some texts as  
> documentation for the class.
>
> Then I can use basic introspection and generate the entire  
> documentation (right now using a Catalyst::Controller).
>
> To prevent unnecessary memory usage in production, all the text of  
> the docs is not kept unless a environment variable is set.
>
I'm actually doing the same thing, I've been working on a  
DBIx::Class::AutoDoc package which includes a tool that takes a  
DBIx::Class::Schema object and generates documentation for it, similar  
to the documentation that is produced by postgresql_autodoc (http://www.rbt.ca/autodoc/ 
) but from the standpoint of documenting the classes, rather than the  
database itself.  I'm planning on an initial release sometime this  
week, as soon as I can get a few last issues worked out.


-- 
Jason Kohles, RHCA RHCDS RHCE
email at jasonkohles.com - http://www.jasonkohles.com/
"A witty saying proves nothing."  -- Voltaire