nettika/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix docstrings.

Browse Source
This commit is contained in:
Michal Čihař
2010-04-29 14:44:05 +02:00
parent 89c08b468b
commit 34d51adab7
1 changed files with 53 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
pdf_schema.php
View File

@@ -99,11 +99,11 @@ class PMA_PDF extends TCPDF {
/** /**
* Sets the scaling factor, defines minimum coordinates and margins * Sets the scaling factor, defines minimum coordinates and margins
* *
* @param double scale The scaling factor * @param float scale The scaling factor
* @param double x_min The minimum X coordinate * @param float x_min The minimum X coordinate
* @param double y_min The minimum Y coordinate * @param float y_min The minimum Y coordinate
* @param double l_marg The left margin * @param float l_marg The left margin
* @param double t_marg The top margin * @param float t_marg The top margin
* @access public * @access public
*/ */
function PMA_PDF_setScale($scale = 1, $x_min = 0, $y_min = 0, $l_marg = -1, $t_marg = -1) function PMA_PDF_setScale($scale = 1, $x_min = 0, $y_min = 0, $l_marg = -1, $t_marg = -1)
@@ -121,13 +121,13 @@ class PMA_PDF extends TCPDF {
/** /**
* Outputs a scaled cell * Outputs a scaled cell
* *
* @param double $ The cell width * @param float w The cell width
* @param double $ The cell height * @param float h The cell height
* @param string $ The text to output * @param string txt The text to output
* @param mixed $ Whether to add borders or not * @param mixed border Whether to add borders or not
* @param integer $ Where to put the cursor once the output is done * @param integer ln Where to put the cursor once the output is done
* @param string $ Align mode * @param string align Align mode
* @param integer $ Whether to fill the cell with a color or not * @param integer fill Whether to fill the cell with a color or not
* @access public * @access public
* @see FPDF::Cell() * @see FPDF::Cell()
*/ */
@@ -140,10 +140,10 @@ class PMA_PDF extends TCPDF {
/** /**
* Draws a scaled line * Draws a scaled line
* *
* @param double $ The horizontal position of the starting point * @param float x1 The horizontal position of the starting point
* @param double $ The vertical position of the starting point * @param float y1 The vertical position of the starting point
* @param double $ The horizontal position of the ending point * @param float x2 The horizontal position of the ending point
* @param double $ The vertical position of the ending point * @param float y2 The vertical position of the ending point
* @access public * @access public
* @see FPDF::Line() * @see FPDF::Line()
*/ */
@@ -158,8 +158,8 @@ class PMA_PDF extends TCPDF {
/** /**
* Sets x and y scaled positions * Sets x and y scaled positions
* *
* @param double $ The x position * @param float x The x position
* @param double $ The y position * @param float y The y position
* @access public * @access public
* @see FPDF::SetXY() * @see FPDF::SetXY()
*/ */
@@ -172,7 +172,7 @@ class PMA_PDF extends TCPDF {
/** /**
* Sets the X scaled positions * Sets the X scaled positions
* *
* @param double $ The x position * @param float x The x position
* @access public * @access public
* @see FPDF::SetX() * @see FPDF::SetX()
*/ */
@@ -184,7 +184,7 @@ class PMA_PDF extends TCPDF {
/** /**
* Sets the scaled font size * Sets the scaled font size
* *
* @param double $ The font size (in points) * @param float size The font size (in points)
* @access public * @access public
* @see FPDF::SetFontSize() * @see FPDF::SetFontSize()
*/ */
@@ -197,7 +197,7 @@ class PMA_PDF extends TCPDF {
/** /**
* Sets the scaled line width * Sets the scaled line width
* *
* @param double $ The line width * @param float width The line width
* @access public * @access public
* @see FPDF::SetLineWidth() * @see FPDF::SetLineWidth()
*/ */
@@ -209,7 +209,7 @@ class PMA_PDF extends TCPDF {
/** /**
* Displays an error message * Displays an error message
* *
* @param string $ the error mesage * @param string error_message the error mesage
* @global array the PMA configuration array * @global array the PMA configuration array
* @global integer the current server id * @global integer the current server id
* @global string the current language * @global string the current language
@@ -247,7 +247,7 @@ class PMA_PDF extends TCPDF {
* Aliases the "Error()" function from the FPDF class to the * Aliases the "Error()" function from the FPDF class to the
* "PMA_PDF_die()" one * "PMA_PDF_die()" one
* *
* @param string $ the error mesage * @param string error_message the error mesage
* @access public * @access public
* @see PMA_PDF_die * @see PMA_PDF_die
*/ */
@@ -525,7 +525,7 @@ class PMA_RT_Table {
/** /**
* Sets the width of the table * Sets the width of the table
* *
* @param integer $ The font size * @param integer ff The font size
* @global object The current PDF document * @global object The current PDF document
* @access private * @access private
* @see PMA_PDF * @see PMA_PDF
@@ -558,9 +558,8 @@ class PMA_RT_Table {
/** /**
* Do draw the table * Do draw the table
* *
* @param integer $ The font size * @param integer ff The font size
* @param boolean $ Whether to display color * @param boolean setcolortWhether to display color
* @param integer $ The max. with among tables
* @global object The current PDF document * @global object The current PDF document
* @access private * @access private
* @see PMA_PDF * @see PMA_PDF
@@ -613,11 +612,11 @@ class PMA_RT_Table {
/** /**
* The "PMA_RT_Table" constructor * The "PMA_RT_Table" constructor
* *
* @param string $ The table name * @param string table_name The table name
* @param integer $ The font size * @param integer ff The font size
* @param integer $ The max. with among tables * @param integer same_width The max. with among tables
* @param boolean $ Whether to display keys or not * @param boolean show_keys Whether to display keys or not
* @param boolean $ Whether to display table position or not * @param boolean show_info Whether to display table position or not
* @global object The current PDF document * @global object The current PDF document
* @global integer The current page number (from the * @global integer The current page number (from the
* $cfg['Servers'][$i]['table_coords'] table) * $cfg['Servers'][$i]['table_coords'] table)
@@ -709,8 +708,8 @@ class PMA_RT_Relation {
/** /**
* Gets arrows coordinates * Gets arrows coordinates
* *
* @param string $ The current table name * @param string table The current table name
* @param string $ The relation column name * @param string column The relation column name
* @return array Arrows coordinates * @return array Arrows coordinates
* @access private * @access private
*/ */
@@ -723,8 +722,8 @@ class PMA_RT_Relation {
/** /**
* Do draws relation links * Do draws relation links
* *
* @param boolean $ Whether to use one color per relation or not * @param boolean change_color Whether to use one color per relation or not
* @param integer $ The id of the link to draw * @param integer i The id of the link to draw
* @global object The current PDF document * @global object The current PDF document
* @access private * @access private
* @see PMA_PDF * @see PMA_PDF
@@ -769,10 +768,10 @@ class PMA_RT_Relation {
/** /**
* The "PMA_RT_Relation" constructor * The "PMA_RT_Relation" constructor
* *
* @param string $ The master table name * @param string master_table The master table name
* @param string $ The relation field in the master table * @param string master_field The relation field in the master table
* @param string $ The foreign table name * @param string foreign_table The foreign table name
* @param string $ The relation field in the foreign table * @param string foreigh_field The relation field in the foreign table
* @access private * @access private
* @see PMA_RT_Relation::PMA_RT_Relation_getXy * @see PMA_RT_Relation::PMA_RT_Relation_getXy
*/ */
@@ -845,7 +844,7 @@ class PMA_RT {
/** /**
* Sets X and Y minimum and maximum for a table cell * Sets X and Y minimum and maximum for a table cell
* *
* @param string $ The table name * @param string table The table name
* @access private * @access private
*/ */
function PMA_RT_setMinMax($table) function PMA_RT_setMinMax($table)
@@ -858,11 +857,11 @@ class PMA_RT {
/** /**
* Defines relation objects * Defines relation objects
* *
* @param string $ The master table name * @param string master_table The master table name
* @param string $ The relation field in the master table * @param string master_field The relation field in the master table
* @param string $ The foreign table name * @param string foreign_table The foreign table name
* @param string $ The relation field in the foreign table * @param string foreign_field The relation field in the foreign table
* @param boolean $ Whether to display table position or not * @param boolean show_info Whether to display table position or not
* @access private * @access private
* @see PMA_RT_setMinMax * @see PMA_RT_setMinMax
*/ */
@@ -912,7 +911,7 @@ class PMA_RT {
/** /**
* Draws relation arrows * Draws relation arrows
* *
* @param boolean $ Whether to use one color per relation or not * @param boolean change_color Whether to use one color per relation or not
* @access private * @access private
* @see PMA_RT_Relation::PMA_RT_Relation_draw() * @see PMA_RT_Relation::PMA_RT_Relation_draw()
*/ */
@@ -927,7 +926,7 @@ class PMA_RT {
/** /**
* Draws tables * Draws tables
* *
* @param boolean $ Whether to display table position or not * @param boolean draw_color Whether to display table position or not
* @access private * @access private
* @see PMA_RT_Table::PMA_RT_Table_draw() * @see PMA_RT_Table::PMA_RT_Table_draw()
*/ */
@@ -972,16 +971,15 @@ class PMA_RT {
/** /**
* The "PMA_RT" constructor * The "PMA_RT" constructor
* *
* @param mixed $ The scaling factor * @param integer which_rel The page number to draw (from the
* @param integer $ The page number to draw (from the
* $cfg['Servers'][$i]['table_coords'] table) * $cfg['Servers'][$i]['table_coords'] table)
* @param boolean $ Whether to display table position or not * @param boolean show_info Whether to display table position or not
* @param boolean $ Was originally whether to use one color per * @param boolean change_color Was originally whether to use one color per
* relation or not, now enables/disables color * relation or not, now enables/disables color
* everywhere, due to some problems printing with color * everywhere, due to some problems printing with color
* @param boolean $ Whether to draw grids or not * @param boolean show_grid Whether to draw grids or not
* @param boolean $ Whether all tables should have the same width or not * @param boolean all_tab_same_wide Whether all tables should have the same width or not
* @param boolean $ Wheter to show all field or only the keys * @param boolean show_keys Wheter to show all field or only the keys
* @global object The current PDF document * @global object The current PDF document
* @global string The current db name * @global string The current db name
* @global array The relations settings * @global array The relations settings