fixed/added page level docblock

browse_foreigners.php

@@ -1,8 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
 /**
  * display selection for relational field values
+ *
+ * @version $Id$
  */
 
 /**

calendar.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once('./libraries/common.lib.php');
 require_once('./libraries/header_http.inc.php');
 $page_title = $strCalendar;

chk_rel.php

@@ -1,7 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
+/**
+ *
+ * @version $Id$
+ */
 
 /**
  * Gets some core libraries

config.sample.inc.php

@@ -1,13 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * phpMyAdmin sample configuration, you can use it as base for
  * manual configuration. For easier setup you can use scripts/setup.php
  *
  * All directives are explained in Documentation.html and on phpMyAdmin
  * wiki <http://wiki.cihar.com>.
+ *
+ * @version $Id$
  */
 
 /*

db_create.php

@@ -1,7 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
+/**
+ *
+ * @version $Id$
+ */
 
 /**
  * Gets some core libraries

db_datadict.php

@@ -1,7 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
+/**
+ *
+ * @version $Id$
+ */
 
 /**
  * Gets the variables sent or posted to this script, then displays headers

db_export.php

@@ -1,9 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
 /**
  * dumps a database
  *
+ * @version $Id$
  * @uses    libraries/db_common.inc.php
  * @uses    libraries/db_info.inc.php
  * @uses    libraries/display_export.lib.php

db_import.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once('./libraries/common.lib.php');
 
 /**

db_operations.php

@@ -1,7 +1,5 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * handles miscellaneous db operations:
  *  - move/rename
@@ -10,6 +8,8 @@
  *  - changing comment
  *  - adding tables
  *  - viewing PDF schemas
+ *
+ * @version $Id$
  */
 
 /**

db_printview.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once './libraries/common.lib.php';
 
 /**

db_qbe.php

@@ -1,9 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * query by example the whole database
+ *
+ * @version $Id$
  */
 
 /**

db_sql.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once('./libraries/common.lib.php');
 
 /**

db_structure.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once './libraries/common.lib.php';
 require_once './libraries/Table.class.php';
 

import.php

@@ -1,8 +1,10 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-/* Core script for import, this is just the glue around all other stuff */
+/**
+ * Core script for import, this is just the glue around all other stuff
+ *
+ * @version $Id$
+ */
 
 /**
  * Get the variables sent or posted to this script and a core script

index.php

@@ -1,9 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
 /**
  * forms frameset
  *
+ * @version $Id$
  * @uses    libraries/common.lib.php        global fnctions
  * @uses    libraries/relation.lib.php      table relations
  * @uses    $GLOBALS['strNoFrames']

js/functions.js

@@ -1,4 +1,9 @@
-/* $Id$ */
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+/**
+ * general function, usally for data manipulation pages
+ *
+ * @version $Id$
+ */
 
 /**
  * @var sql_box_locked lock for the sqlbox textarea in the querybox/querywindow

js/indexes.js

@@ -1,5 +1,9 @@
-/* $Id$ */
-
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+/**
+ * function used for index manipulation pages
+ *
+ * @version $Id$
+ */
 
 /**
  * Ensures a value submitted in a form is numeric and is in a range

js/server_privileges.js

@@ -1,5 +1,9 @@
-/* $Id$ */
-
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+/**
+ * function used in server privilege pages
+ *
+ * @version $Id$
+ */
 
 /**
  * Validates the password field in a form

js/tbl_change.js

@@ -1,5 +1,9 @@
-/* $Id$ */
-
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+/**
+ * function used in table data manipulation pages
+ *
+ * @version $Id$
+ */
 
 /**
  * Modify from controls when the "NULL" checkbox is selected

js/tooltip.js

@@ -1,11 +1,14 @@
-/* $Id$ */
-
-
+/* vim: set expandtab sw=4 ts=4 sts=4: */
 /**
  * Displays the Tooltips (hints), if we have some
  * 2005-01-20 added by Michael Keck (mkkeck)
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 var ttXpos = 0, ttYpos = 0;
 var ttXadd = 10, ttYadd = -10;
 var ttDisplay = 0, ttHoldIt = 0;

js/user_password.js

@@ -1,5 +1,9 @@
-/* $Id$ */
-
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+/**
+ * function used for password change form
+ *
+ * @version $Id$
+ */
 
 /**
  * Validates the password field in a form

libraries/Config.class.php

@@ -1,6 +1,10 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ *
+ * @version $Id$
+ */
 
 /**
  * Configuration class

libraries/PMA_File.class.php

@@ -3,6 +3,7 @@
 /**
  * file upload functions
  *
+ * @version $Id$
  */
 
 /**

libraries/PMA_List.class.php

@@ -2,6 +2,8 @@
 /* vim: set expandtab sw=4 ts=4 sts=4: */
 /**
  * hold the PMA_List base class
+ *
+ * @version $Id$
  */
 
 /**

libraries/PMA_List_Database.class.php

@@ -3,6 +3,7 @@
 /**
  * holds the PMA_List_Database class
  *
+ * @version $Id$
  */
 
 /**

libraries/Table.class.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 class PMA_Table {
 
     /**

libraries/Theme_Manager.class.php

@@ -1,11 +1,20 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once './libraries/Theme.class.php';
 
-class PMA_Theme_Manager {
-
+/**
+ *
+ */
+class PMA_Theme_Manager
+{
     /**
      * @var string path to theme folder
      * @protected

libraries/blowfish.php

@@ -1,7 +1,5 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * The Cipher_blowfish:: class implements the Cipher interface enryption data
  * using the Blowfish algorithm.
@@ -14,7 +12,7 @@
  * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
  *
  * @author  Mike Cochrane <mike@graftonhall.co.nz>
- * @version $Revision$
+ * @version $Id$
  * @since   Horde 2.2
  * @package horde.cipher
  */

libraries/bookmark.lib.php

@@ -1,9 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used with the bookmark feature
+ *
+ * @version $Id$
  */
 
 

libraries/charset_conversion.lib.php

@@ -1,10 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-
 /**
  * Charset conversion functions.
+ *
+ * @version $Id$
  */
 
 

libraries/check_user_privileges.lib.php

@@ -1,11 +1,16 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-// Get user's global privileges and some db-specific privileges
-// ($controllink and $userlink are links to MySQL defined in the "common.lib.php" library)
-// Note: if no controluser is defined, $controllink contains $userlink
+/**
+ * Get user's global privileges and some db-specific privileges
+ * ($controllink and $userlink are links to MySQL defined in the "common.lib.php" library)
+ * Note: if no controluser is defined, $controllink contains $userlink
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 $is_create_db_priv  = false;
 $is_process_priv = true;
 $is_reload_priv  = false;

libraries/cleanup.lib.php

@@ -1,9 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Functions for cleanup of user input.
+ *
+ * @version $Id$
  */
 
 /**

libraries/database_interface.lib.php

@@ -1,9 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Common Option Constants For DBI Functions
+ *
+ * @version $Id$
+ */
+
+/**
+ *
  */
 // PMA_DBI_try_query()
 define('PMA_DBI_QUERY_STORE',       1);  // Force STORE_RESULT method, ignored by classic MySQL.

libraries/db_common.inc.php

@@ -1,6 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
 /**
  * Gets some core libraries

libraries/db_info.inc.php

@@ -1,10 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-
-// Check parameters
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ * Check parameters
+ */
 require_once('./libraries/common.lib.php');
 
 PMA_checkParameters(array('db'));

libraries/db_links.inc.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once('./libraries/common.lib.php');
 
 require_once './libraries/relation.lib.php';

libraries/db_routines.inc.php

@@ -1,8 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
-// Check parameters
+/**
+ * Check parameters
+ *
+ */
 if ( PMA_MYSQL_INT_VERSION >= 50002 ) {
     $url_query .= '&amp;goto=db_structure.php';
 

libraries/db_table_exists.lib.php

@@ -1,10 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Ensure the database and the table exist (else move to the "parent" script)
  * and display headers
+ *
+ * @version $Id$
+ */
+
+/**
+ *
  */
 if (empty($is_db)) {
     if (isset($db) && strlen($db)) {

libraries/display_create_database.lib.php

@@ -1,9 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-// Displays form for creating database (if user has privileges for that)
+/**
+ * Displays form for creating database (if user has privileges for that)
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once('./libraries/check_user_privileges.lib.php');
 
 if ($is_create_db_priv) {

libraries/display_create_table.lib.php

@@ -1,9 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-// Displays form for creating a table (if user has privileges for that)
+/**
+ * Displays form for creating a table (if user has privileges for that)
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once('./libraries/check_user_privileges.lib.php');
 
 // for MySQL >= 4.1.0, we should be able to detect if user has a CREATE

libraries/display_export.lib.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once './libraries/Table.class.php';
 
 // Get relations & co. status

libraries/display_import.lib.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once('./libraries/file_listing.php');
 require_once('./libraries/plugin_interface.lib.php');
 

libraries/display_select_lang.lib.php

@@ -1,8 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/*
+/**
  * Code for displaying language selection
- * $Id$
+ *
+ * @version $Id$
  */
 
 /**

libraries/display_tbl.lib.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once './libraries/Table.class.php';
 
 /**

libraries/display_tbl_links.lib.php

@@ -1,13 +1,18 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-// modified 2004-05-08 by Michael Keck <mail_at_michaelkeck_dot_de>
-// - bugfix for select all checkboxes
-// - copy right to left (or left to right) if user click on a check box
-// - reversed the right modify links: 1. drop, 2. edit, 3. checkbox
-// - also changes made in js/functions.js
+/**
+ * modified 2004-05-08 by Michael Keck <mail_at_michaelkeck_dot_de>
+ * - bugfix for select all checkboxes
+ * - copy right to left (or left to right) if user click on a check box
+ * - reversed the right modify links: 1. drop, 2. edit, 3. checkbox
+ * - also changes made in js/functions.js
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 if ( $doWriteModifyAt == 'left' ){
 
     if (!empty($del_url) && $is_display['del_lnk'] != 'kp') {

libraries/export/excel.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used to build CSV dumps of tables
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $plugin_list['excel'] = array(
         'text' => 'strStrucExcelCSV',

libraries/export/htmlexcel.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used to build CSV dumps of tables
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $plugin_list['htmlexcel'] = array(
         'text' => 'strHTMLExcel',

libraries/export/htmlword.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used to build CSV dumps of tables
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $plugin_list['htmlword'] = array(
         'text' => 'strHTMLWord',

libraries/export/latex.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used to build dumps of tables
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $hide_structure = false;
     if ($plugin_param['export_type'] == 'table' && !$plugin_param['single_table']) {

libraries/export/ods.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used to build CSV dumps of tables
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $plugin_list['ods'] = array(
         'text' => 'strOpenDocumentSpreadsheet',

libraries/export/odt.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used to build CSV dumps of tables
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $hide_structure = false;
     if ($plugin_param['export_type'] == 'table' && !$plugin_param['single_table']) {

libraries/export/pdf.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Produce a PDF report (export) from a query
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $plugin_list['pdf'] = array(
         'text' => 'strPDF',

libraries/export/sql.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used to build SQL dumps of tables
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $hide_sql       = false;
     $hide_structure = false;

libraries/export/xls.php

@@ -1,7 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ * Set of functions used to build XLS dumps of tables
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 // Check if we have native MS Excel export using PEAR class Spreadsheet_Excel_Writer
 if (!empty($GLOBALS['cfg']['TempDir'])) {
     @include_once('Spreadsheet/Excel/Writer.php');

libraries/export/xml.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used to build XML dumps of tables
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if (isset($GLOBALS['db']) && strlen($GLOBALS['db'])) { /* Can't do server export */
 
 if (isset($plugin_list)) {

libraries/export/yaml.php

@@ -1,7 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ * Set of functions used to build YAML dumps of tables
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $plugin_list['yaml'] = array(
         'text' => 'YAML',

libraries/file_listing.php

@@ -1,7 +1,10 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-// Functions for listing directories
+/**
+ * Functions for listing directories
+ *
+ * @version $Id$
+ */
 
 /**
  * Returns array of filtered file names

libraries/footer.inc.php

@@ -1,15 +1,17 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * WARNING: This script has to be included at the very end of your code because
  *          it will stop the script execution!
  *
  * always use $GLOBALS, as this script is also included by functions
  *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 require_once './libraries/relation.lib.php'; // for PMA_setHistory()
 
 /**

libraries/get_foreign.lib.php

@@ -1,8 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once './libraries/Table.class.php';
 
 /**

libraries/grab_globals.lib.php

@@ -1,8 +1,5 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-
 /**
  * This library grabs the names and values of the variables sent or posted to a
  * script in the $_* arrays and sets simple globals variables from them. It does
@@ -10,6 +7,8 @@
  * $HTTP_AUTHORIZATION variables.
  *
  * loic1 - 2001/25/11: use the new globals arrays defined with php 4.1+
+ *
+ * @version $Id$
  */
 
 /**

libraries/header.inc.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once './libraries/common.lib.php';
 
 if (empty($GLOBALS['is_header_sent'])) {

libraries/header_http.inc.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 if (isset($_REQUEST['GLOBALS']) || isset($_FILES['GLOBALS'])) {
     die("GLOBALS overwrite attempt");
 }

libraries/header_meta_style.inc.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 if (isset($_REQUEST['GLOBALS']) || isset($_FILES['GLOBALS'])) {
     die("GLOBALS overwrite attempt");
 }

libraries/header_printview.inc.php

@@ -1,6 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
 /**
  * Gets a core script and starts output buffering work

libraries/iconv_wrapper.lib.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 # GNU iconv code set to IBM AIX libiconv code set table
 # Keys of this table should be in lowercase, and searches should be performed using lowercase!
 $gnu_iconv_to_aix_iconv_codepage_map = array (

libraries/import/docsql.php

@@ -1,10 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ * DocSQL import plugin for phpMyAdmin
+ *
+ * @version $Id$
+ */
 
-/* DocSQL import plugin for phpMyAdmin */
-
-/* We need relations enabled and we work only on database */
+/**
+ * We need relations enabled and we work only on database
+ */
 if ($plugin_param == 'database' && $GLOBALS['num_tables'] > 0 && $GLOBALS['cfgRelation']['relwork'] && $GLOBALS['cfgRelation']['commwork']) {
     if (isset($plugin_list)) {
         $plugin_list['docsql'] = array(           // set name of your plugin

libraries/import/ldi.php

@@ -1,9 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-/* CSV import plugin for phpMyAdmin */
+/**
+ * CSV import plugin for phpMyAdmin
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 if ($plugin_param == 'table') {
     if (isset($plugin_list)) {
         if ($GLOBALS['cfg']['Import']['ldi_local_option'] == 'auto') {

libraries/import/sql.php

@@ -1,9 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-/* SQL import plugin for phpMyAdmin */
+/**
+ * SQL import plugin for phpMyAdmin
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 if (isset($plugin_list)) {
     $plugin_list['sql'] = array(
         'text' => 'strSQL',

libraries/information_schema_relations.lib.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 $GLOBALS['information_schema_relations'] = array(
     'CHARACTER_SETS' => array(
         'DEFAULT_COLLATE_NAME' => array(

libraries/ip_allow_deny.lib.php

@@ -1,10 +1,10 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * This library is used with the server IP allow/deny host authentication
  * feature
+ *
+ * @version $Id$
  */
 
 

libraries/js_escape.lib.php

@@ -1,12 +1,12 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Javascript escaping functions.
  *
  * @author Michal Čihař <michal@cihar.com>
  * @package phpMyAdmin
+ *
+ * @version $Id$
  */
 
 /**

libraries/kanji-encoding.lib.php

@@ -1,8 +1,5 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-
 /**
  * Set of functions for kanji-encoding convert (available only with japanese
  * language)
@@ -11,6 +8,8 @@
  *     --enable-mbstring --enable-mbstr-enc-trans --enable-mbregex
  *
  * 2002/2/22 - by Yukihiro Kawada <kawada@den.fujifilm.co.jp>
+ *
+ * @version $Id$
  */
 
 /**

libraries/language.lib.php

@@ -1,12 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * phpMyAdmin Language Loading File
+ *
+ * @version $Id$
  */
 
-// Detection is done here
+/**
+ * lang detection is done here
+ */
 require_once('./libraries/select_lang.lib.php');
 
 // Load the translation

libraries/mcrypt.lib.php

@@ -1,15 +1,16 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
 /**
  * Initialization
+ * Store the initialization vector because it will be needed for
+ * further decryption. I don't think necessary to have one iv
+ * per server so I don't put the server number in the cookie name.
  */
-
-// Store the initialization vector because it will be needed for
-// further decryption. I don't think necessary to have one iv
-// per server so I don't put the server number in the cookie name.
-
 if (!isset($_COOKIE['pma_mcrypt_iv'])) {
     srand((double) microtime() * 1000000);
     $iv = mcrypt_create_iv(mcrypt_get_iv_size(MCRYPT_BLOWFISH, MCRYPT_MODE_CBC), MCRYPT_RAND);

libraries/mult_submits.inc.php

@@ -1,7 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
+/**
+ *
+ * @version $Id$
+ */
 
 /**
  * Prepares the work and runs some other scripts if required

libraries/mysql_charsets.lib.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 if (PMA_MYSQL_INT_VERSION >= 40100){
 
     $res = PMA_DBI_query('SHOW CHARACTER SET;');

libraries/navigation_header.inc.php

@@ -1,12 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * displays the pma logo, links and db and server selection in left frame
  *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 if ( empty( $query_url ) ) {
     $db     = ! isset( $db )      ? '' : $db;
     $table  = ! isset( $table )   ? '' : $table;

libraries/ob.lib.php

@@ -1,8 +1,5 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-
 /**
  * Output buffer functions for phpMyAdmin
  *
@@ -11,6 +8,8 @@
  *
  * Check for all the needed functions for output buffering
  * Make some wrappers for the top and bottoms of our files.
+ *
+ * @version $Id$
  */
 
 /**

libraries/opendocument.lib.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Simple interface for creating OASIS OpenDocument files.
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 require_once('./libraries/zip.lib.php');
 
 $GLOBALS['OpenDocumentNS'] = 'xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" '

libraries/parse_analyze.lib.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 $GLOBALS['unparsed_sql'] = $sql_query;
 $parsed_sql = PMA_SQP_parse($sql_query);
 $analyzed_sql = PMA_SQP_analyze($parsed_sql);

libraries/plugin_interface.lib.php

@@ -1,9 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Generic plugin interface.
+ *
+ * @version $Id$
  */
 
 /**

libraries/relation.lib.php

@@ -1,13 +1,16 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-require_once './libraries/Table.class.php';
-
 /**
  * Set of functions used with the relation and pdf feature
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
+require_once './libraries/Table.class.php';
+
 /**
  * Executes a query as controluser if possible, otherwise as normal user
  *

libraries/relation_cleanup.lib.php

@@ -1,12 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used for cleaning up phpMyAdmin tables
+ *
+ * @version $Id$
  */
 
-
+/**
+ *
+ */
 require_once('./libraries/relation.lib.php');
 $cfgRelation = PMA_getRelationsParam();
 

libraries/select_server.lib.php

@@ -1,8 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/*
+/**
  * Code for displaying server selection written by nijel
- * $Id$
+ *
+ * @version $Id$
  */
 
 /**

libraries/server_links.inc.php

@@ -1,9 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-// Check parameters
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ * Check parameters
+ */
 require_once('./libraries/common.lib.php');
 require_once('./libraries/server_common.inc.php');
 

libraries/session.inc.php

@@ -1,9 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
 /**
  * session handling
  *
+ * @version $Id$
  * @todo    add failover or warn if sessions are not configured properly
  * @todo    add an option to use mm-module for session handler
  * @see     http://www.php.net/session

libraries/sql_query_form.lib.php

@@ -1,9 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
 /**
  * functions for displaying the sql query form
  *
+ * @version $Id$
  * @usedby  server_sql.php
  * @usedby  db_sql.php
  * @usedby  tbl_sql.php
@@ -11,6 +11,9 @@
  * @usedby  querywindow.php
  */
 
+/**
+ *
+ */
 require_once './libraries/file_listing.php'; // used for file listing
 require_once './libraries/bookmark.lib.php'; // used for file listing
 

libraries/sqlvalidator.class.php

@@ -1,7 +1,5 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
 * PHP interface to MimerSQL Validator
 *

libraries/sqlvalidator.lib.php

@@ -1,7 +1,5 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * SQL Validator interface for phpMyAdmin
  *
@@ -28,12 +26,15 @@
  * $cfg['SQLValidator']['use']  = FALSE;
  *
  * Also set a username and password if you have a private one
+ *
+ * @version $Id$
  */
 
-
-// We need the PEAR libraries, so do a minimum version check first
-// I'm not sure if PEAR was available before this point
-// For now we actually use a configuration flag
+/**
+ * We need the PEAR libraries, so do a minimum version check first
+ * I'm not sure if PEAR was available before this point
+ * For now we actually use a configuration flag
+ */
 if ($cfg['SQLValidator']['use'] == TRUE)  {
     require_once('./libraries/sqlvalidator.class.php');
 } // if ($cfg['SQLValidator']['use'] == TRUE)

libraries/storage_engines.lib.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Library for extracting information about the available storage engines
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 $GLOBALS['mysql_storage_engines'] = array();
 
 if (PMA_MYSQL_INT_VERSION >= 40102) {

libraries/string.lib.php

@@ -1,8 +1,7 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-/** Specialized String Functions for phpMyAdmin
+/**
+ * Specialized String Functions for phpMyAdmin
  *
  * Copyright 2002 Robin Johnson <robbat2@users.sourceforge.net>
  * http://www.orbis-terrarum.net/?l=people.robbat2
@@ -12,6 +11,8 @@
  * (that are slower).
  *
  * The SQL Parser code relies heavily on these functions.
+ *
+ * @version $Id$
  */
 
 /* Try to load mbstring, unless we're using buggy php version */

libraries/tbl_common.php

@@ -1,7 +1,9 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
+/**
+ *
+ * @version $Id$
+ */
 
 /**
  * Gets some core libraries

libraries/tbl_indexes.lib.php

@@ -3,7 +3,7 @@
 /**
  * function library for handling table indexes
  *
- * $Id$
+ * @version $Id$
  */
 
 /**

libraries/tbl_info.inc.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 require_once './libraries/Table.class.php';
 
 /**

libraries/tbl_links.inc.php

@@ -1,9 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
-// Check parameters
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ * Check parameters
+ */
 require_once('./libraries/common.lib.php');
 
 PMA_checkParameters(array('db', 'table'));

libraries/tbl_properties.inc.php

@@ -1,8 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-// Check parameters
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ * Check parameters
+ */
 require_once('./libraries/common.lib.php');
 PMA_checkParameters(array('db', 'table', 'action', 'num_fields'));
 

libraries/transformations.lib.php

@@ -1,11 +1,14 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * Set of functions used with the relation and pdf feature
+ *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 function PMA_transformation_getOptions($string) {
     $transform_options = array();
 

libraries/transformations/application_octetstream__download.inc.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 function PMA_transformation_application_octetstream__download(&$buffer, $options = array(), $meta = '') {
     global $row, $fields_meta;
 

libraries/transformations/application_octetstream__hex.inc.php

@@ -1,7 +1,13 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
+/**
+ *
+ * @version $Id$
+ */
 
+/**
+ *
+ */
 function PMA_transformation_application_octetstream__hex($buffer, $options = array(), $meta = '') {
     // possibly use a global transform and feed it with special options:
     // include('./libraries/transformations/global.inc.php');

libraries/transformations/global.inc.php

@@ -1,7 +1,5 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
-/* $Id$ */
-
 /**
  * GLOBAL Plugin function (Garvin Hicking).
  * ---------------
@@ -21,8 +19,12 @@
  *
  * Please provide a comment for your function, what it does and what parameters are available.
  *
+ * @version $Id$
  */
 
+/**
+ *
+ */
 function PMA_transformation_global_plain($buffer, $options = array(), $meta = '') {
     return htmlspecialchars($buffer);
 }