phpdocumentor basic preparation, continued

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@6041 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/class/deliver/Deliver.class.php b/class/deliver/Deliver.class.php
index cc7f3e4c8149108bde17b30f48214898d8e08855..190c576fc60403febeb7b6ef7c742028fa0b5dfb 100644 (file)
--- a/class/deliver/Deliver.class.php
+++ b/class/deliver/Deliver.class.php
@@ -14,7 +14,6 @@
  * @package squirrelmail
  */
 
  * @package squirrelmail
  */
 

-

 /**
  * Deliver Class - called to actually deliver the message
  *
 /**
  * Deliver Class - called to actually deliver the message
  *


@@ -676,4 +675,4 @@ class Deliver {
         return $refer;
     }
 }
         return $refer;
     }
 }

-?>
\ No newline at end of file
+?>

diff --git a/class/deliver/Deliver_IMAP.class.php b/class/deliver/Deliver_IMAP.class.php
index 84f5d4b3f94e9e700799425bfcc5664afc7bb9c5..83b8252214a452c3095e54890d22e1b4b8aeea91 100644 (file)
--- a/class/deliver/Deliver_IMAP.class.php
+++ b/class/deliver/Deliver_IMAP.class.php
@@ -8,10 +8,17 @@
  * Delivery backend for the Deliver class.
  *
  * $Id$
  * Delivery backend for the Deliver class.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/** This of course depends upon Deliver.. */
+

 require_once(SM_PATH . 'class/deliver/Deliver.class.php');
 
 require_once(SM_PATH . 'class/deliver/Deliver.class.php');
 

+/**
+ * This class is incomplete and entirely undocumented.
+ * @package squirrelmail
+ */

 class Deliver_IMAP extends Deliver {
 
     function getBcc() {
 class Deliver_IMAP extends Deliver {
 
     function getBcc() {

diff --git a/class/deliver/Deliver_SMTP.class.php b/class/deliver/Deliver_SMTP.class.php
index 19b306638772c6eadba18071ffaaa04021c228e5..13f9b0ba9dede11f81cc4f2cfcd14fc5108571de 100644 (file)
--- a/class/deliver/Deliver_SMTP.class.php
+++ b/class/deliver/Deliver_SMTP.class.php
@@ -8,10 +8,16 @@
  * Delivery backend for the Deliver class.
  *
  * $Id$
  * Delivery backend for the Deliver class.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/** This of course depends upon Deliver */

 require_once(SM_PATH . 'class/deliver/Deliver.class.php');
 
 require_once(SM_PATH . 'class/deliver/Deliver.class.php');
 

+/**
+ * Deliver messages using SMTP
+ * @package squirrelmail
+ */

 class Deliver_SMTP extends Deliver {
 
     function preWriteToStream(&$s) {
 class Deliver_SMTP extends Deliver {
 
     function preWriteToStream(&$s) {

diff --git a/class/deliver/Deliver_SendMail.class.php b/class/deliver/Deliver_SendMail.class.php
index d5c6fdbc679008d43cf3b9bb11dac820ac8f1272..20d2053424b3adea1694ee5c36f260000401e880 100644 (file)
--- a/class/deliver/Deliver_SendMail.class.php
+++ b/class/deliver/Deliver_SendMail.class.php
@@ -8,10 +8,16 @@
  * Delivery backend for the Deliver class.
  *
  * $Id$
  * Delivery backend for the Deliver class.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/** This of course depends upon Deliver */

 require_once(SM_PATH . 'class/deliver/Deliver.class.php');
 
 require_once(SM_PATH . 'class/deliver/Deliver.class.php');
 

+/**
+ * Delivers messages using the sendmail binary
+ * @package squirrelmail
+ */

 class Deliver_SendMail extends Deliver {
 
     function preWriteToStream(&$s) {
 class Deliver_SendMail extends Deliver {
 
     function preWriteToStream(&$s) {

diff --git a/class/helper/VCard.class.php b/class/helper/VCard.class.php
index 29fb896fb18f3b76333104933d515a46e7cdfa73..cf369bfbaf47d4b0d509b93dc47a0ece89b5cf2c 100644 (file)
--- a/class/helper/VCard.class.php
+++ b/class/helper/VCard.class.php
@@ -11,9 +11,13 @@
  * http://www.imc.org/pdi/vcard-21.txt
  *
  * $Id$
  * http://www.imc.org/pdi/vcard-21.txt
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-
+/**
+ * Undocumented class
+ * @package squirrelmail
+ */

 class VCard {
 
 function create_vcard ($value_array) {
 class VCard {
 
 function create_vcard ($value_array) {

diff --git a/class/html.class.php b/class/html.class.php
index faa9b3c34fbc1c6f76106a3d97fa311c67e68397..93fbdf3d3609e048fa1769e61d9b29ff13ee9189 100644 (file)
--- a/class/html.class.php
+++ b/class/html.class.php
@@ -8,8 +8,13 @@
  * This contains functions needed to generate html output.
  *
  * $Id$
  * This contains functions needed to generate html output.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/**
+ * This class needs documenting - volunteers?
+ * @package squirrelmail
+ */

 class html {
   var $tag, $text, $style, $class,  
       $id, $html_el = array(), $javascript, $xtr_prop;
 class html {
   var $tag, $text, $style, $class,  
       $id, $html_el = array(), $javascript, $xtr_prop;

diff --git a/class/index.php b/class/index.php
index 269f8987f434e5b7bfc7dfcd13a29ddaeee1663d..68a04989042e989049dfc194a3cc6a41650e04b4 100644 (file)
--- a/class/index.php
+++ b/class/index.php
@@ -11,6 +11,7 @@
  * the person is logged or not.
  *
  * $Id$
  * the person is logged or not.
  *
  * $Id$

+ * @package squirrelmail

  */
 
 header("Location:../index.php");
  */
 
 header("Location:../index.php");

diff --git a/class/mime.class.php b/class/mime.class.php
index b4a4555a1188f2bf49d60bd0ef5502f3aab58819..2e706506de200fabc0ac27c7ea8f7d85b9cbd097 100644 (file)
--- a/class/mime.class.php
+++ b/class/mime.class.php
@@ -9,8 +9,10 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
  * This contains functions needed to handle mime messages.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/** Load in the entire MIME system */

 require_once(SM_PATH . 'class/mime/Rfc822Header.class.php');
 require_once(SM_PATH . 'class/mime/MessageHeader.class.php');
 require_once(SM_PATH . 'class/mime/AddressStructure.class.php');
 require_once(SM_PATH . 'class/mime/Rfc822Header.class.php');
 require_once(SM_PATH . 'class/mime/MessageHeader.class.php');
 require_once(SM_PATH . 'class/mime/AddressStructure.class.php');

diff --git a/class/mime/AddressStructure.class.php b/class/mime/AddressStructure.class.php
index 91e04e27c87046ebe3a7fb692b551a49aae75199..62e504908be54a856cd8b49eb7fae8845cb26165 100644 (file)
--- a/class/mime/AddressStructure.class.php
+++ b/class/mime/AddressStructure.class.php
@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
  * This contains functions needed to handle mime messages.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/**
+ * Undocumented class
+ * @package squirrelmail
+ */

 class AddressStructure {
     var $personal = '',
         $adl      = '',
 class AddressStructure {
     var $personal = '',
         $adl      = '',

diff --git a/class/mime/ContentType.class.php b/class/mime/ContentType.class.php
index 85f24ab761fe3274d1ee88d8c57444772870cd81..cadb5d4577c689f06a5918787daaad9b4fb27fee 100644 (file)
--- a/class/mime/ContentType.class.php
+++ b/class/mime/ContentType.class.php
@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
  * This contains functions needed to handle mime messages.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/**
+ * Undocumented class
+ * @package squirrelmail
+ */

 class ContentType {
     var $type0      = 'text',
         $type1      = 'plain',
 class ContentType {
     var $type0      = 'text',
         $type1      = 'plain',

diff --git a/class/mime/Disposition.class.php b/class/mime/Disposition.class.php
index e69dae82566870c9981c9d63041689d55a9507c9..10da4015049323e1d7f4a3a7ba70ac6c7d8832f0 100644 (file)
--- a/class/mime/Disposition.class.php
+++ b/class/mime/Disposition.class.php
@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
  * This contains functions needed to handle mime messages.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/**
+ * Undocumented class
+ * @package squirrelmail
+ */

 class Disposition {
     function Disposition($name) {
        $this->name = $name;
 class Disposition {
     function Disposition($name) {
        $this->name = $name;

diff --git a/class/mime/Language.class.php b/class/mime/Language.class.php
index 3b9011894849ead96bd45e12549ad73899f391bc..010510665a424e13d33e2b947497a86cd3654cb6 100644 (file)
--- a/class/mime/Language.class.php
+++ b/class/mime/Language.class.php
@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
  * This contains functions needed to handle mime messages.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/**
+ * Undocumented class
+ * @package squirrelmail
+ */

 class Language {
     function Language($name) {
        $this->name = $name;
 class Language {
     function Language($name) {
        $this->name = $name;

diff --git a/class/mime/Message.class.php b/class/mime/Message.class.php
index 1480534f8d05ffd60be3711a544a3a4303f93e30..dc2b3da147dcbfae503674214c62676842877f4a 100644 (file)
--- a/class/mime/Message.class.php
+++ b/class/mime/Message.class.php
@@ -6,17 +6,22 @@
  * Copyright (c) 2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * Copyright (c) 2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *

-  This contains functions needed to handle mime messages.
+ * This contains functions needed to handle mime messages.

  *
  * $Id$
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/**
+ * The object that contains a message
+ *
+ * message is the object that contains messages.  It is a recursive
+ * object in that through the $entities variable, it can contain
+ * more objects of type message.  See documentation in mime.txt for
+ * a better description of how this works.
+ * @package squirrelmail
+ */

 class Message {
 class Message {

-    /** message is the object that contains messages.  It is a recursive
-        object in that through the $entities variable, it can contain
-        more objects of type message.  See documentation in mime.txt for
-        a better description of how this works.
-    **/

     var $rfc822_header = '',
         $mime_header = '',
         $flags = '',
     var $rfc822_header = '',
         $mime_header = '',
         $flags = '',

diff --git a/class/mime/MessageHeader.class.php b/class/mime/MessageHeader.class.php
index 2dc4cdb58a32315644f4c20285fa3c7c672e8ecd..e0dacf3a0c5b57fbbb72fc99f3fe47662bb418ed 100644 (file)
--- a/class/mime/MessageHeader.class.php
+++ b/class/mime/MessageHeader.class.php
@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
  * This contains functions needed to handle mime messages.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/**
+ * Contains all variables available in a bodystructure 
+ * @package squirrelmail
+ */

 class MessageHeader {
     /** msg_header contains all variables available in a bodystructure **/
     /** entity like described in rfc2060                               **/
 class MessageHeader {
     /** msg_header contains all variables available in a bodystructure **/
     /** entity like described in rfc2060                               **/

diff --git a/class/mime/Rfc822Header.class.php b/class/mime/Rfc822Header.class.php
index 6cefdb1f002caa59da199030b0f90275f0b1cef4..d459fb5979a73c42d0dee274ccfc941f6424139e 100644 (file)
--- a/class/mime/Rfc822Header.class.php
+++ b/class/mime/Rfc822Header.class.php
@@ -9,11 +9,12 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
  * This contains functions needed to handle mime messages.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/*
- * rdc822_header class
+/**

  * input: header_string or array
  * input: header_string or array

+ * @package squirrelmail

  */
 class Rfc822Header {
     var $date = '',
  */
 class Rfc822Header {
     var $date = '',

diff --git a/class/mime/SMimeMessage.class.php b/class/mime/SMimeMessage.class.php
index e6d44555832b7b889c6fbbe2a868edf37fde271d..6689c2bec0664090cd5f8f61fbc2517644332cf3 100644 (file)
--- a/class/mime/SMimeMessage.class.php
+++ b/class/mime/SMimeMessage.class.php
@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
  * This contains functions needed to handle mime messages.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

+/**
+ * Incomplete class, undocumented.
+ * @package squirrelmail
+ */

 class SMimeMessage {
 
 }
 class SMimeMessage {
 
 }

diff --git a/include/load_prefs.php b/include/load_prefs.php
index 9f4038d96bf0a6416d528f2dca53051e2ef710fa..a565873515cd2ca1433ae12eb8bc346c345fb1d1 100644 (file)
--- a/include/load_prefs.php
+++ b/include/load_prefs.php
@@ -10,9 +10,10 @@
  * every other script in the source directory and alswhere.
  *
  * $Id$
  * every other script in the source directory and alswhere.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* SquirrelMail required files. */
+/** SquirrelMail required files. */

 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/prefs.php');
 require_once(SM_PATH . 'functions/plugin.php');
 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/prefs.php');
 require_once(SM_PATH . 'functions/plugin.php');

diff --git a/include/options/display.php b/include/options/display.php
index cbb3fbec2d48599285d1145b98c680565b499176..5a4f820c5fc813955025ed6a57596a09a77a946e 100644 (file)
--- a/include/options/display.php
+++ b/include/options/display.php
@@ -9,9 +9,10 @@
  * Displays all optinos about display preferences
  *
  * $Id$
  * Displays all optinos about display preferences
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Define the group constants for the display options page. */
+/** Define the group constants for the display options page. */

 define('SMOPT_GRP_GENERAL', 0);
 define('SMOPT_GRP_MAILBOX', 1);
 define('SMOPT_GRP_MESSAGE', 2);
 define('SMOPT_GRP_GENERAL', 0);
 define('SMOPT_GRP_MAILBOX', 1);
 define('SMOPT_GRP_MESSAGE', 2);

diff --git a/include/options/folder.php b/include/options/folder.php
index c72b92421a8a1cf586556950ebb133b1f5f5b78f..0a7a81d0f15fc10005d72f48dd734568ab7f9d78 100644 (file)
--- a/include/options/folder.php
+++ b/include/options/folder.php
@@ -9,9 +9,10 @@
  * Displays all options relating to folders
  *
  * $Id$
  * Displays all options relating to folders
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* SquirrelMail required files. */
+/** SquirrelMail required files. */

 require_once(SM_PATH . 'functions/imap.php');
 require_once(SM_PATH . 'functions/imap_general.php');
 
 require_once(SM_PATH . 'functions/imap.php');
 require_once(SM_PATH . 'functions/imap_general.php');
 

diff --git a/include/options/personal.php b/include/options/personal.php
index 26b3793d033477e6754c3eec562a29d9b3b76a8f..a15d5ba55d83eb5a23b4d742453f3d50905f9139 100644 (file)
--- a/include/options/personal.php
+++ b/include/options/personal.php
@@ -9,9 +9,10 @@
  * Displays all options relating to personal information
  *
  * $Id$
  * Displays all options relating to personal information
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* SquirrelMail required files. */
+/** SquirrelMail required files. */

 require_once(SM_PATH . 'functions/imap.php');
 
 /* Define the group constants for the personal options page. */
 require_once(SM_PATH . 'functions/imap.php');
 
 /* Define the group constants for the personal options page. */

diff --git a/include/validate.php b/include/validate.php
index 3821345822bcb266efd690c28c20e3910652e633..8738cc35f2ff84b56d6675df90666cfa4a14af23 100644 (file)
--- a/include/validate.php
+++ b/include/validate.php
@@ -7,9 +7,10 @@
 * Licensed under the GNU GPL. For full terms see the file COPYING.
 *
 * $Id$
 * Licensed under the GNU GPL. For full terms see the file COPYING.
 *
 * $Id$

+* @package squirrelmail

 */
 
 */
 

-/* include the mime class before the session start ! otherwise we can't store
+/** include the mime class before the session start ! otherwise we can't store

  * messages with a session_register.
  *
  * From http://www.php.net/manual/en/language.oop.serialization.php:
  * messages with a session_register.
  *
  * From http://www.php.net/manual/en/language.oop.serialization.php:

diff --git a/plugins/mail_fetch/class.POP3.php b/plugins/mail_fetch/class.POP3.php
index 2e2dac4edd2930bb818b52eac7d91d62804015aa..7305431897b3a23cd0cedb306aaa40fd71fee0e2 100644 (file)
--- a/plugins/mail_fetch/class.POP3.php
+++ b/plugins/mail_fetch/class.POP3.php
@@ -20,6 +20,7 @@
 
 /**
  * This is the pop3 class - DOCUMENT ME
 
 /**
  * This is the pop3 class - DOCUMENT ME

+ * @package squirrelmail

  */
 class POP3 {
     var $ERROR      = '';       //  Error string.
  */
 class POP3 {
     var $ERROR      = '';       //  Error string.

diff --git a/src/download.php b/src/download.php
index b4f3dc1de4ae7ac7ba9d13d4c4313a28f5358438..b14cfd8f7d9a9d86d5efa23bfbb32772c95f3955 100644 (file)
--- a/src/download.php
+++ b/src/download.php
@@ -10,9 +10,10 @@
  * Also allows displaying of attachments when possible.
  *
  * $Id$
  * Also allows displaying of attachments when possible.
  *
  * $Id$

+ * @package squirrelmail

  */
 
  */
 

-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */

 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */


@@ -141,4 +142,4 @@ if (isset($absolute_dl) && $absolute_dl) {
  * attachment in case of ERROR reporting = E_ALL and the output is the screen */
 mime_print_body_lines ($imapConnection, $passed_id, $ent_id, $encoding);
 
  * attachment in case of ERROR reporting = E_ALL and the output is the screen */
 mime_print_body_lines ($imapConnection, $passed_id, $ent_id, $encoding);
 

-?>
\ No newline at end of file
+?>