diff --git a/harbour/ChangeLog b/harbour/ChangeLog
index 99628debf6..d36a8ff7bf 100644
--- a/harbour/ChangeLog
+++ b/harbour/ChangeLog
@@ -16,6 +16,48 @@
The license applies to all entries newer than 2009-04-28.
*/
+2011-02-14 01:45 UTC-0800 Pritpal Bedi (bedipritpal@hotmail.com)
+ * doc/en/1stread.txt
+ * doc/en/array.txt
+ * doc/en/browse.txt
+ * doc/en/cmdline.txt
+ * doc/en/compiler.txt
+ * doc/en/datetime.txt
+ * doc/en/dbstrux.txt
+ * doc/en/file.txt
+ * doc/en/garbage.txt
+ * doc/en/gnulice.txt
+ * doc/en/harbext.txt
+ * doc/en/hashes.txt
+ * doc/en/hb_api.txt
+ * doc/en/hb_apier.txt
+ * doc/en/hb_apifs.txt
+ * doc/en/hb_apigt.txt
+ * doc/en/hb_apiit.txt
+ * doc/en/hb_apiln.txt
+ * doc/en/hb_compa.txt
+ * doc/en/hvm.txt
+ * doc/en/idle.txt
+ * doc/en/input.txt
+ * doc/en/license.txt
+ * doc/en/macro.txt
+ * doc/en/menu.txt
+ * doc/en/misc.txt
+ * doc/en/rdddb.txt
+ * doc/en/rddord.txt
+ * doc/en/readme.txt
+ * doc/en/set.txt
+ * doc/en/strotype.txt
+ * doc/en/terminal.txt
+ * doc/en/var.txt
+ ! Formatted: to start contents at column 9 which was the
+ existing layout for majority of files in doc/en.
+ Some contribs are using column 8 as the base.
+ hbQT can be fixed at the generator level. hbCT needs
+ rework to base at column 9. To shift to column 9 is
+ simple than shift to column 8.
+ QUESTION: which way should we go?
+
2011-02-14 10:20 UTC+0100 Viktor Szakats (harbour.01 syenar.hu)
* src/rtl/hbdoc.prg
+ Added logic to detect in which column the actual
diff --git a/harbour/doc/en/1stread.txt b/harbour/doc/en/1stread.txt
index d88fb12245..9c87edc074 100644
--- a/harbour/doc/en/1stread.txt
+++ b/harbour/doc/en/1stread.txt
@@ -52,46 +52,46 @@
/* $DOC$
* $TEMPLATE$
- * Document
+ * Document
* $NAME$
- * 1st document to read
+ * 1st document to read
* $CATEGORY$
- * Document
+ * Document
* $SUBCATEGORY$
*
* $ONELINER$
- * A starters guide to Harbour
+ * A starters guide to Harbour
* $DESCRIPTION$
- * Welcome to Harbour
- * ==================
+ * Welcome to Harbour
+ * ==================
*
- * Clipper is a trademark of Computer Associates and will often be
- * referred to as CA-Cl*pper within Harbour documents. Regardless of this
- * variant, Clipper is recognized as Computer Associates' trademark.
+ * Clipper is a trademark of Computer Associates and will often be
+ * referred to as CA-Cl*pper within Harbour documents. Regardless of this
+ * variant, Clipper is recognized as Computer Associates' trademark.
*
- * Harbour is a free software compiler for the xBase superset language often
- * referred to as Clipper (the language that is implemented by the compiler
- * Clipper). The goal of the Harbour project is to produce a cross platform
- * CA-Cl*pper compatible compiler.
+ * Harbour is a free software compiler for the xBase superset language often
+ * referred to as Clipper (the language that is implemented by the compiler
+ * Clipper). The goal of the Harbour project is to produce a cross platform
+ * CA-Cl*pper compatible compiler.
*
- * The Harbour web site is at . If you
- * have any problems with this copy of Harbour please visit our web site and
- * ensure that you are using the latest release.
+ * The Harbour web site is at . If you
+ * have any problems with this copy of Harbour please visit our web site and
+ * ensure that you are using the latest release.
*
- * If you have any questions about Harbour please be sure to read the FAQ
- * . Also, please be sure to read the
- * documentation that comes with Harbour, you should find it in the same
- * directory in which you found this file.
+ * If you have any questions about Harbour please be sure to read the FAQ
+ * . Also, please be sure to read the
+ * documentation that comes with Harbour, you should find it in the same
+ * directory in which you found this file.
*
- * If you are reading this file as part of a source distribution of harbour you
- * probably want to start by reading dirstruc.txt because this is your map to
- * the harbour source directories.
+ * If you are reading this file as part of a source distribution of harbour you
+ * probably want to start by reading dirstruc.txt because this is your map to
+ * the harbour source directories.
*
- * Harbour is a superset of Clipper and is backwards compatible with nearly
- * 100% of all Clipper 5.2x or 5.3 code. Most Clipper S'87 code will also
- * compile and run fine, but may require some modifications to run well.
+ * Harbour is a superset of Clipper and is backwards compatible with nearly
+ * 100% of all Clipper 5.2x or 5.3 code. Most Clipper S'87 code will also
+ * compile and run fine, but may require some modifications to run well.
* $PLATFORMS$
- * All
+ * All
* $FILES$
*
* $SEEALSO$
diff --git a/harbour/doc/en/array.txt b/harbour/doc/en/array.txt
index b22237c084..71b24878f2 100644
--- a/harbour/doc/en/array.txt
+++ b/harbour/doc/en/array.txt
@@ -261,7 +261,7 @@
* will remain unchanged,as the last element in the array will
* become a NIL data type.
* $EXAMPLES$
- * LOCAL aArray
+ * LOCAL aArray
* aArray := {"Harbour", "is", "Power"}
*
* ADEL(aArray, 2) // Result: aArray is {"Harbour", "Power"}
diff --git a/harbour/doc/en/browse.txt b/harbour/doc/en/browse.txt
index 32df656abf..9863d13c7d 100644
--- a/harbour/doc/en/browse.txt
+++ b/harbour/doc/en/browse.txt
@@ -111,7 +111,7 @@
* Following are active keys that handled by DBEDIT():
* ---------------------------------------------------
*
- *
+ *
* Key Meaning
*
* Left Move one column to the left (previous field)
@@ -128,16 +128,16 @@
* Ctrl Right Pan one column to the right
* Ctrl Home Move to the leftmost column
* Ctrl End Move to the rightmost column
- *
+ *
*
* When is omitted, two more keys are active:
*
- *
+ *
* Key Meaning
*
* Esc Terminate BROWSE()
* Enter Terminate BROWSE()
- *
+ *
*
* When DBEDIT() execute it pass the following arguments:
* nMode and the index of current record in . If
@@ -205,7 +205,7 @@
* Header files are dbedit.ch, inkey.ch
* Library is rtl
* $SEEALSO$
- * @...SAY,BROWSE(),TBrowse class,TRANSFORM()
+ * @...SAY,BROWSE(),TBrowse class,TRANSFORM()
* $END$
*/
@@ -260,7 +260,7 @@
* On top of the screen you see a status line with the following
* indication:
*
- *
+ *
* Record ###/### Current record number / Total number of records.
* There are no records, the file is empty.
* You are in append mode at the bottom of file.
diff --git a/harbour/doc/en/cmdline.txt b/harbour/doc/en/cmdline.txt
index ebe6149234..36419f94b1 100644
--- a/harbour/doc/en/cmdline.txt
+++ b/harbour/doc/en/cmdline.txt
@@ -4,7 +4,7 @@
/* $DOC$
* $TEMPLATE$
- * Document
+ * Document
* $NAME$
* Command line utility
* $CATEGORY$
diff --git a/harbour/doc/en/compiler.txt b/harbour/doc/en/compiler.txt
index e58e5dde94..233bab1081 100644
--- a/harbour/doc/en/compiler.txt
+++ b/harbour/doc/en/compiler.txt
@@ -4,7 +4,7 @@
/* $DOC$
* $TEMPLATE$
- * Document
+ * Document
* $NAME$
* Compiler Options
* $CATEGORY$
@@ -271,7 +271,7 @@
* USE
*
* RETURN
- *
+ *
*
* Passing an undeclared variable by the reference
* ===============================================
@@ -290,7 +290,7 @@
* Handling of object messages
* ===========================
*
- * The HARBOUR_STRICT_CLIPPER_COMPATIBILITY setting determines
+ * The HARBOUR_STRICT_CLIPPER_COMPATIBILITY setting determines
* the way chained send messages are handled.
*
* For example, the following code:
diff --git a/harbour/doc/en/datetime.txt b/harbour/doc/en/datetime.txt
index 10840ce08b..6bfc842a4d 100644
--- a/harbour/doc/en/datetime.txt
+++ b/harbour/doc/en/datetime.txt
@@ -185,7 +185,7 @@
* $ARGUMENTS$
* Any valid date expression.
* $RETURNS$
- * Numeric value of the day of month.
+ * Numeric value of the day of month.
* $DESCRIPTION$
* This function returns the numeric value of the day of month from a
* date.
diff --git a/harbour/doc/en/dbstrux.txt b/harbour/doc/en/dbstrux.txt
index 67d8b78e52..39b44033e5 100644
--- a/harbour/doc/en/dbstrux.txt
+++ b/harbour/doc/en/dbstrux.txt
@@ -101,7 +101,7 @@
* COPY STRUCTURE command is preprocessed into __dbCopyStruct()
* function during compile time.
* $EXAMPLES$
- * // Create a new file that contains the same structure
+ * // Create a new file that contains the same structure
* USE TEST
* COPY STRUCTURE TO MyCopy
*
@@ -221,7 +221,7 @@
* COPY STRUCTURE EXTENDED create a new database named with
* a pre-defined structure (also called "structure extended file"):
*
- *
+ *
* Field name Type Length Decimals
*
* FIELD_NAME C 10 0
@@ -320,14 +320,14 @@
* then opened in the current work-area ( is ignored). The new
* file has the following structure:
*
- *
+ *
* Field name Type Length Decimals
*
* FIELD_NAME C 10 0
* FIELD_TYPE C 1 0
* FIELD_LEN N 3 0
* FIELD_DEC N 3 0
- *
+ *
*
* The CREATE command is preprocessed into the __dbCopyStruct() function
* during compile time and uses this mode.
@@ -418,14 +418,14 @@
* and then open it in the current work-area. The new file has the
* following structure:
*
- *
+ *
* Field name Type Length Decimals
*
* FIELD_NAME C 10 0
* FIELD_TYPE C 1 0
* FIELD_LEN N 3 0
* FIELD_DEC N 3 0
- *
+ *
*
* CREATE command is preprocessed into __dbCopyStruct() function during
* compile time and use this mode.
@@ -548,14 +548,14 @@
* structure, which is usually the output from DBSTRUCT(), where each
* array element has the following structure:
*
- *
+ *
* Position Description dbstruct.ch
*
* 1 cFieldName DBS_NAME
* 2 cFieldType DBS_TYPE
* 3 nFieldLength DBS_LEN
* 4 nDecimals DBS_DEC
- *
+ *
*
* is an array where each element is a field name.
* Names could be specified as uppercase or lowercase.
@@ -642,14 +642,14 @@
* structure, which is usually the output from DBSTRUCT(), where each
* array element has the following structure:
*
- *
+ *
* Position Description dbstruct.ch
*
* 1 cFieldName DBS_NAME
* 2 cFieldType DBS_TYPE
* 3 nFieldLength DBS_LEN
* 4 nDecimals DBS_DEC
- *
+ *
*
* is an array where each element is a field name.
* Names could be specified as uppercase or lowercase.
diff --git a/harbour/doc/en/file.txt b/harbour/doc/en/file.txt
index 6e99cf7948..b71f852a7e 100644
--- a/harbour/doc/en/file.txt
+++ b/harbour/doc/en/file.txt
@@ -47,7 +47,7 @@
* value of represents the status of the file to be opened;
* the default value is 0. The file open modes are as follows:
- *
+ *
* nMode fileio.ch Meaning
*
* 0 FO_READ Read only
@@ -58,7 +58,7 @@
* 48 FO_DENYREAD Deny read only
* 64 FO_DENYNONE Not deny, Let to others Read / Write
* 64 FO_SHARED same as FO_DENYNONE
- *
+ *
*
* If there is an error in opening a file, a -1 will be returned by
* the function. Files handles may be in the range of 0 to 65535. The
@@ -69,7 +69,6 @@
* If an error has occured, see the returns values from FERROR() for
* possible reasons for the error.
* $EXAMPLES$
- *
* IF (nH:=FOPEN('x.txt',66) < 0
* ? 'File can't be opened'
* ENDIF
@@ -120,14 +119,14 @@
* and their related meaning to the file being created by
* this function.
*
- *
+ *
* fileio.ch Meaning
*
* 0 FC_NORMAL Normal/Default,Read/Write
* 1 FC_READONLY Read-only file attribute is set
* 2 FC_HIDDEN Hidden,Excluded from normal DIR search
* 4 FC_SYSTEM Create,Excluded from normal DIR search
- *
+ *
* $EXAMPLES$
* IF (nh:=FCREATE("test.txt") <0
* ? "Cannot create file"
@@ -159,9 +158,9 @@
* FREAD( , @, ) --> nBytes
* $ARGUMENTS$
* Dos file handle
-
+ *
* Character expression passed by reference.
-
+ *
* Number of bytes to read.
* $RETURNS$
* the number of bytes successfully read from the file.
@@ -171,14 +170,14 @@
* is into a character memory variable expressed as .
* The function returns the number of bytes successfully read into
* .
-
+ *
* The value of is obtained from either a call to the FOPEN()
* or the FCREATE() function.
-
+ *
* The expression is passed by reference and must be defined
* before this function is called. It also must be at least the same
* length as .
-
+ *
* is the number of bytes to read, starting at the current
* file pointer position. If this function is successful in reading
* the characters from the file, the length of or the number
@@ -196,15 +195,15 @@
* ENDIF
* FCLOSE(nH)
* $STATUS$
- * R
+ * R
* $COMPLIANCE$
- * C
+ * C
* $PLATFORMS$
- * All(64K)
+ * All(64K)
* $FILES$
* Library is rtl
* $SEEALSO$
- * BIN2I(),BIN2L(),BIN2W(),FERROR(),FWRITE()
+ * BIN2I(),BIN2L(),BIN2W(),FERROR(),FWRITE()
* $END$
*/
@@ -220,13 +219,13 @@
* $ONELINER$
* Writes characters to a file.
* $SYNTAX$
- * FWRITE( , , [] ) --> nBytesWritten
+ * FWRITE( , , [] ) --> nBytesWritten
* $ARGUMENTS$
- * DOS file handle number.
+ * DOS file handle number.
- * Character expression to be written.
+ * Character expression to be written.
- * The number of bytes to write.
+ * The number of bytes to write.
* $RETURNS$
* the number of bytes successfully written.
* $DESCRIPTION$
@@ -303,7 +302,7 @@
* 30 Read fault
* 32 Sharing violation
* 33 Lock Violation
- *
+ *
* $DESCRIPTION$
* After every low-level file function,this function will return
* a value that provides additional informationon the status of
@@ -318,13 +317,13 @@
* ? "Cannot create file, DOS error ", FERROR()
* ENDIF
* $STATUS$
- * R
+ * R
* $COMPLIANCE$
- * C
+ * C
* $FILES$
* Library is rtl
* $SEEALSO$
- * FCLOSE(),FERASE(),FOPEN(),FWRITE()
+ * FCLOSE(),FERASE(),FOPEN(),FWRITE()
* $END$
*/
@@ -338,30 +337,30 @@
* $SUBCATEGORY$
* FileSys
* $ONELINER$
- * Closes an open file
+ * Closes an open file
* $SYNTAX$
- * FCLOSE( ) -->
+ * FCLOSE( ) -->
* $ARGUMENTS$
- * DOS file handle
+ * DOS file handle
* $RETURNS$
- * Logical TRUE (.T.) or FALSE (.F.)
+ * Logical TRUE (.T.) or FALSE (.F.)
* $DESCRIPTION$
- * This function closes an open file with a dos file handle
- * of and writes the associated DOS buffer to the
- * disk. The value is derived from the FCREATE()
- * or FOPEN() function.
+ * This function closes an open file with a dos file handle
+ * of and writes the associated DOS buffer to the
+ * disk. The value is derived from the FCREATE()
+ * or FOPEN() function.
* $EXAMPLES$
- * nHandle:=FOPEN('x.txt')
- * ? FSEEK(nHandle, 0, 2)
- * FCLOSE(nHandle)
+ * nHandle:=FOPEN('x.txt')
+ * ? FSEEK(nHandle, 0, 2)
+ * FCLOSE(nHandle)
* $STATUS$
- * R
+ * R
* $COMPLIANCE$
- * C
+ * C
* $FILES$
* Library is rtl
* $SEEALSO$
- * FOPEN(),FCREATE(),FREAD(),FWRITE(),FERROR()
+ * FOPEN(),FCREATE(),FREAD(),FWRITE(),FERROR()
* $END$
*/
@@ -404,13 +403,13 @@
* ? "File can not be deleted"
* ENDIF
* $STATUS$
- * R
+ * R
* $COMPLIANCE$
- * C
+ * C
* $FILES$
* Library is rtl
* $SEEALSO$
- * FERROR(),FRENAME()
+ * FERROR(),FRENAME()
* $END$
*/
@@ -428,12 +427,12 @@
* $SYNTAX$
* FRENAME( , ) --> nSuccess
* $ARGUMENTS$
- * Old filenarne to he changed
+ * Old filenarne to he changed
- * New filename
+ * New filename
* $RETURNS$
- * If sucessful, a 0 will he returned otherwise,
- * a -1 will be returned.
+ * If sucessful, a 0 will he returned otherwise,
+ * a -1 will be returned.
* $DESCRIPTION$
* This function renames the specified file to .
* A filename and/or directory name may be specified for either para-
@@ -461,13 +460,13 @@
* ? "File could not be renamed."
* ENDIF
* $STATUS$
- * R
+ * R
* $COMPLIANCE$
- * C
+ * C
* $FILES$
* Library is rtl
* $SEEALSO$
- * ERASE,FERASE(),FERROR(),FILE(),RENAME
+ * ERASE,FERASE(),FERROR(),FILE(),RENAME
* $END$
*/
@@ -485,11 +484,11 @@
* $SYNTAX$
* FSEEK( , , [] ) --> nPosition
* $ARGUMENTS$
- * DOS file handle.
+ * DOS file handle.
- * The number of bytes to move.
+ * The number of bytes to move.
- * The relative position in the file.
+ * The relative position in the file.
* $RETURNS$
* the current position relative to begin-of-file
* $DESCRIPTION$
@@ -640,9 +639,9 @@
* $STATUS$
* R
* $COMPLIANCE$
- * C
+ * C
* $PLATFORMS$
- * All(64K)
+ * All(64K)
* $FILES$
* Library is rtl
* $SEEALSO$
@@ -664,7 +663,7 @@
* $ONELINER$
* Changes the name of a specified file
* $SYNTAX$
- * RENAME TO
+ * RENAME TO
* $ARGUMENTS$
* Old filename
diff --git a/harbour/doc/en/garbage.txt b/harbour/doc/en/garbage.txt
index e27e7a8bb6..30b2e91988 100644
--- a/harbour/doc/en/garbage.txt
+++ b/harbour/doc/en/garbage.txt
@@ -4,7 +4,7 @@
/* $DOC$
* $TEMPLATE$
- * Document
+ * Document
* $NAME$
* The Garbage Collector
* $CATEGORY$
@@ -101,7 +101,7 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
* hb_gcAlloc()
* $CATEGORY$
@@ -152,7 +152,7 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
* hb_gcFree()
* $CATEGORY$
@@ -165,7 +165,7 @@
* void hb_gcFree( void *pMemoryPtr );
* $ARGUMENTS$
* The pointer to memory for release. This memory
- * pointer have to be allocated with hb_gcAlloc() function.
+ * pointer have to be allocated with hb_gcAlloc() function.
* $RETURNS$
* Nothing.
* $DESCRIPTION$
@@ -188,7 +188,7 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
* hb_gcCollectAll()
* $CATEGORY$
@@ -223,7 +223,7 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
* hb_gcItemRef()
* $CATEGORY$
@@ -267,7 +267,7 @@
/* $DOC$
* $TEMPLATE$
- * Procedure
+ * Procedure
* $NAME$
* HB_GCALL()
* $CATEGORY$
diff --git a/harbour/doc/en/gnulice.txt b/harbour/doc/en/gnulice.txt
index 2f3efac48f..6d549604b7 100644
--- a/harbour/doc/en/gnulice.txt
+++ b/harbour/doc/en/gnulice.txt
@@ -221,15 +221,15 @@
/*
* $DOC$
* $TEMPLATE$
- * Document
+ * Document
* $NAME$
- * GNU License..
+ * GNU License..
* $CATEGORY$
- * Document
+ * Document
* $SUBCATEGORY$
* License
* $ONELINER$
- * Gnu License File Part 2
+ * Gnu License File Part 2
* $DESCRIPTION$
* 7. If, as a consequence of a court judgment or allegation of patent
* infringement or for any other reason (not limited to patent
diff --git a/harbour/doc/en/harbext.txt b/harbour/doc/en/harbext.txt
index 8b62ff8649..7865b71c73 100644
--- a/harbour/doc/en/harbext.txt
+++ b/harbour/doc/en/harbext.txt
@@ -4,7 +4,7 @@
/* $DOC$
* $TEMPLATE$
- * Document
+ * Document
* $NAME$
* Harbour Extensions
* $CATEGORY$
@@ -12,76 +12,76 @@
* $ONELINER$
* Harbour Extensions
* $DESCRIPTION$
- *Language extensions:
- *--------------------
+ * Language extensions:
+ * --------------------
*
- ** Class generation and management.
+ * * Class generation and management.
*
- * CA-Cl*pper only allowed creation of objects from a few standard
- * classes.
+ * CA-Cl*pper only allowed creation of objects from a few standard
+ * classes.
*
- * In Harbour, you can create your own classes--complete with
- * Methods, Instance Variables, Class Variables and Inheritance.
- * Entire applications can be designed and coded in Object Oriented
- * style.
+ * In Harbour, you can create your own classes--complete with
+ * Methods, Instance Variables, Class Variables and Inheritance.
+ * Entire applications can be designed and coded in Object Oriented
+ * style.
*
- ** @()
+ * * @()
*
- * Returns the pointer (address) to a function.
+ * Returns the pointer (address) to a function.
*
- * The returned value is not useful to application-level programming, but
- * is used at a low level to implement object oriented coding.
- * (Internally, a class method is a static function and there is no
- * symbol for it, so it is accessed via its address).
+ * The returned value is not useful to application-level programming, but
+ * is used at a low level to implement object oriented coding.
+ * (Internally, a class method is a static function and there is no
+ * symbol for it, so it is accessed via its address).
*
- ** Class HBGetList
+ * * Class HBGetList
*
- * Object oriented support for GetLists management.
+ * Object oriented support for GetLists management.
*
- ** ProcName() support for class Method names.
+ * * ProcName() support for class Method names.
*
- * Class Methods can be retrieved from the call stack.
+ * Class Methods can be retrieved from the call stack.
*
- ** Memory() has new return values.
+ * * Memory() has new return values.
*
- * See hbmemory.ch
+ * See hbmemory.ch
*
- ** Transform() --> new function in format string
+ * * Transform() --> new function in format string
*
- * @0 Make a zero padded string out of the number.
+ * @0 Make a zero padded string out of the number.
*
- ** SToD() --> dDate
+ * * SToD() --> dDate
*
- * New function that converts a yyyymmdd string to a Date value.
+ * New function that converts a yyyymmdd string to a Date value.
*
- ** Optional Compile Time STRONG TYPE declaration (and compile time TYPE
- * MISMATCH warnings)
+ * * Optional Compile Time STRONG TYPE declaration (and compile time TYPE
+ * MISMATCH warnings)
*
- * Example: LOCAL/STATIC Var AS ...
+ * Example: LOCAL/STATIC Var AS ...
*
- ** The Harbour debugger provides new interesting classes:
+ * * The Harbour debugger provides new interesting classes:
*
- * - Class TDbWindow could be the foundation for a generic multiplatform
+ * - Class TDbWindow could be the foundation for a generic multiplatform
*
- * - Class TForm
+ * - Class TForm
*
- * - Class TDbMenu implement both pulldown and popup menus.
+ * - Class TDbMenu implement both pulldown and popup menus.
*
- *RTL enhanced functionality:
- *---------------------------
+ * RTL enhanced functionality:
+ * ---------------------------
*
- *- Directory( , , )
+ * - Directory( , , )
*
- * The 3rd parameter is a Harbour (optional) parameter and indicates that on
- * those platforms that support long filenames, that you wish to receive what
- * would be considered the dos equivalant 8.3 name.
- * Could affect Adir() and Dir if they were modified to take advantage
- * of it - currently, they will return long names if the os supports it.
+ * The 3rd parameter is a Harbour (optional) parameter and indicates that on
+ * those platforms that support long filenames, that you wish to receive what
+ * would be considered the dos equivalant 8.3 name.
+ * Could affect Adir() and Dir if they were modified to take advantage
+ * of it - currently, they will return long names if the os supports it.
*
- *- HB_DiskSpace( , )
+ * - HB_DiskSpace( , )
*
- * The second parameter is a Harbour (optional) parameter and indicates the
- * type of diskinfo being requested. See en/diskspac.txt for info.
+ * The second parameter is a Harbour (optional) parameter and indicates the
+ * type of diskinfo being requested. See en/diskspac.txt for info.
*
* $END$
*/
diff --git a/harbour/doc/en/hashes.txt b/harbour/doc/en/hashes.txt
index 09d363bda5..8584ba0f5a 100644
--- a/harbour/doc/en/hashes.txt
+++ b/harbour/doc/en/hashes.txt
@@ -55,24 +55,24 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HASH()
+ * HB_HASH()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Returns a hash table
+ * Returns a hash table
* $SYNTAX$
- * HB_HASH( [ , ], [ , ], ... ) -> hsTable
+ * HB_HASH( [ , ], [ , ], ... ) -> hsTable
* $ARGUMENTS$
- * entry key;
- * can be of type: number, date, datetime, string, pointer
+ * entry key;
+ * can be of type: number, date, datetime, string, pointer
*
- * entry value; can be of type: block, string, numeric, date/datetime, logical, nil, pointer, array, hash table
+ * entry value; can be of type: block, string, numeric, date/datetime, logical, nil, pointer, array, hash table
* $RETURNS$
- * A hash table built from the initial key/value pairs
+ * A hash table built from the initial key/value pairs
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -94,24 +94,24 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HHASKEY()
+ * HB_HHASKEY()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Determines whether a hash table has an entry with a give key
+ * Determines whether a hash table has an entry with a give key
* $SYNTAX$
- * HB_HHASKEY( , ) -> lExists
+ * HB_HHASKEY( , ) -> lExists
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * a key value to be queried for;
- * can be of type: number, date, datetime, string, pointer
+ * a key value to be queried for;
+ * can be of type: number, date, datetime, string, pointer
* $RETURNS$
- * A logical value indicating whether the key exists within the hash table
+ * A logical value indicating whether the key exists within the hash table
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -133,24 +133,24 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HPOS()
+ * HB_HPOS()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Locates the index of a key within a hash table
+ * Locates the index of a key within a hash table
* $SYNTAX$
- * HB_HPOS( , ) -> nPosition
+ * HB_HPOS( , ) -> nPosition
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * key for which its position is to be determined;
- * can be of type: number, date, datetime, string, pointer
+ * key for which its position is to be determined;
+ * can be of type: number, date, datetime, string, pointer
* $RETURNS$
- * A integer number being the index position of the key within the hash table.
+ * A integer number being the index position of the key within the hash table.
*
* TODO: what is the return value if the key does not exist? zero (0)? RTE?
* $DESCRIPTION$
@@ -174,26 +174,26 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HGET()
+ * HB_HGET()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Returns a hash value
+ * Returns a hash value
* $SYNTAX$
- * HB_HGET( , ) ->
+ * HB_HGET( , ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * key to be retrieve from the hash table;
- * can be of type: number, date, datetime, string, pointer
+ * key to be retrieve from the hash table;
+ * can be of type: number, date, datetime, string, pointer
* $RETURNS$
- * Either the value within the hash table for the given key.
+ * Either the value within the hash table for the given key.
*
- * An array access error occurs of the key is not found
+ * An array access error occurs of the key is not found
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -215,28 +215,28 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HGETDEF()
+ * HB_HGETDEF()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Returns a hash value, or a default value if the key is not present
+ * Returns a hash value, or a default value if the key is not present
* $SYNTAX$
- * HB_HGETDEF( , , [] ) ->
+ * HB_HGETDEF( , , [] ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * key to be retrieve from the hash table;
- * can be of type: number, date, datetime, string, pointer
+ * key to be retrieve from the hash table;
+ * can be of type: number, date, datetime, string, pointer
*
- * a default value to be returned if the
- * hash table does not contain the key
+ * a default value to be returned if the
+ * hash table does not contain the key
* $RETURNS$
- * Either the value within the hash table for the given key,
- * or the default value.
+ * Either the value within the hash table for the given key,
+ * or the default value.
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -258,26 +258,26 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HSET()
+ * HB_HSET()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Sets a hash value
+ * Sets a hash value
* $SYNTAX$
- * HB_HSET( , , ) ->
+ * HB_HSET( , , ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * the key of the entry to be set;
- * can be of type: number, date, datetime, string, pointer
+ * the key of the entry to be set;
+ * can be of type: number, date, datetime, string, pointer
*
- * the entry value
+ * the entry value
* $RETURNS$
- * The hash table
+ * The hash table
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -299,24 +299,24 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HDEL()
+ * HB_HDEL()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Removes a key/value pair from a hash table
+ * Removes a key/value pair from a hash table
* $SYNTAX$
- * HB_HDEL( , ) ->
+ * HB_HDEL( , ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * key to be removed from the hash table;
- * can be of type: number, date, datetime, string, pointer
+ * key to be removed from the hash table;
+ * can be of type: number, date, datetime, string, pointer
* $RETURNS$
- * The hash table
+ * The hash table
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -338,25 +338,25 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HKEYAT()
+ * HB_HKEYAT()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Gets a hash table key at a given position
+ * Gets a hash table key at a given position
* $SYNTAX$
- * HB_HKEYAT( , ) ->
+ * HB_HKEYAT( , ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * the position of an entry within the hash table that will
- * be returned
+ * the position of an entry within the hash table that will
+ * be returned
* $RETURNS$
- * The key at the given position of the hash table;
- * the type will be one: number, date, datetime, string, pointer
+ * The key at the given position of the hash table;
+ * the type will be one: number, date, datetime, string, pointer
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -378,27 +378,27 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HVALUEAT()
+ * HB_HVALUEAT()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Gets/sets a hash value at a given position
+ * Gets/sets a hash value at a given position
* $SYNTAX$
- * HB_HVALUEAT( , , [] ) ->
+ * HB_HVALUEAT( , , [] ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * the position of an entry within the hash table that will
- * be returned
+ * the position of an entry within the hash table that will
+ * be returned
*
- * a new value to be assigned to the hash table at the given
- * position
+ * a new value to be assigned to the hash table at the given
+ * position
* $RETURNS$
- * The existing value, or the new value if it is given
+ * The existing value, or the new value if it is given
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -420,24 +420,24 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HPAIRAT()
+ * HB_HPAIRAT()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Returns a two-dimensional array of a hash table entry key/value pair
+ * Returns a two-dimensional array of a hash table entry key/value pair
* $SYNTAX$
- * HB_HPAIRAT( , ) ->
+ * HB_HPAIRAT( , ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * the position of an entry within the hash table that will
- * be returned
+ * the position of an entry within the hash table that will
+ * be returned
* $RETURNS$
- * A two-dimensional array of the key/value pair entry of the hash table
+ * A two-dimensional array of the key/value pair entry of the hash table
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -459,24 +459,24 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HDELAT()
+ * HB_HDELAT()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Removes an entry from a hash table based on its index position
+ * Removes an entry from a hash table based on its index position
* $SYNTAX$
- * HB_HDELAT( , ) ->
+ * HB_HDELAT( , ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * the position of an entry within the hash table that will
- * be deleted
+ * the position of an entry within the hash table that will
+ * be deleted
* $RETURNS$
- * The hash table
+ * The hash table
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -498,21 +498,21 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HKEYS()
+ * HB_HKEYS()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Returns an array of the keys of a hash table
+ * Returns an array of the keys of a hash table
* $SYNTAX$
- * HB_HKEYS( ) ->
+ * HB_HKEYS( ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
* $RETURNS$
- * An array of all the hash table keys
+ * An array of all the hash table keys
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -534,21 +534,21 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HVALUES()
+ * HB_HVALUES()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Returns an array of the values of a hash table
+ * Returns an array of the values of a hash table
* $SYNTAX$
- * HB_HVALUES( ) ->
+ * HB_HVALUES( ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
* $RETURNS$
- * An array of all the hash values
+ * An array of all the hash values
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -570,23 +570,23 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HFILL()
+ * HB_HFILL()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Fills a hash table with a value
+ * Fills a hash table with a value
* $SYNTAX$
- * HB_HFILL( , ) ->
+ * HB_HFILL( , ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
*
- * fill value; can be of type: block, string, numeric, date/datetime, logical, nil, pointer, array, hash table
+ * fill value; can be of type: block, string, numeric, date/datetime, logical, nil, pointer, array, hash table
* $RETURNS$
- * The hash table
+ * The hash table
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -608,21 +608,21 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HCLONE()
+ * HB_HCLONE()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Creates a copy of a hash table
+ * Creates a copy of a hash table
* $SYNTAX$
- * HB_HCLONE( ) ->
+ * HB_HCLONE( ) ->
* $ARGUMENTS$
- * a hash table, created by HB_HASH()
+ * a hash table, created by HB_HASH()
* $RETURNS$
- * A cloned copy of the hash table
+ * A cloned copy of the hash table
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -644,27 +644,27 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HCOPY()
+ * HB_HCOPY()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Adds entries from the source hash table to the destination hash table
+ * Adds entries from the source hash table to the destination hash table
* $SYNTAX$
- * HB_HCOPY( , , [], [] ) ->
+ * HB_HCOPY( , , [], [] ) ->
* $ARGUMENTS$
- * a destination hash table, created by HB_HASH()
+ * a destination hash table, created by HB_HASH()
*
- * a source hash table, created by HB_HASH()
+ * a source hash table, created by HB_HASH()
*
- * starting index, defaults to 1 if omitted
+ * starting index, defaults to 1 if omitted
*
- * counter, defaults to (length) - is omitted
+ * counter, defaults to (length) - is omitted
* $RETURNS$
- * The destination hash table
+ * The destination hash table
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -686,33 +686,33 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HMERGE()
+ * HB_HMERGE()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Merges a source hash table into a destination hash table
+ * Merges a source hash table into a destination hash table
* $SYNTAX$
- * HB_HMERGE( , , | ) ->
+ * HB_HMERGE( , , | ) ->
* $ARGUMENTS$
- * a destination hash table, created by HB_HASH()
+ * a destination hash table, created by HB_HASH()
*
- * a source hash table, created by HB_HASH()
+ * a source hash table, created by HB_HASH()
*
- * a code block that will be evaluated for each entry within the
- * source hash table; the code block will be passed the entry key, value and
- * position; if the code block returns a true value, the entry will be added to
- * the destination hash table
+ * a code block that will be evaluated for each entry within the
+ * source hash table; the code block will be passed the entry key, value and
+ * position; if the code block returns a true value, the entry will be added to
+ * the destination hash table
*
- * the position of an entry within the source hash table that will
- * be appended to the destination hash table
+ * the position of an entry within the source hash table that will
+ * be appended to the destination hash table
*
- * TODO: the source code passes either a number or HB_HASH_UNION; research this
+ * TODO: the source code passes either a number or HB_HASH_UNION; research this
* $RETURNS$
- * The destination hash table with the contents of the source hash table merged
+ * The destination hash table with the contents of the source hash table merged
* $DESCRIPTION$
*
* $EXAMPLES$
@@ -734,32 +734,32 @@
/* $DOC$
* $TEMPLATE$
- * Function
+ * Function
* $NAME$
- * HB_HEVAL()
+ * HB_HEVAL()
* $CATEGORY$
- * API
+ * API
* $SUBCATEGORY$
- * Hash table
+ * Hash table
* $ONELINER$
- * Evaluate a code block across the contents of a hash table
+ * Evaluate a code block across the contents of a hash table
* $SYNTAX$
- * HB_HEVAL( , , [], [] ) ->
+ * HB_HEVAL(