Re: Autodocumenting plpgsql function - Mailing list pgsql-general

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

> Typically in you comments you include special tags, like @input, then doxygen will parse it and
> generate an html documentation.

I can't think of a way to automatically generate such
documentation from within PostgreSQL, except maybe that
you write a stored procedure that analyzes all functions
and adds a comment with the result.

Yours,
Laurenz Albe

pgsql-general by date:

Previous
From: Peter Kroon
Date:
Subject: xmlagg doesn't honor LIMIT?
Next
From: Albe Laurenz
Date:
Subject: Re: xmlagg doesn't honor LIMIT?