--- a/src/index/indexer.h
+++ b/src/index/indexer.h
@@ -1,21 +1,31 @@
#ifndef _INDEXER_H_INCLUDED_
#define _INDEXER_H_INCLUDED_
-/* @(#$Id: indexer.h,v 1.5 2005-03-17 15:35:49 dockes Exp $ (C) 2004 J.F.Dockes */
+/* @(#$Id: indexer.h,v 1.6 2005-11-10 08:47:49 dockes Exp $ (C) 2004 J.F.Dockes */
#include "rclconfig.h"
+
+/**
+ * An internal class to process all directories indexed into the same database.
+ */
class DbIndexer;
/**
* The file system indexing object. Processes the configuration, then invokes
* file system walking to populate/update the database(s).
+ *
+ * Multiple top-level directories can be listed in the
+ * configuration. Each can be indexed to a different
+ * database. Directories are first grouped by database, then an
+ * internal class (DbIndexer) is used to process each group.
*/
class ConfIndexer {
RclConfig *config;
- DbIndexer *indexer; // Internal object used to store opaque private data
+ DbIndexer *dbindexer; // Object to process directories for a given db
public:
enum runStatus {IndexerOk, IndexerError};
- ConfIndexer(RclConfig *cnf) : config(cnf), indexer(0) {}
+ ConfIndexer(RclConfig *cnf) : config(cnf), dbindexer(0) {}
virtual ~ConfIndexer();
+ /** Worker function: doe the actual indexing */
bool index();
};