phpdocumentor basic preparation, continued

class/deliver/Deliver.class.php

@@ -14,7 +14,6 @@
  * @package squirrelmail
  */
 
-
 /**
  * Deliver Class - called to actually deliver the message
  *
@@ -676,4 +675,4 @@ class Deliver {
         return $refer;
     }
 }
-?>
+?>

class/deliver/Deliver_IMAP.class.php

@@ -8,10 +8,17 @@
  * Delivery backend for the Deliver class.
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/** This of course depends upon Deliver.. */
+
 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/Deliver_SMTP.class.php

@@ -8,10 +8,16 @@
  * Delivery backend for the Deliver class.
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/** This of course depends upon Deliver */
 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/Deliver_SendMail.class.php

@@ -8,10 +8,16 @@
  * Delivery backend for the Deliver class.
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/** This of course depends upon Deliver */
 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/helper/VCard.class.php

@@ -11,9 +11,13 @@
  * http://www.imc.org/pdi/vcard-21.txt
  *
  * $Id$
+ * @package squirrelmail
  */
 
-
+/**
+ * Undocumented class
+ * @package squirrelmail
+ */
 class VCard {
 
 function create_vcard ($value_array) {

class/html.class.php

@@ -8,8 +8,13 @@
  * 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/index.php

@@ -11,6 +11,7 @@
  * the person is logged or not.
  *
  * $Id$
+ * @package squirrelmail
  */
 
 header("Location:../index.php");

class/mime.class.php

@@ -9,8 +9,10 @@
  * 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');

class/mime/AddressStructure.class.php

@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/**
+ * Undocumented class
+ * @package squirrelmail
+ */
 class AddressStructure {
     var $personal = '',
         $adl      = '',

class/mime/ContentType.class.php

@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/**
+ * Undocumented class
+ * @package squirrelmail
+ */
 class ContentType {
     var $type0      = 'text',
         $type1      = 'plain',

class/mime/Disposition.class.php

@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/**
+ * Undocumented class
+ * @package squirrelmail
+ */
 class Disposition {
     function Disposition($name) {
        $this->name = $name;

class/mime/Language.class.php

@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/**
+ * Undocumented class
+ * @package squirrelmail
+ */
 class Language {
     function Language($name) {
        $this->name = $name;

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.
  *
-  This contains functions needed to handle mime messages.
+ * This contains functions needed to handle mime messages.
  *
  * $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 {
-    /** 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 = '',

class/mime/MessageHeader.class.php

@@ -9,8 +9,13 @@
  * 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/mime/Rfc822Header.class.php

@@ -9,11 +9,12 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
+ * @package squirrelmail
  */
 
-/*
- * rdc822_header class
+/**
  * input: header_string or array
+ * @package squirrelmail
  */
 class Rfc822Header {
     var $date = '',

class/mime/SMimeMessage.class.php

@@ -9,8 +9,13 @@
  * This contains functions needed to handle mime messages.
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/**
+ * Incomplete class, undocumented.
+ * @package squirrelmail
+ */
 class SMimeMessage {
 
 }

include/load_prefs.php

@@ -10,9 +10,10 @@
  * 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');

include/options/display.php

@@ -9,9 +9,10 @@
  * 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);

include/options/folder.php

@@ -9,9 +9,10 @@
  * 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');
 

include/options/personal.php

@@ -9,9 +9,10 @@
  * 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. */

include/validate.php

@@ -7,9 +7,10 @@
 * 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:

plugins/mail_fetch/class.POP3.php

@@ -20,6 +20,7 @@
 
 /**
  * This is the pop3 class - DOCUMENT ME
+ * @package squirrelmail
  */
 class POP3 {
     var $ERROR      = '';       //  Error string.

src/download.php

@@ -10,9 +10,10 @@
  * 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. */
@@ -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);
 
-?>
+?>