Author: ssmiweve
Date: 2007-08-21 10:59:47 +0200 (Tue, 21 Aug 2007)
New Revision: 5642
Modified:
trunk/search-command-control-spi/src/main/java/no/sesat/search/mode/SearchCommandFactory.java
trunk/search-command-control-spi/src/main/java/no/sesat/search/mode/package.html
Log:
javadoc
Modified:
trunk/search-command-control-spi/src/main/java/no/sesat/search/mode/SearchCommandFactory.java
===================================================================
---
trunk/search-command-control-spi/src/main/java/no/sesat/search/mode/SearchCommandFactory.java
2007-08-21 07:38:03 UTC (rev 5641)
+++
trunk/search-command-control-spi/src/main/java/no/sesat/search/mode/SearchCommandFactory.java
2007-08-21 08:59:47 UTC (rev 5642)
@@ -3,8 +3,7 @@
* You can use, redistribute, and/or modify it, under the terms of the SESAT
License.
* You should have received a copy of the SESAT License along with this
program.
* If not, see https://dev.sesat.no/confluence/display/SESAT/SESAT+License
- */
-/*
+ *
* SearchCommandFactory.java
*
* Created on January 5, 2006, 10:17 AM
@@ -38,19 +37,19 @@
private final Context context;
- /**
+ /** Create a factory to work within the given context.
*
- * @param context
+ * @param context to work within
*/
public SearchCommandFactory(final Context context) {
this.context = context;
}
- /** Create the appropriate command given the configuration inside the
context.
+ /** Create the appropriate command that's to work within the given
SearchCommand.Context.
*
- * @param cxt
- * @return
+ * @param cxt to work within
+ * @return SearchCommand appropriate for the given context
*/
public SearchCommand getController(final SearchCommand.Context cxt){
Modified:
trunk/search-command-control-spi/src/main/java/no/sesat/search/mode/package.html
===================================================================
---
trunk/search-command-control-spi/src/main/java/no/sesat/search/mode/package.html
2007-08-21 07:38:03 UTC (rev 5641)
+++
trunk/search-command-control-spi/src/main/java/no/sesat/search/mode/package.html
2007-08-21 08:59:47 UTC (rev 5642)
@@ -1,21 +1,18 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
-Copyright (2005-2006) Schibsted Søk AS
+Copyright (2005-2007) Schibsted Søk AS
-->
<html>
<head>
</head>
<body bgcolor="white">
-##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. #####
-##### TYPE YOUR PACKAGE COMMENTS HERE. BEGIN WITH A #####
-##### ONE-SENTENCE SUMMARY STARTING WITH A VERB LIKE: #####
-Provides for textual analysis of queries.
+Provides the entry to appropriate Search Commands classes through the
SearchCommandFactory.
-<h2>Package Specification</h2>
-
-##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
-<!-- Put @see and @since tags down here. -->
-
+<h2>SESAT Modes</h2>
+A mode is considered the business logic behind any vertical or tab.
+It consists of a collection of SearchCommands to run,
+ and an executor to run this collection of individual commands.
+
</body>
</html>
_______________________________________________
Kernel-commits mailing list
[email protected]
http://sesat.no/mailman/listinfo/kernel-commits
