Re: Autodocumenting plpgsql function - Mailing list pgsql-general

From Albe Laurenz
Subject Re: Autodocumenting plpgsql function
Date
Msg-id A737B7A37273E048B164557ADEF4A58B17C60026@ntex2010i.host.magwien.gv.at
Whole thread Raw
In response to Autodocumenting plpgsql function  (Rémi Cura <remi.cura@gmail.com>)
Responses Re: Autodocumenting plpgsql function
List 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

pgsql-general by date:

Previous
From: Richard Huxton
Date:
Subject: Re: Wrap around id failure and after effects
Next
From: Karsten Hilbert
Date:
Subject: a PostgreSQL slogan misused