Minor tweaks to the documentation of various files, a=chris

Chris Pollett [2013-01-04 20:Jan:th]
Minor tweaks to the documentation of various files, a=chris
Filename
INSTALL
LICENSE
README
bin/code_tool.php
lib/archive_bundle_iterators/mix_archive_bundle_iterator.php
lib/phrase_parser.php
models/cron_model.php
privacy.php
views/helpers/toggle_helper.php
diff --git a/INSTALL b/INSTALL
index 240d91587..371b72784 100755
--- a/INSTALL
+++ b/INSTALL
@@ -1,7 +1,7 @@
 SeekQuarry/Yioop --
 Open Source Pure PHP Search Engine, Crawler, and Indexer

-Copyright (C) 2009 - 2012  Chris Pollett chris@pollett.org
+Copyright (C) 2009 - 2013  Chris Pollett chris@pollett.org

 http://www.seekquarry.com/

@@ -14,7 +14,7 @@ the Free Software Foundation, either version 3 of the License, or

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
@@ -35,13 +35,13 @@ point your web browser to the location of Yioop. A
 configuration page should appear and let you set the
 path to the auxiliary folder. For this
 step you must connect via localhost or you must have a
-configs/local_config.php file with NO_LOCAL_CHECK defined to true.
+configs/local_config.php file with NO_LOCAL_CHECK defined to true.
 Make sure the web server has permissions on the place where this auxiliary
 folder needs to be created. Once you have set the folder,
 you should see a second form beneath the select-a-path
 form. This form allows you to configure the debug settings,
 database settings, queue server and robot settings.
-After filling in this form and submitting it,
+After filling in this form and submitting it,
 the installation is complete.

 (2) To start the queue server you type:
diff --git a/LICENSE b/LICENSE
index 3c3621482..c3cd2370a 100755
--- a/LICENSE
+++ b/LICENSE
@@ -1,7 +1,7 @@
 SeekQuarry/Yioop --
 Open Source Pure PHP Search Engine, Crawler, and Indexer

-Copyright (C) 2009 - 2012  Chris Pollett chris@pollett.org
+Copyright (C) 2009 - 2013  Chris Pollett chris@pollett.org

 SeekQuarry is distributed under the terms of GNU LIBRARY GENERAL PUBLIC
 LICENSE reproduced below.
diff --git a/README b/README
index 684c89f55..4c0073eaf 100755
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 SeekQuarry/Yioop --
 Open Source Pure PHP Search Engine, Crawler, and Indexer

-Copyright (C) 2009 - 2012  Chris Pollett chris@pollett.org
+Copyright (C) 2009 - 2013  Chris Pollett chris@pollett.org

 http://www.seekquarry.com/

@@ -27,7 +27,7 @@ The Yioop search engine consists of three main
 scripts:

 bin/fetcher.php - used to download batches of urls provided
-    the queue_server.
+    the queue_server.
 bin/queue_server.php - maintains a queue of urls that are
     going to be scheduled to be seen. It also keeps
     track of what has been seen and robots.txt info.
@@ -35,7 +35,7 @@ bin/queue_server.php - maintains a queue of urls that are
     that is used by the search front end.

 index.php -- a search engine web page. It is also used
-    to handle message passing between the fetchers
+    to handle message passing between the fetchers
     (multiple machines can act as fetchers) and the
     queue_server.

@@ -47,18 +47,19 @@ http://www.seekquarry.com/
 Requirements
 ------------
 The Yioop search engine requires Apache and
-PHP. It was developed under Apache 2.2, PHP 5.3,
+PHP. It was developed under Apache 2.2, PHP 5.3,
 and the sqlite3 built into PHP.

 Credits
 ------
-The source code is mainly due to Chris Pollett.
+The source code is mainly due to Chris Pollett.
 Other contributors include: Ravi Dhillon, Priya Gangaraju,
-Nakul Natu, Vijaya Pamidi, Vijeth Patil, Tarun
-Pepira, Shawn Tice, Sandhya Vissapragada. Several people helped with
-localization: My wife, Mary Pollett, Jonathan Ben-David,
+Akshat Kukreti, Nakul Natu, Vijaya Pamidi, Vijeth Patil, Tarun
+Pepira, Tamayee Potluri, Shawn Tice, Sandhya Vissapragada.
+Several people helped with localization: My wife, Mary Pollett,
+Jonathan Ben-David, Ismail.B, Andrea Brunetti, Thanh Bui,
 Sujata Dongre, Animesh Dutta, Youn Kim, Akshat Kukreti,
-Chao-Hsin Shih and Sugi Widjaja.
+Chao-Hsin Shih, Ahmed Kamel Taha, and Sugi Widjaja.

 Installation
 -------------
diff --git a/bin/code_tool.php b/bin/code_tool.php
index 3578bbff6..18e83f4ad 100755
--- a/bin/code_tool.php
+++ b/bin/code_tool.php
@@ -37,7 +37,7 @@

 if(php_sapi_name() != 'cli') {echo "BAD REQUEST"; exit();}

-/** Calculate base directory of script @ignore*/
+/** Calculate base directory of script @ignore */
 define("BASE_DIR", substr(
     dirname(realpath($_SERVER['PHP_SELF'])), 0,
     -strlen("/bin")));
@@ -84,7 +84,7 @@ code_tool.php has the following command formats:

 php code_tool.php clean path
     Replaces all tabs with four spaces and trims all whitespace off ends of
-    lines in the folder or file path
+    lines in the folder or file path.

 php code_tool.php copyright path
     Adjusts all lines in the files in the folder at path (or if
diff --git a/lib/archive_bundle_iterators/mix_archive_bundle_iterator.php b/lib/archive_bundle_iterators/mix_archive_bundle_iterator.php
index 454238a55..991c11d4f 100644
--- a/lib/archive_bundle_iterators/mix_archive_bundle_iterator.php
+++ b/lib/archive_bundle_iterators/mix_archive_bundle_iterator.php
@@ -93,7 +93,6 @@ class MixArchiveBundleIterator extends ArchiveBundleIterator
      *      iterate over the pages of
      * @param string $result_timestamp timestamp of the web archive bundle
      *      results are being stored in
-     * @param
      */
     function __construct($mix_timestamp, $result_timestamp)
     {
@@ -226,4 +225,4 @@ class MixArchiveBundleIterator extends ArchiveBundleIterator
         $this->saveCheckpoint();
     }
 }
-?>
\ No newline at end of file
+?>
diff --git a/lib/phrase_parser.php b/lib/phrase_parser.php
index d4bdf0525..077b4611a 100755
--- a/lib/phrase_parser.php
+++ b/lib/phrase_parser.php
@@ -33,6 +33,9 @@

 if(!defined('BASE_DIR')) {echo "BAD REQUEST"; exit();}

+/**
+ * Load in locale specific tokenizing code
+ */
 foreach(glob(LOCALE_DIR."/*/resources/tokenizer.php")
     as $filename) {
     require_once $filename;
@@ -473,4 +476,4 @@ vaffanculo fok hoer kut lul やりまん 打っ掛け
         $score = $num_unsafe_terms * $unsafe_count/($len + 1);
         return $score;
     }
-}
\ No newline at end of file
+}
diff --git a/models/cron_model.php b/models/cron_model.php
index 311ad3af0..f188f187a 100644
--- a/models/cron_model.php
+++ b/models/cron_model.php
@@ -51,7 +51,7 @@ class CronModel extends Model
 {
     /**
      * File name used to store the cron table associative array
-     * @string
+     * @var string
      */
     var $cron_file;
     /**
@@ -115,4 +115,4 @@ class CronModel extends Model

 }

- ?>
\ No newline at end of file
+ ?>
diff --git a/privacy.php b/privacy.php
index 4a5b291f7..76bff11bc 100755
--- a/privacy.php
+++ b/privacy.php
@@ -33,7 +33,12 @@
  * @copyright 2009 - 2013
  * @filesource
  */
+
+/* set-up static privacy page for display */
 $_REQUEST['c'] = "static";
 $_REQUEST['p'] = "privacy";
+/**
+ * load in main entry point
+ */
 include("index.php");
-?>
\ No newline at end of file
+?>
diff --git a/views/helpers/toggle_helper.php b/views/helpers/toggle_helper.php
index 265366b26..b1f6a4dbc 100644
--- a/views/helpers/toggle_helper.php
+++ b/views/helpers/toggle_helper.php
@@ -54,7 +54,7 @@ class ToggleHelper extends Helper
      *  Draws an On Off switch in HTML where to toggle state one
      *  clicks a link
      *
-     *  @parm bool $state whether the switch is on or off
+     *  @param bool $state whether the switch is on or off
      *  @param string $on_url - url that is sent when one clicks on
      *  @param string $off_url - url that is sent when one clicks off
      */
@@ -86,4 +86,4 @@ class ToggleHelper extends Helper
     }

 }
-?>
\ No newline at end of file
+?>
ViewGit