Re: Another set of DBI docs

Re: Another set of DBI docs

am 16.08.2007 14:02:52 von sigzero

Dean Arnold wrote:
> (Those who abhor javadocs should discard this message immediately...)
>
> I've been building some tools for fancier Perl project documentation.
> One piece is a javadoc-ish formatter using special POD tags.
> In order to exersize it thoroughly, I've hacked a version of DBI
> to move the POD around a bit, with some editting to comply with
> javadoc style guidelines. I don't intend to fold any of the changes into
> the DBI bundle, but thought the resulting docs might be generally
> useful (which is also why I chose DBI as an unwitting test subject).
> For anyone interested, here's a link to the result:
>
> http://www.presicient.com/dbidocs
>
> Caveats:
>
> - Some of the internal links aren't valid
> - older browsers may not play nice with the javascript or CSS
> (tho they're pretty basic)
> - Opera doesn't seem to like 12 digit hex color names, so it renders
> header sections as a hideous purple instead of the usual nice
> aqua blue
> - some of the content may not be correct (tho I tried not to change
> content other than to use slightly different grammar tense or
> person)
>
> I think the docs are useful, if only because of the explorer-style
> TOC. I know its handy to me to quickly lookup the meaning of an
> attribute I've
> forgotten, or to lookup the right parameters for some method.
>
> Any comments/corrections/suggestions welcome, but are probably best
> sent offlist.
>
> Regards,
> Dean Arnold
> Presicient Corp.
>
>
That is pretty nifty.

Robert