From 5314b9a14cc42b4cab0aead75518e94748e6cadd Mon Sep 17 00:00:00 2001
From: Steven Wittens <steven@10.no-reply.drupal.org>
Date: Thu, 13 Jan 2005 17:34:01 +0000
Subject: [PATCH] - Some search doxygen tweaks
---
modules/search.module | 10 +++++-----
modules/search/search.module | 10 +++++-----
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/modules/search.module b/modules/search.module
index bdc882838cd8..691c76486682 100644
--- a/modules/search.module
+++ b/modules/search.module
@@ -285,7 +285,7 @@ function search_preprocess(&$text) {
/**
- * Update the search index for a particular item.
+ * Update the full-text search index for a particular item.
*
* @param $sid
* A number identifying this particular item (e.g. node id).
@@ -407,10 +407,10 @@ function search_index($sid, $type, $text) {
}
/**
- * Perform a search on a word or words.
+ * Do a query on the full-text search index for a word or words.
*
- * This function is called by each module that supports the indexed search
- * (and thus, implements hook_update_index()).
+ * This function is normally only called by each module that support the
+ * indexed search (and thus, implements hook_update_index()).
*
* The final query is an SQL select on the search_index table. As a guide for
* writing the optional extra SQL fragments (see below), use this query:
@@ -602,7 +602,7 @@ function search_form($action = '', $keys = '', $type = null) {
}
/**
- * Perform a search on the given keys, and return the formatted results.
+ * Perform a standard search on the given keys, and return the formatted results.
*/
function search_data($keys = NULL, $type = 'node') {
$output = '';
diff --git a/modules/search/search.module b/modules/search/search.module
index bdc882838cd8..691c76486682 100644
--- a/modules/search/search.module
+++ b/modules/search/search.module
@@ -285,7 +285,7 @@ function search_preprocess(&$text) {
/**
- * Update the search index for a particular item.
+ * Update the full-text search index for a particular item.
*
* @param $sid
* A number identifying this particular item (e.g. node id).
@@ -407,10 +407,10 @@ function search_index($sid, $type, $text) {
}
/**
- * Perform a search on a word or words.
+ * Do a query on the full-text search index for a word or words.
*
- * This function is called by each module that supports the indexed search
- * (and thus, implements hook_update_index()).
+ * This function is normally only called by each module that support the
+ * indexed search (and thus, implements hook_update_index()).
*
* The final query is an SQL select on the search_index table. As a guide for
* writing the optional extra SQL fragments (see below), use this query:
@@ -602,7 +602,7 @@ function search_form($action = '', $keys = '', $type = null) {
}
/**
- * Perform a search on the given keys, and return the formatted results.
+ * Perform a standard search on the given keys, and return the formatted results.
*/
function search_data($keys = NULL, $type = 'node') {
$output = '';
--
GitLab