Bladeren bron

fixing phpdoc warnings re:SM_PATH. Moving Id tags to @version

tokul 21 jaren geleden
bovenliggende
commit
d301d8bedb

+ 5 - 2
src/addrbook_popup.php

@@ -8,11 +8,14 @@
  *
  * Frameset for the JavaScript version of the address book.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /** SquirrelMail required files. */

+ 2 - 1
src/addrbook_search.php

@@ -12,12 +12,13 @@
  *       addrbook_search_html.html -- If you change one,
  *       change the other one too!
  *
- * $Id$ 
+ * @version $Id$ 
  * @package squirrelmail
  */
 
 /**
  * Path for SquirrelMail required files.
+ * @ignore
  */
 define('SM_PATH','../');
 

+ 5 - 2
src/addrbook_search_html.php

@@ -10,11 +10,14 @@
  *
  * This file is included from compose.php
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/** 
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 if (! defined('SM_PATH') ) {
 	define('SM_PATH','../');
 }

+ 5 - 2
src/addressbook.php

@@ -8,11 +8,14 @@
  *
  * Manage personal address book.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /** SquirrelMail required files. */

+ 5 - 2
src/compose.php

@@ -14,11 +14,14 @@
  *    - Send mail
  *    - Save As Draft
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/configtest.php

@@ -1,11 +1,13 @@
 <?php
-/*
+/**
  * SquirrelMail configtest script
  *
  * Copyright (c) 2003-2004 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage config
  */
 
 /************************************************************
@@ -25,6 +27,7 @@ function do_err($str, $exit = TRUE) {
 $IND = str_repeat('&nbsp;',4);
 
 ob_implicit_flush();
+/** @ignore */
 define('SM_PATH', '../');
 
 /*

+ 5 - 2
src/delete_message.php

@@ -8,11 +8,14 @@
  *
  * Deletes a meesage from the IMAP server
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/download.php

@@ -9,11 +9,14 @@
  * Handles attachment downloads to the users computer.
  * Also allows displaying of attachments when possible.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files. 
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/empty_trash.php

@@ -9,11 +9,14 @@
  * Handles deleting messages from the trash folder without
  * deleting subfolders.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/folders.php

@@ -10,11 +10,14 @@
  * scripts which do most of the work. Also handles the Special
  * Folders.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/folders_create.php

@@ -9,11 +9,14 @@
  * Creates folders on the IMAP server.
  * Called from folders.php
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/folders_delete.php

@@ -9,11 +9,14 @@
  * Deletes folders from the IMAP server. 
  * Called from the folders.php
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/folders_rename_do.php

@@ -9,11 +9,14 @@
  * Does the actual renaming of files on the IMAP server.
  * Called from the folders.php
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/folders_rename_getname.php

@@ -9,11 +9,14 @@
  * Gets folder names and enables renaming
  * Called from folders.php
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/folders_subscribe.php

@@ -9,11 +9,14 @@
  * Subscribe and unsubcribe from folders. 
  * Called from folders.php
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/help.php

@@ -8,11 +8,14 @@
  *
  * Displays help for the user
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/image.php

@@ -8,11 +8,14 @@
  *
  * This file shows an attached image
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 1 - 1
src/index.php

@@ -10,7 +10,7 @@
  * people to the login screen. At this point no attempt is made to see if
  * the person is logged or not.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 

+ 5 - 2
src/left_main.php

@@ -9,11 +9,14 @@
  * This is the code for the left bar. The left bar shows the folders
  * available, and has cookie information.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/login.php

@@ -9,11 +9,14 @@
  * This a simple login screen. Some housekeeping is done to clean
  * cookies and find language.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/mailto.php

@@ -14,11 +14,14 @@
  * Use the following url to use mailto:
  * http://<your server>/<squirrelmail base dir>/src/mailto.php?emailaddress=%1
  * see ../contrib/squirrelmail.mailto.reg for a Windows Registry file
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/move_messages.php

@@ -8,11 +8,14 @@
  *
  * Enables message moving between folders on the IMAP server.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/options.php

@@ -9,11 +9,14 @@
  * Displays the options page. Pulls from proper user preference files
  * and config.php. Displays preferences as selected and other options.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/options_highlight.php

@@ -8,11 +8,14 @@
  *
  * Displays message highlighting options
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/options_identities.php

@@ -8,11 +8,14 @@
  *
  * Display Identities Options
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/options_order.php

@@ -8,11 +8,14 @@
  *
  * Displays messagelist column order options
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/printer_friendly_bottom.php

@@ -11,11 +11,14 @@
  *
  * - this is the page that does all the work, really.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/printer_friendly_main.php

@@ -6,11 +6,14 @@
  * Copyright (c) 1999-2004 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/printer_friendly_top.php

@@ -9,11 +9,14 @@
  * top frame of printer_friendly_main.php
  * displays some javascript buttons for printing & closing
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/read_body.php

@@ -8,11 +8,14 @@
  * This file is used for reading the msgs array and displaying
  * the resulting emails in the right frame.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/redirect.php

@@ -9,11 +9,14 @@
 *
 * Prevents users from reposting their form data after a successful logout.
 *
-* $Id$
+* @version $Id$
 * @package squirrelmail
 */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/right_main.php

@@ -8,11 +8,14 @@
  * This is where the mailboxes are listed. This controls most of what
  * goes on in SquirrelMail.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 7 - 4
src/search.php

@@ -8,15 +8,18 @@
  *
  * IMAP search page
  *
- * $Id$
+ * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
+ *
+ * @version $Id$
  * @package squirrelmail
  * @link http://www.ietf.org/rfc/rfc3501.txt
  * @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
- *
- * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /** SquirrelMail required files. */

+ 7 - 4
src/search_advanced.php

@@ -8,15 +8,18 @@
  *
  * IMAP Advanced search page
  *
- * $Id$
+ * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
+ *
+ * @version $Id$
  * @package squirrelmail
  * @link http://www.ietf.org/rfc/rfc3501.txt
  * @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
- *
- * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /** SquirrelMail required files. */

+ 5 - 2
src/signout.php

@@ -8,11 +8,14 @@
  *
  *  Cleans up after the user. Resets cookies and terminates session.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/vcard.php

@@ -8,11 +8,14 @@
  *
  * This file shows an attched vcard
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 Define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/view_header.php

@@ -8,11 +8,14 @@
  *
  * This is the code to view the message header.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/view_text.php

@@ -10,11 +10,14 @@
  * A SINGLE FREAKING COMMENT IN! Whoever is responsible for this,
  * be very ashamed.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */

+ 5 - 2
src/webmail.php

@@ -10,11 +10,14 @@
  * shown can be given as parameters. If the user is not logged in
  * this file will verify username and password.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */