Re: Q: use doxygen to document SQL schema files?

Albrecht Dreß <[email protected]> Sat, 09 Jun 2018 14:35:56 +0200

Newsgroups	gmane.text.doxygen.general
Message-ID	<[email protected]>

Hi Bob:

Am 08.06.18 22:01 schrieb(en) Robert Hairgrove:
> There have been one or two noteworthy efforts ... check out the Doxygen website, maybe there is something new out there.

Nothing, unfortunately…

> In the meantime, you might want to look into SchemaSpy and its GUI:
> 
> http://schemaspy.sourceforge.net/
> http://www.joachim-uhl.de/projekte/schemaspygui/
> http://schemaspygui.sourceforge.net/

Thanks a lot for that hint, it actually looks much better than  PostgreSQL Autodoc (<https://github.com/cbbrowne/autodoc>)!

> Sadly, none of these tools seems capable of documenting stored procedures or views.

This is exactly what I miss from PSQL-Autodoc, in particular the documentation of the DB functions!

In my project, they provide a simple “middleware” between the db and the user apps, so it would be cool to let doxygen (or some other tool) extract the description from PostgreSQL's “COMMENT ON” (non-standard, unfortunately) statements, and create the usual cross-references (call/caller graphs, DB function/table relationships, …).

Cheers,
Albrecht.

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot

_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users

signature.asc (application/pgp-signature, 488 B)