[phplib-dev] classdoctpl.pl and Coding Style ? From: Holger Blasum (blasum <email protected>)
Date: 05/23/00

Dear All,

being rather new to PHPLIB and having to document some minor PHPLIB-style modules please just help me checking if I am still up-to-date with PHPLIB coding standards or whether I have missed something...

Q1: Is Massimiliano Massarelli's classdoctpl.pl (which works fine) as of 29 July 1999 still the sole and only (authoritative?) tool for automatically generating documentation for PHPLIB from modules ?
Q2: Is there any written recommendation on PHPLIB coding style ? (eg classdoctpl.pl silently expects function declaration braces to open in the line the function is declared in (as eg in session.inc, ct_sql.inc, and a lot of other modules), not in the (possible alternative) K&R way which would be next line (as eg to be found in table.inc)).
Q3: I remember that on this list recently there was a discussion on the pros and cons of inline documentation (though I have not kept the mail and am unable to loacte this at the MARC or NETUSE archives apparently both ending on 26 Apr). Have any suggestions or even agreements on usage or format of inline documentation (which would allow more efficient parsing of such documentation) evolved from this?

Please understand these questions to be empirical, not normative :)

An answer to any of the questions would be greatly appreciated...
(If I have just must missed the FAQ or README, please give a gentle pointer.)

With kind regards,
Holger Blasum, Avendo, Munich

---------------------------------------------------------------------
To unsubscribe, e-mail: phplib-dev-unsubscribe <email protected>
For additional commands, e-mail: phplib-dev-help <email protected>