From 2b64659747776ed791389955cc915cfb7f0b89b2 Mon Sep 17 00:00:00 2001 From: tassium Date: Tue, 28 Oct 2003 21:30:57 +0000 Subject: [PATCH] phpdocumentor basic preparation, continued git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@6041 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- class/deliver/Deliver.class.php | 3 +-- class/deliver/Deliver_IMAP.class.php | 7 +++++++ class/deliver/Deliver_SMTP.class.php | 6 ++++++ class/deliver/Deliver_SendMail.class.php | 6 ++++++ class/helper/VCard.class.php | 6 +++++- class/html.class.php | 5 +++++ class/index.php | 1 + class/mime.class.php | 2 ++ class/mime/AddressStructure.class.php | 5 +++++ class/mime/ContentType.class.php | 5 +++++ class/mime/Disposition.class.php | 5 +++++ class/mime/Language.class.php | 5 +++++ class/mime/Message.class.php | 17 +++++++++++------ class/mime/MessageHeader.class.php | 5 +++++ class/mime/Rfc822Header.class.php | 5 +++-- class/mime/SMimeMessage.class.php | 5 +++++ include/load_prefs.php | 3 ++- include/options/display.php | 3 ++- include/options/folder.php | 3 ++- include/options/personal.php | 3 ++- include/validate.php | 3 ++- plugins/mail_fetch/class.POP3.php | 1 + src/download.php | 5 +++-- 23 files changed, 91 insertions(+), 18 deletions(-) diff --git a/class/deliver/Deliver.class.php b/class/deliver/Deliver.class.php index cc7f3e4c..190c576f 100644 --- a/class/deliver/Deliver.class.php +++ b/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; } } -?> \ No newline at end of file +?> diff --git a/class/deliver/Deliver_IMAP.class.php b/class/deliver/Deliver_IMAP.class.php index 84f5d4b3..83b82522 100644 --- 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$ + * @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() { diff --git a/class/deliver/Deliver_SMTP.class.php b/class/deliver/Deliver_SMTP.class.php index 19b30663..13f9b0ba 100644 --- 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$ + * @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) { diff --git a/class/deliver/Deliver_SendMail.class.php b/class/deliver/Deliver_SendMail.class.php index d5c6fdbc..20d20534 100644 --- 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$ + * @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) { diff --git a/class/helper/VCard.class.php b/class/helper/VCard.class.php index 29fb896f..cf369bfb 100644 --- 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$ + * @package squirrelmail */ - +/** + * Undocumented class + * @package squirrelmail + */ class VCard { function create_vcard ($value_array) { diff --git a/class/html.class.php b/class/html.class.php index faa9b3c3..93fbdf3d 100644 --- a/class/html.class.php +++ b/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; diff --git a/class/index.php b/class/index.php index 269f8987..68a04989 100644 --- a/class/index.php +++ b/class/index.php @@ -11,6 +11,7 @@ * the person is logged or not. * * $Id$ + * @package squirrelmail */ header("Location:../index.php"); diff --git a/class/mime.class.php b/class/mime.class.php index b4a4555a..2e706506 100644 --- a/class/mime.class.php +++ b/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'); diff --git a/class/mime/AddressStructure.class.php b/class/mime/AddressStructure.class.php index 91e04e27..62e50490 100644 --- 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$ + * @package squirrelmail */ +/** + * Undocumented class + * @package squirrelmail + */ class AddressStructure { var $personal = '', $adl = '', diff --git a/class/mime/ContentType.class.php b/class/mime/ContentType.class.php index 85f24ab7..cadb5d45 100644 --- 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$ + * @package squirrelmail */ +/** + * Undocumented class + * @package squirrelmail + */ class ContentType { var $type0 = 'text', $type1 = 'plain', diff --git a/class/mime/Disposition.class.php b/class/mime/Disposition.class.php index e69dae82..10da4015 100644 --- 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$ + * @package squirrelmail */ +/** + * Undocumented class + * @package squirrelmail + */ class Disposition { function Disposition($name) { $this->name = $name; diff --git a/class/mime/Language.class.php b/class/mime/Language.class.php index 3b901189..01051066 100644 --- 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$ + * @package squirrelmail */ +/** + * Undocumented class + * @package squirrelmail + */ class Language { function Language($name) { $this->name = $name; diff --git a/class/mime/Message.class.php b/class/mime/Message.class.php index 1480534f..dc2b3da1 100644 --- 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. * - 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 = '', diff --git a/class/mime/MessageHeader.class.php b/class/mime/MessageHeader.class.php index 2dc4cdb5..e0dacf3a 100644 --- 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$ + * @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 **/ diff --git a/class/mime/Rfc822Header.class.php b/class/mime/Rfc822Header.class.php index 6cefdb1f..d459fb59 100644 --- 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$ + * @package squirrelmail */ -/* - * rdc822_header class +/** * input: header_string or array + * @package squirrelmail */ class Rfc822Header { var $date = '', diff --git a/class/mime/SMimeMessage.class.php b/class/mime/SMimeMessage.class.php index e6d44555..6689c2be 100644 --- 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$ + * @package squirrelmail */ +/** + * Incomplete class, undocumented. + * @package squirrelmail + */ class SMimeMessage { } diff --git a/include/load_prefs.php b/include/load_prefs.php index 9f4038d9..a5658735 100644 --- a/include/load_prefs.php +++ b/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'); diff --git a/include/options/display.php b/include/options/display.php index cbb3fbec..5a4f820c 100644 --- a/include/options/display.php +++ b/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); diff --git a/include/options/folder.php b/include/options/folder.php index c72b9242..0a7a81d0 100644 --- a/include/options/folder.php +++ b/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'); diff --git a/include/options/personal.php b/include/options/personal.php index 26b3793d..a15d5ba5 100644 --- a/include/options/personal.php +++ b/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. */ diff --git a/include/validate.php b/include/validate.php index 38213458..8738cc35 100644 --- 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$ +* @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: diff --git a/plugins/mail_fetch/class.POP3.php b/plugins/mail_fetch/class.POP3.php index 2e2dac4e..73054318 100644 --- 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 + * @package squirrelmail */ class POP3 { var $ERROR = ''; // Error string. diff --git a/src/download.php b/src/download.php index b4f3dc1d..b14cfd8f 100644 --- a/src/download.php +++ b/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); -?> \ No newline at end of file +?> -- 2.25.1