Generate documentation from PL/pgsql source code?

From: Jeremy Palmer <JPalmer(at)linz(dot)govt(dot)nz>
To: "pgsql-general(at)postgresql(dot)org" <pgsql-general(at)postgresql(dot)org>
Subject: Generate documentation from PL/pgsql source code?
Date: 2013-06-29 07:36:45
Message-ID: C6B695652D5E6B4597E90C5734C024261691506F06@prdlsmmsg01.ad.linz.govt.nz
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-general

I maintain large libraries of files containing PL/pgsql code which I would like to document better. Are there any tools currently available that can generate documentation from PL/pgsql source code? Would be good if it had functionality like doxygen. e.g

/**
* my function comment..
*
* @param p_one The table schema
* @param p_two The table name
* @return If function successfully completed
* @throws RAISE_EXCEPTION If something bad happens
*/
CREATE OR REPLACE FUNCTION my_function(
p_one TEXT,
p_two TEXT
)
RETURNS BOOLEAN AS
$$
BEGIN
etc....
END;
$$ LANGUAGE plpgsql;

Cheers
Jeremy

This message contains information, which is confidential and may be subject to legal privilege. If you are not the intended recipient, you must not peruse, use, disseminate, distribute or copy this message. If you have received this message in error, please notify us immediately (Phone 0800 665 463 or info(at)linz(dot)govt(dot)nz) and destroy the original message. LINZ accepts no responsibility for changes to this email, or for any attachments, after its transmission from LINZ. Thank You.

Browse pgsql-general by date

  From Date Subject
Next Message Alban Hertroys 2013-06-29 07:37:51 Re: Postgres case insensitive searches
Previous Message Peter Eisentraut 2013-06-29 03:59:58 Re: [GENERAL] pg_upgrade -u