Re: Autodocumenting plpgsql function

From: Albe Laurenz <laurenz(dot)albe(at)wien(dot)gv(dot)at>
To: Rémi Cura *EXTERN* <remi(dot)cura(at)gmail(dot)com>, "PostgreSQL General" <pgsql-general(at)postgresql(dot)org>
Subject: Re: Autodocumenting plpgsql function
Date: 2013-11-26 11:19:33
Message-ID: A737B7A37273E048B164557ADEF4A58B17C60026@ntex2010i.host.magwien.gv.at
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-general

Rémi Cura wrote:
> somebody knows of a way to autodocument plpgsql function, in a docxygen style
> (adding tags in comments for instance, or creating doc templates to fill).
>
> It would really help to write the doc and maintain it.

I am not sure what you need, but I see two ways to
document a function:

1) With /** .. */ comments in the beginning.
Maybe doxygen can be used to parse a database dump.

2) With COMMENT ON FUNCTION ... IS '...';
That also keeps the documentation close to where
the code is, and it shows up in database dumps.

Yours,
Laurenz Albe

In response to

Responses

Browse pgsql-general by date

  From Date Subject
Next Message Karsten Hilbert 2013-11-26 11:25:32 a PostgreSQL slogan misused
Previous Message Richard Huxton 2013-11-26 09:44:10 Re: Wrap around id failure and after effects