Fixes subpackage information on iterator file documentation, a=cpollett

Chris Pollett [2010-09-03 23:Sep:rd]
Fixes subpackage information on iterator file documentation, a=cpollett
Filename
lib/index_bundle_iterators/group_iterator.php
lib/index_bundle_iterators/index_bundle_iterator.php
lib/index_bundle_iterators/intersect_iterator.php
lib/index_bundle_iterators/phrase_filter_iterator.php
lib/index_bundle_iterators/union_iterator.php
lib/index_bundle_iterators/word_iterator.php
diff --git a/lib/index_bundle_iterators/group_iterator.php b/lib/index_bundle_iterators/group_iterator.php
index c92ae4098..700beaca3 100644
--- a/lib/index_bundle_iterators/group_iterator.php
+++ b/lib/index_bundle_iterators/group_iterator.php
@@ -24,7 +24,7 @@
  *
  * @author Chris Pollett chris@pollett.org
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @license http://www.gnu.org/licenses/ GPL3
  * @link http://www.seekquarry.com/
  * @copyright 2009, 2010
@@ -54,7 +54,7 @@ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php';
  *
  * @author Chris Pollett
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @see IndexArchiveBundle
  */
 class GroupIterator extends IndexBundleIterator
diff --git a/lib/index_bundle_iterators/index_bundle_iterator.php b/lib/index_bundle_iterators/index_bundle_iterator.php
index 6759e80fa..cd33b23c5 100644
--- a/lib/index_bundle_iterators/index_bundle_iterator.php
+++ b/lib/index_bundle_iterators/index_bundle_iterator.php
@@ -24,7 +24,7 @@
  *
  * @author Chris Pollett chris@pollett.org
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @license http://www.gnu.org/licenses/ GPL3
  * @link http://www.seekquarry.com/
  * @copyright 2009, 2010
@@ -45,7 +45,7 @@ require_once BASE_DIR.'/lib/indexing_constants.php';
  *
  * @author Chris Pollett
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @see IndexArchiveBundle
  */
 abstract class IndexBundleIterator implements IndexingConstants, CrawlConstants
diff --git a/lib/index_bundle_iterators/intersect_iterator.php b/lib/index_bundle_iterators/intersect_iterator.php
index 8a4d6d5b5..a53ece59c 100644
--- a/lib/index_bundle_iterators/intersect_iterator.php
+++ b/lib/index_bundle_iterators/intersect_iterator.php
@@ -24,7 +24,7 @@
  *
  * @author Chris Pollett chris@pollett.org
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @license http://www.gnu.org/licenses/ GPL3
  * @link http://www.seekquarry.com/
  * @copyright 2009, 2010
@@ -55,7 +55,7 @@ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php';
  *
  * @author Chris Pollett
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @see IndexArchiveBundle
  */
 class IntersectIterator extends IndexBundleIterator
diff --git a/lib/index_bundle_iterators/phrase_filter_iterator.php b/lib/index_bundle_iterators/phrase_filter_iterator.php
index 943a84188..36b98dddf 100644
--- a/lib/index_bundle_iterators/phrase_filter_iterator.php
+++ b/lib/index_bundle_iterators/phrase_filter_iterator.php
@@ -24,7 +24,7 @@
  *
  * @author Chris Pollett chris@pollett.org
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @license http://www.gnu.org/licenses/ GPL3
  * @link http://www.seekquarry.com/
  * @copyright 2009, 2010
@@ -56,7 +56,7 @@ require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php';
  *
  * @author Chris Pollett
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @see IndexArchiveBundle
  */
 class PhraseFilterIterator extends IndexBundleIterator
diff --git a/lib/index_bundle_iterators/union_iterator.php b/lib/index_bundle_iterators/union_iterator.php
index 4c8ae8101..bfbb3b5ac 100644
--- a/lib/index_bundle_iterators/union_iterator.php
+++ b/lib/index_bundle_iterators/union_iterator.php
@@ -24,7 +24,7 @@
  *
  * @author Chris Pollett chris@pollett.org
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @license http://www.gnu.org/licenses/ GPL3
  * @link http://www.seekquarry.com/
  * @copyright 2009, 2010
@@ -50,10 +50,12 @@ require_once BASE_DIR.'/lib/bloom_filter_file.php';
 require_once BASE_DIR.'/lib/index_bundle_iterators/index_bundle_iterator.php';

 /**
+ * Used to iterate over the documents which occur in any of a set of
+ * WordIterator results
  *
  * @author Chris Pollett
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @see IndexArchiveBundle
  */
 class UnionIterator extends IndexBundleIterator
diff --git a/lib/index_bundle_iterators/word_iterator.php b/lib/index_bundle_iterators/word_iterator.php
index 7512d2a4a..36a028246 100644
--- a/lib/index_bundle_iterators/word_iterator.php
+++ b/lib/index_bundle_iterators/word_iterator.php
@@ -24,7 +24,7 @@
  *
  * @author Chris Pollett chris@pollett.org
  * @package seek_quarry
- * @subpackage library
+ * @subpackage iterator
  * @license http://www.gnu.org/licenses/ GPL3
  * @link http://www.seekquarry.com/
  * @copyright 2009, 2010
ViewGit