--- parser3/src/include/pa_string.h	2001/03/19 20:46:36	1.45
+++ parser3/src/include/pa_string.h	2001/03/23 13:08:09	1.49
@@ -5,15 +5,13 @@
 
 	Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
 
-	$Id: pa_string.h,v 1.45 2001/03/19 20:46:36 paf Exp $
+	$Id: pa_string.h,v 1.49 2001/03/23 13:08:09 paf Exp $
 */
 
 #ifndef PA_STRING_H
 #define PA_STRING_H
 
-#ifdef HAVE_CONFIG_H
-#	include "pa_config.h"
-#endif
+#include "pa_config_includes.h"
 
 #include <stddef.h>
 
@@ -27,37 +25,36 @@
 		const char *src, size_t size,  \
 		bool tainted, \
 		const char *file, uint line
-/// appends clean piece to String
+/// appends clean piece to String  @see String::real_append
 #	define APPEND(src, size, file, line) real_append(src, size, false, file, line)
-/// appends tainted piece to String
+/// appends tainted piece to String  @see String::real_append
 #	define APPEND_TAINTED(src, size, file, line) real_append(src, size, true, file, line)
 #else
 #	define STRING_APPEND_PARAMS \
 		const char *src, \
 		size_t size, \
 		bool tainted
-/// appends clean piece to String
+/// appends clean piece to String  @see String::real_append
 #	define APPEND(src, size, file, line) real_append(src, size, false)
-/// appends tainted piece to String
+/// appends tainted piece to String  @see String::real_append
 #	define APPEND_TAINTED(src, size, file, line) real_append(src, size, true)
 #endif
-/// handy: appends const char* piece to String
+/// handy: appends const char* piece to String  @see String::real_append
 #define	APPEND_CONST(src) APPEND(src, 0, 0, 0)
 
 /** 
 	Pooled string.
 
-	Internal structure: @verbatim	
-
-	String				Chunk0
-	======				========
-	head--------------->[ptr, size, ...]
-	append_here-------->[ptr, size, ...]
-						.
-						.
-						[ptr, size, ...]
-	link_row----------->[link to the next chunk]
-
+	Internal structure:
+	@verbatim
+		String				Chunk0
+		======				========
+		head--------------->[ptr, size, ...]
+		append_here-------->[ptr, size, ...]
+							.
+							.
+							[ptr, size, ...]
+		link_row----------->[link to the next chunk]
 	@endverbatim
 
 	All pieces remember 
@@ -67,6 +64,7 @@
 */
 class String : public Pooled {
 public:
+
 	enum {
 		CR_PREALLOCATED_COUNT=5, ///< default preallocated item count
 		CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded()
@@ -74,24 +72,24 @@ public:
 
 	/// piece is tainted or not. the language to use when detaint 
 	enum Untaint_lang {
-		UNKNOWN=0, ///< when get by name fails
-		NO, ///< clean
-		YES,  ///< tainted, untaint language as assigned later 
+		UL_UNKNOWN=0, ///< when get by name fails
+		UL_NO, ///< clean
+		UL_YES,  ///< tainted, untaint language as assigned later 
 		// untaint languages. assigned by ^untaint[lang]{...}
-		PASS_APPENDED,
+		UL_PASS_APPENDED,
 			/**<
 				leave language built into string being appended.
 				just a flag, that value not stored
 			*/
-		AS_IS,  ///< leave all characters intact
-		FILE,   ///< filename
-		HEADER, ///< text in response header
-		URI,    ///< text in uri
-		TABLE,  ///< ^table:set body
-		SQL,    ///< ^table:sql body
-		JS,     ///< JavaScript code
-		HTML,   ///< HTML code (for editing)
-		HTML_TYPO ///< HTML code with TYPOgraphic replacements (for showing)
+		UL_AS_IS,     ///< leave all characters intact
+		UL_FILE_NAME, ///< filename
+		UL_HEADER,    ///< text in response header
+		UL_URI,       ///< text in uri
+		UL_TABLE,     ///< ^table:set body
+		UL_SQL,       ///< ^table:sql body
+		UL_JS,        ///< JavaScript code
+		UL_HTML,      ///< HTML code (for editing)
+		UL_HTML_TYPO  ///< HTML code with TYPOgraphic replacements (for showing)
 	};
 
 public:
@@ -101,6 +99,9 @@ public:
 	size_t size() const { return fsize; }
 	/// convert to C string
 	char *cstr() const;
+	/** append fragment
+		@see APPEND, APPEND_TAINTED, APPEND_CONST
+	*/
 	String& real_append(STRING_APPEND_PARAMS);
 	/// @return <0 ==0 or >0 depending on comparison result
 	int cmp (const String& src) const;
@@ -119,8 +120,8 @@ public:
 	/** 
 		appends other String.
 
-		marking all tainted pieces of it with \a lang.
-		or marking ALL pieces of it with a \a lang when \a forced to.
+		marking all tainted pieces of it with @a lang.
+		or marking ALL pieces of it with a @a lang when @a forced to.
 	*/
 	String& append(const String& src, Untaint_lang lang, bool forced=false);