Re: [Phpgroupware-developers] Standard source code header and phpDocumentor

[Chris Weiss]

this brings up an old topic warmed over...
are we going to move from our inline docs to phpdoc?
will phpdoc do what our inline does now? it did't used to but that was some 
time ago.
will phpdoc help make a online user commentable site like php's online manual?
is there another doc package that would suit our needs better now?

Kai, the phpgw "standards" are like they are due to much research on each 
topic, and
lots of list talk before deciding on the standard, the inlines docs are no
exception.  While I'd like to think that the standards are not written in 
stone, if
you feel phpgw would benifit from changing them it would be best to post an 
informal
proposal instead of just taking it upon yourself to use whatever you feel like.

I'd hate to see all your hard work on these much needed docs not be accepted 
just
because the tool you using isn't what the phpgw group wants to use for the job.

Kai Hofmann (address@hidden) wrote:
>
>I just have read abou the http://phpgroupware.org/wiki/Standard+Header
>and would like to ask if it would be possible add another one
>for the purpose of documenting the whole source code via phpDocumentor
>(www.phpdoc.org)
>
>  /**
>   * @author Firstname Lastname <address@hidden>
>   * @copyright Copyright (c) 2000-2003 Free Software Foundation, Inc.
>   * @license http://www.opensource.org/licenses/lgpl-license.php GNU Lesser
>General Public License
>   * @version $Id: class.accounts_contacts.inc.php,v 1.13 2002/09/21
>05:15:31 Zone Exp $
>   * @package phpgwapi
>   * @subpackage access
>   */
>
>an example of documentation generated with phpDocumentor can be found at:
>http://www.probusiness.de/projekte/phpgroupware/phpdoc/index.html
>
>
>Greetings
>
>   Kai Hofmann
>
>--
>*****    Open Source und Linux im professionellen Einsatz    *****
>**  komplexe Mailserver, Groupware, Office: sprechen Sie uns an **
>Dipl.-Inform. Kai Hofmann                    Team Softwarelösungen
>pro|business AG, EXPO Plaza 1 (Deutscher Pavillon), 30539 Hannover
>E-Mail: address@hidden,   Tel.: 0511/60066-332, Fax: -355
>WWW: http://www.probusiness.de/
>
>
>_______________________________________________
>Phpgroupware-developers mailing list
>address@hidden
>http://mail.gnu.org/mailman/listinfo/phpgroupware-developers
>