[Jaws-project-developers] Coding and doc. conventions

[Raul M. <ra...@mu...>]

Hi all,
After some flu days :( I'm reading more deeply the Jaws code to start
helping on code doc. and bugfixing.

Most files doesn't follow some of our published coding styles[1]: 8
indenting spaces, opening braces on the same line as the statement and
so on... But don't flame me: I'm not a purist so heterogeneous code is
not a big problem for me if it isn't for you ;) but I think that if we
want that new coders to follow a coding style we must also follow it. 

I assume that the main priority is to have a full working version and we
can cleanup the code later. Only a quick note: we could try
PHP_Beautifier[2] to do this and we must remember to update our coding
guidelines after cleanup the code.

Another question, now related to phpdoc: some files has lines as:
@package Jaws
@subpackage gadgets
or 
@package JawsCore

I think that using packaging on phpdoc is a good idea, but I still don't
know what packaging structure should we follow, so I will write phpdoc
without package tags until we decide about packaging.

Greetings,
	Raul Murciano

[1] http://wiki.jaws.com.mx/doku.php?id=jaws:development:guidelines

[2] PEAR package: http://pear.php.net/package/PHP_Beautifier
Author's blog related entries:
http://www.apsique.virtuabyte.cl/php/index.php/archivo/category/php/php_beautifier/