--- a/src/qtgui/plaintorich.h
+++ b/src/qtgui/plaintorich.h
@@ -1,20 +1,21 @@
#ifndef _PLAINTORICH_H_INCLUDED_
#define _PLAINTORICH_H_INCLUDED_
-/* @(#$Id: plaintorich.h,v 1.2 2005-10-10 13:24:53 dockes Exp $ (C) 2004 J.F.Dockes */
+/* @(#$Id: plaintorich.h,v 1.3 2006-01-19 12:01:43 dockes Exp $ (C) 2004 J.F.Dockes */
#include <string>
/**
- * Fix result text for display inside the gui text window.
+ * Transform plain text into qt rich text for the preview window.
+ *
+ * We mainly escape characters like < or &, and add qt rich text tags to
+ * colorize the query terms.
*
* @param in raw text out of internfile.
* @param terms list of query terms
- * @param termoffsets character offsets where we find terms
+ * @param termoffsets output: character offsets where we find terms.
*/
extern string plaintorich(const string &in,
const list<string>& terms,
list<pair<int, int> >&termoffsets);
-extern string stripMarkup(const string &in);
-
#endif /* _PLAINTORICH_H_INCLUDED_ */