Re: Documenting stored procedures and functions

From: Jim Nasby <jim(at)nasby(dot)net>
To: Jorge Godoy <jgodoy(at)gmail(dot)com>
Cc: PostgreSQL General ML <pgsql-general(at)postgresql(dot)org>
Subject: Re: Documenting stored procedures and functions
Date: 2006-09-27 14:14:20
Message-ID: B2C37928-CB67-446C-8FB1-1B952F2F4ACE@nasby.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-general

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(at)nasby(dot)net
EnterpriseDB http://enterprisedb.com 512.569.9461 (cell)

In response to

Responses

Browse pgsql-general by date

  From Date Subject
Next Message Jim Nasby 2006-09-27 14:18:58 Re: Restart after power outage: createdb
Previous Message Filip Rembiałkowski 2006-09-27 13:50:46 dbi-link questions + patch