PostgreSQL Discussion - how to document database

Author

how to document database

Ottavio Campana

2006-04-07, 3:36 am

I need to document the database I develop so that other people can
easily understand how it works.

I particularly want to document the stored procedures. By now I've used
a javadoc style to document them. I can't use tools like doxygen on them
but it is always better than nothing.

I'd like to know if you're using some particular tool.

Thanks

--
Non c'è più forza nella normalità, c'è solo monotonia.

Ottavio Campana

2006-04-07, 7:34 am

Kaloyan Iliev wrote:
> Hi,
>
> I'm using postgresql_autodoc. It is perfect for me. And if you have
> comments in the database the created document is like real documentation:-)

I can't make it work. I'm running Debian etch, and I always get

bott@banach:/tmp$ postgresql_autodoc -d tost
Can't call method "finish" on an undefined value at
/usr/bin/postgresql_autodoc line 1203.
bott@banach:/tmp$ man postgresql_autodoc

do you know what's wrong with it?

And how do you document the stored procedures? can you have something
similar to doxygen with postgresql_autodoc?

--
Non c'è più forza nella normalità, c'è solo monotonia.

Kaloyan Iliev

2006-04-08, 9:25 am

Hi,

I am not familiar with doxygen, so I can't give you any advice. To me
postgresql_autodoc -d <dbname> works perfectly.
I am useing version 1.25 of postgresql_autodoc.

I recevice documentation of the sotred rocedures when I have comments on them. Then when
postgresql_autodoc generate HTML documentation the comments are there. That's it.
I am sorry if this doesn't help you much.

Have a nice day,

Kaloyan Iliev

Ottavio Campana wrote:

>Kaloyan Iliev wrote:
>
>
>
>I can't make it work. I'm running Debian etch, and I always get
>
>bott@banach:/tmp$ postgresql_autodoc -d tost
>Can't call method "finish" on an undefined value at
>/usr/bin/postgresql_autodoc line 1203.
>bott@banach:/tmp$ man postgresql_autodoc
>
>do you know what's wrong with it?
>
>And how do you document the stored procedures? can you have something
>similar to doxygen with postgresql_autodoc?
>
>
>

Sponsored Links