From a7532db94f507de668ba728fb999ec0c739f1a7f Mon Sep 17 00:00:00 2001 From: avel Date: Fri, 21 Nov 2003 11:23:02 +0000 Subject: [PATCH] Some guidelines and pointers on how to write phpdoc comments for plugins. Probably only for devel branch. git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@6185 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- doc/plugin.txt | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/doc/plugin.txt b/doc/plugin.txt index 342ac78b..4530e580 100644 --- a/doc/plugin.txt +++ b/doc/plugin.txt @@ -1057,6 +1057,41 @@ files. and change your Language setting to see the translations in action! + +Documenting the Code (Optional) +------------------------------- + +If you wish, you can use phpdoc (Javadoc-style) comments, when documenting your +code. + +If you follow the standards that are followed between Squirrelmail core & +plugin developers, the resulted documentation can be included with the rest of +the Squirrelmail code & API documentation. Specifically, in the page-level +docblock, declare the package to be 'plugins', and the subpackage to be the +name of your plugin. For instance: + +/** + * demo.php + * + * Copyright (c) 2003 My Name + * Licensed under the GNU GPL. For full terms see the file COPYING. + * + * @package plugins + * @subpackage demo + */ + +The rest is up to you. Try to follow some common sense and document what is +really needed. Documenting the code properly can be a big help not only to +yourself, but to those who will take a look at your code, fix the bugs and even +improve it, in the true open-source spirit that Squirrelmail was built upon. + +For more information about phpdocumentor and how to write proper-tagged +comments, you are directed at: + +http://phpdocu.sourceforge.net/ + + + PLUGIN STANDARDS AND REQUIREMENTS ================================= -- 2.25.1