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>
Cc: PostgreSQL General <pgsql-general(at)postgresql(dot)org>
Subject: Re: Autodocumenting plpgsql function
Date: 2013-11-26 13:05:58
Message-ID: A737B7A37273E048B164557ADEF4A58B17C60259@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.

> 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

In response to

Browse pgsql-general by date

  From Date Subject
Next Message Albe Laurenz 2013-11-26 13:15:11 Re: xmlagg doesn't honor LIMIT?
Previous Message Peter Kroon 2013-11-26 13:02:15 xmlagg doesn't honor LIMIT?