From: Philippe M. <phi...@us...> - 2001-11-24 18:38:56
|
Update of /cvsroot/squirrelmail/squirrelmail/functions In directory usw-pr-cvs1:/tmp/cvs-serv18545/functions Modified Files: options.php Log Message: Some cleanup. Index: options.php =================================================================== RCS file: /cvsroot/squirrelmail/squirrelmail/functions/options.php,v retrieving revision 1.11 retrieving revision 1.12 diff -u -w -r1.11 -r1.12 --- options.php 2001/11/21 18:38:11 1.11 +++ options.php 2001/11/24 18:38:52 1.12 @@ -1,15 +1,15 @@ <?php /** - * options.php - * - * Copyright (c) 1999-2001 The Squirrelmail Development Team - * Licensed under the GNU GPL. For full terms see the file COPYING. - * - * Functions needed to display the options pages. - * - * $Id$ - */ + ** options.php + ** + ** Copyright (c) 1999-2001 The Squirrelmail Development Team + ** Licensed under the GNU GPL. For full terms see the file COPYING. + ** + ** Functions needed to display the options pages. + ** + ** $Id$ + **/ /**********************************************/ /* Define constants used in the options code. */ |
From: Paul J. T. <cap...@sq...> - 2001-11-24 20:55:47
|
Philippe Mingo said: > Update of /cvsroot/squirrelmail/squirrelmail/functions > Index: options.php > =================================================================== > RCS file: > /cvsroot/squirrelmail/squirrelmail/functions/options.php,v > retrieving revision 1.11 > retrieving revision 1.12 > diff -u -w -r1.11 -r1.12 > --- options.php 2001/11/21 18:38:11 1.11 > +++ options.php 2001/11/24 18:38:52 1.12 > @@ -1,15 +1,15 @@ > <?php > > /** > - * options.php > - * > - * Copyright (c) 1999-2001 The Squirrelmail Development Team > - * Licensed under the GNU GPL. For full terms see the file... > - * > - * Functions needed to display the options pages. > - * > - * $Id$ > - */ > + ** options.php > + ** > + ** Copyright (c) 1999-2001 The Squirrelmail Development Team > + ** Licensed under the GNU GPL. For full terms see the file... > + ** > + ** Functions needed to display the options pages. > + ** > + ** $Id$ > + **/ Hehe. Philippe, we seem to have been working against each other here. :) For the future of Squirrelmail, I would like to standardize on a phpdoc style of internally documenting our code. Toward that goal, I have been editing the copyright (and other comment blocks) to look like what you replaced above. Anyways, I would like the copyright comment blocks at the top of the pages to be of the following style: /** * $FILENAME.php * * Copyright (c) 1999-2001 The Squirrelmail Development Team * Licensed under the GNU GPL. For full terms see the file COPYING * * Functions needed to display the options pages. * * $Id$ */ IMHO, I just think this looks cleaner, and is more along the style used with phpdoc style documentation. Btw, the reason I would like to use phpdoc is that it will allow us automatically create documentation from the internally documented comments (just by running phpdoc). That will make it easier to work the code of Squirrelmail as someone wouldn't have to go look at the source of a function to find out what it does. Rather, they could just go look at the documenation. I think that would be a good thing. What does everyone think? -- Paul Joseph Thompson cap...@sq... AIM/Yahoo/MSN IM: Captain Bunzo ICQ Number: 38801719 |
From: Philippe M. <mi...@ro...> - 2001-11-24 23:57:07
|
> I think that would be a good thing. What does everyone think? It is fine with me, but I've already changed all the sources with the ** shema 8) -- Saludos: Philippe Mingo D. Informático de Rotedic, S.A. Tel. 918031676 - Fax. 918038516 Rda. Valdecarrizo 13 28760 Madrid - España (Spain) |