I want to write documentation on my pet project.
I have 30 tables and almost 50 views and about 30 functions (stored procedures) in my PostgreSQL database.
I would like to see where tables ( which views and which functions ) are used.
I would like to see where views ( which views and which functions ) are used.
I would like to see if a function is used by another function.
I would like also to write a description of each objects ( tables, views and functions )
and a short description of fields.
Shortly, I want to be able to see what use a specific object and which objects use a specific object.
I thought to use a text file and for every object.
I might list objects that use the current one and which ones are used by the current one.
<pre>
Table aaaa
A short description
used by : view v_aaaa
id int primary key
name varchar(30) name of a...
================================
view v_aaaa
A short description
list of fields...
used by function f_aaaa
Depends on table aaaa
==============================
function f_aaaa
A short description
Parameters ( description, IN/OUT )
Depends on view v_aaaa
function fbbbb
==============================
function f_bbbb
A short description
Parameters
Called by function f_aaaa
I’m afraid that my documentation will be unsynchronize quickly
Imagine I add a function f_cccc that calls f_aaaa and f_bbbb. I’ll have to modify doc on f_aaaa and f_bbbb
I know that UML describes relations about entities (It does that, right ???).
But I want something simple and I don’t want to follow a 75 hours training…
And I’m not sure that you can have a “link” between entities and function as I want.
Do you have something to suggest me ?
I use PostgreSQL on Linux (Fedora). If you propose a tool that do this, it must be compatible with PostgreSQL 🙂
For my code documentation, I use Doxygen.
Thank you
I finally build a huge hmtl file.
File contains alot of anchors and it’s easy to navigate to different objects.
It’s a lot of work but it was exactly what I want 🙂