Hi everyone

I'm trying to document my classes, but I'm completly clear the way it
should take.

for the class i agree the following vars are enough
@filesource        user.php
@copyright         Copyright (c) 2006, Cake Software Foundation, Inc.
@link           http://www.cakefoundation.org/projects/info/cakephp CakePHP
Project
@package                        cake
@subpackage             cake.app.config
@since                  CakePHP v 0.10.8.2117
@version                        $Revision: 2951 $
@modifiedby             $LastChangedBy: phpnut $
@lastmodified   $Date: 2006-05-25 17:12:33 -0500 (Thu, 25 May 2006) $
@license

and maybe add @autor

but, if i have let's say a model User and the controller is Users, what
should be @package and @subpackage for each one?
is @filesource right?

what would you say are the vars to put before a method?, maybe

@author name
@param objA
@param objB
@returns int value
@access public

and for variables

@var string $userName
@access  public

well, any help or/and any advices are mostly welcome


--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups "Cake 
PHP" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at http://groups.google.com/group/cake-php
-~----------~----~----~----~------~----~------~--~---

Reply via email to