Doxygen-like for .sql files in a php application -
we using doxygen document our php application , it's working have problem database structure: document .sql file using create tables (arround 60 tables far).
no sql procedures (might in future).
what have describe role of each table , meaning of each column. found hypersql (http://projects.izzysoft.de/trac/hypersql/) found little verbose:
008: /** logging messages 009:  *  (here log our actions) 010:  * @table iz_logging 011:  * @col number id id sorting purposes 012:  * @col date log_time time entry made 013:  * @col char(1) log_level logging level. here: "!" errors, "*" main (job start/end), "+" sub (e.g. switch next owner), "-" minor 014:  * @col varchar2(4000) log_entry log message 015:  * @author andreas itzchak rehberg 016:  */ 017: create table iz_logging ( 018:   id         number, 019:   log_time   date, 020:   log_level  char(1), 021:   log_entry  varchar2(4000) 022: );   is there tool wouldn't ask me repeat column type (date,char...) ? using document php/mysql projects ?
functionnality :
- automatic detection of column's type
 - possibility group tables in categories (like in doxygen functions inside class)
 - html output : way, insert links php doc sql doc
 
thanks !
i have written input filter doxygen translates sql tables, procedures , functions c structs , c functions doxygen parse it. can use doxygen style comments in normal way translated too.
this implemented powershell script , examples aimed @ t-sql (i.e. sql server) should adapted other dialect. called sql2doxygen , here example of output , there manual here.
for me stop gap until doxygen natively supports sql. discovered doxygen branch in travels called sqldoxygen may provide goods.
Comments
Post a Comment