Thread: Documenting stored procedures and functions

Hi!


I dunno if this is the best list to ask about it, but it sounded "general"
enough to me :-)  Sorry if I'm on the wrong place.

I'd like to know how you're documenting your functions and stored procedures,
including their usage, input and output types, description,
updates/versioning, etc.

I'm starting to create some internal standard to do that and it there are any
tools -- preferably multiplatform, including specially Windows and Linux -- to
help with that I'd greatly appreciate any recommendations.



Be seeing you,
--
Jorge Godoy      <jgodoy@gmail.com>

On Sep 26, 2006, at 11:14 PM, Jorge Godoy wrote:
> I dunno if this is the best list to ask about it, but it sounded
> "general"
> enough to me :-)  Sorry if I'm on the wrong place.
>
> I'd like to know how you're documenting your functions and stored
> procedures,
> including their usage, input and output types, description,
> updates/versioning, etc.
>
> I'm starting to create some internal standard to do that and it
> there are any
> tools -- preferably multiplatform, including specially Windows and
> Linux -- to
> help with that I'd greatly appreciate any recommendations.

Take a look at http://pgfoundry.org/projects/autodoc/. I believe it
uses comments (ie: COMMENT ON) as well, so you can get some info into
that.
--
Jim Nasby                                            jim@nasby.net
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)

Jim Nasby <jim@nasby.net> writes:

> Take a look at http://pgfoundry.org/projects/autodoc/. I believe it uses
> comments (ie: COMMENT ON) as well, so you can get some info into  that.

Hi Jim!

Thanks for pointing me to the tool.  The correct link to it is
http://www.rbt.ca/autodoc/.

It might fit my needs, with some work done with comments. :-)

--
Jorge Godoy      <jgodoy@gmail.com>