From 8880f996bf51f2973b9b84f6bd03207a3cbf270b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= <mcihar@suse.cz>
Date: Fri, 5 Aug 2011 10:15:35 +0200
Subject: [PATCH] Add some docblocks

---
 libraries/blobstreaming.lib.php | 42 +++++++++++++++++++++++----------
 1 file changed, 30 insertions(+), 12 deletions(-)

diff --git a/libraries/blobstreaming.lib.php b/libraries/blobstreaming.lib.php
index 301403c16e..1eeaae2f5e 100644
--- a/libraries/blobstreaming.lib.php
+++ b/libraries/blobstreaming.lib.php
@@ -228,15 +228,25 @@ function PMA_BS_GetVariables()
     return $BS_Variables;
 }
 
-//========================
-//========================
+/**
+ * Retrieves and shows PBMS error.
+ *
+ * @return nothing
+ */
 function PMA_BS_ReportPBMSError($msg)
 {
     $tmp_err = pbms_error();
     PMA_showMessage(__('PBMS error') . " $msg $tmp_err");
 }
 
-//------------
+/**
+ * Tries to connect to PBMS server.
+ *
+ * @param string $db_name Database name
+ * @param bool   $quiet   Whether to report errors
+ *
+ * @return bool Connection status.
+ */
 function PMA_do_connect($db_name, $quiet)
 {
     $PMA_Config = $GLOBALS['PMA_Config'];
@@ -266,17 +276,24 @@ function PMA_do_connect($db_name, $quiet)
     return true;
 }
 
-//------------
+/**
+ * Disconnects from PBMS server.
+ *
+ * @return nothing
+ */
 function PMA_do_disconnect()
 {
     pbms_close();
 }
 
-//------------
 /**
- * checks whether the BLOB reference looks valid
+ * Checks whether the BLOB reference looks valid
  *
-*/
+ * @param string $bs_reference BLOB reference
+ * @param string $db_name Database name
+ *
+ * @return bool True on success.
+ */
 function PMA_BS_IsPBMSReference($bs_reference, $db_name)
 {
     if (PMA_cacheGet('skip_blobstreaming', true)) {
@@ -357,11 +374,12 @@ function PMA_BS_CreateReferenceLink($bs_reference, $db_name)
     return $output;
 }
 
-//------------
-// In the future there may be server variables to turn on/off PBMS
-// BLOB streaming on a per table or database basis. So in anticipation of this
-// PMA_BS_IsTablePBMSEnabled() passes in the table and database name even though
-// they are not currently needed.
+/**
+ * In the future there may be server variables to turn on/off PBMS
+ * BLOB streaming on a per table or database basis. So in anticipation of this
+ * PMA_BS_IsTablePBMSEnabled() passes in the table and database name even though
+ * they are not currently needed.
+ */
 function PMA_BS_IsTablePBMSEnabled($db_name, $tbl_name, $tbl_type)
 {
     if (PMA_cacheGet('skip_blobstreaming', true)) {