--- parser3/src/include/pa_array.h	2001/03/11 08:16:32	1.22
+++ parser3/src/include/pa_array.h	2001/03/19 17:42:12	1.26
@@ -1,12 +1,26 @@
-/*
-	Parser
+/** @file
+	Parser: array class decl.
+
 	Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
+
 	Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
 
-	$Id: pa_array.h,v 1.22 2001/03/11 08:16:32 paf Exp $
+	$Id: pa_array.h,v 1.26 2001/03/19 17:42:12 paf Exp $
 */
 
-/*
+#ifndef PA_ARRAY_H
+#define PA_ARRAY_H
+
+#include <stddef.h>
+
+#include "pa_pool.h"
+#include "pa_types.h"
+#include "pa_string.h"
+
+/**	
+	Pooled Array.
+
+	Internal structure: @verbatim	
 
 	Array               Chunk0
 	======              ========
@@ -17,47 +31,48 @@
 			.			[ptr]
 			...........>[link to the next chunk]
 
+	@endverbatim
 */
 
-#ifndef PA_ARRAY_H
-#define PA_ARRAY_H
-
-#include <stddef.h>
-
-#include "pa_pool.h"
-#include "pa_types.h"
-#include "pa_string.h"
-
 class Array : public Pooled {
 public:
 
-	typedef void Item;
+	typedef void Item; ///< Array item type
 
 	enum {
-		CR_INITIAL_ROWS_DEFAULT=10,
-		CR_GROW_PERCENT=60
+		CR_INITIAL_ROWS_DEFAULT=10, ///< default preallocated row count
+		CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded()
 	};
 
 public:
 
 	Array(Pool& apool, int initial_rows=CR_INITIAL_ROWS_DEFAULT);
 
+	/// size Array. how many items are in it
 	int size() const { 
 		// for get and quick_get
 		cache_chunk_base=0;
 		cache_chunk=head;
 		return fused_rows; 
 	}
+	/// append Item to array
 	Array& operator += (Item *src);
-	// Array<const Item*> replacement
+
+	/// dirty hack to allow constant items storage. I long for Array<const Item*>
 	Array& operator += (const Item *src) { return *this+=const_cast<Item*>(src); }
+
+	/// append other Array portion to this one. starting from offset
 	Array& append_array(const Array& src, int offset=0);
-	Item *quick_get(int index) const {
-		// considering these true:
-		//   index increments from 0 to size()-1
-		//   index>=0 && index<size()
-		//   index>=cache_chunk_base
 
+	/** 
+		quickly gets some item considering...
+
+		these true:
+			- index increments from 0 to size()-1
+			- index>=0 && index<size()
+			- index>=cache_chunk_base
+	*/
+	Item *quick_get(int index) const {
 		// next chunk will be with "index" row
 		if(!(index<cache_chunk_base+cache_chunk->count)) {
 			int count=cache_chunk->count;
@@ -70,9 +85,7 @@ public:
 
 	Item *get(int index) const;
 	void put(int index, Item *item);
-	const char *get_cstr(int index) const { 
-		return static_cast<const char *>(get(index)); 
-	}
+	/// convinient way to get strings from Array. I long for Array<const String *>
 	const String *get_string(int index) const { 
 		return static_cast<const String *>(get(index)); 
 	}