From 106f12dbca8ac3cd503cfff7291fb91c8af921eb Mon Sep 17 00:00:00 2001 From: Chen Kedem Date: Wed, 1 Mar 2000 08:13:34 +0000 Subject: [PATCH] 20000301-10:15 GMT+2 Chen Kedem --- harbour/ChangeLog | 20 +++++++++++++ harbour/doc/en/array.txt | 7 ++--- harbour/doc/en/binnum.txt | 3 +- harbour/doc/en/browse.txt | 5 +--- harbour/doc/en/dir.txt | 13 ++++---- harbour/doc/en/error.txt | 3 +- harbour/doc/en/file.txt | 15 ++-------- harbour/doc/en/hvm.txt | 10 +++---- harbour/doc/en/input.txt | 2 +- harbour/doc/en/menu.txt | 9 +++--- harbour/doc/en/misc.txt | 6 ++-- harbour/doc/en/objfunc.txt | 7 ++++- harbour/doc/en/set.txt | 39 ++++++++++++------------ harbour/doc/en/terminal.txt | 35 ++++++++++------------ harbour/doc/en/tgetlist.txt | 3 +- harbour/doc/en/var.txt | 60 ++++++++++++++++++------------------- 16 files changed, 119 insertions(+), 118 deletions(-) diff --git a/harbour/ChangeLog b/harbour/ChangeLog index 44cbcd22de..26f3e36a7d 100644 --- a/harbour/ChangeLog +++ b/harbour/ChangeLog @@ -1,3 +1,23 @@ +20000301-10:15 GMT+2 Chen Kedem + * doc/en/ARRAY.TXT + * doc/en/BINNUM.TXT + * doc/en/BROWSE.TXT + * doc/en/DIR.TXT + * doc/en/ERROR.TXT + * doc/en/FILE.TXT + * doc/en/HVM.TXT + * doc/en/INPUT.TXT + * doc/en/MENU.TXT + * doc/en/MISC.TXT + * doc/en/OBJFUNC.TXT + * doc/en/SET.TXT + * doc/en/TERMINAL.TXT + * doc/en/TGETLIST.TXT + * doc/en/VAR.TXT + * Modify copyright detail for function/commands I wrote + ! NOTE: Individual copyright holder should check his/her doc work + to make sure creadits are given to the right person + 20000301-03:04 GMT+1 Victor Szakats * source/pp/* include/hbpp.h diff --git a/harbour/doc/en/array.txt b/harbour/doc/en/array.txt index 0171fa42df..3ed4a9a8df 100644 --- a/harbour/doc/en/array.txt +++ b/harbour/doc/en/array.txt @@ -7,7 +7,7 @@ * www - http://www.harbour-project.org * * Copyright 1999 Chen Kedem - * Documentation + * Documentation for: ASORT() * * See doc/license.txt for licensing terms. * @@ -185,8 +185,8 @@ * item in the array will be removed completely. In other words, if an * array element were to be inserted at the fifth subscript position, * the element previously in the fifth position would now be located - * at the sixth position. The length of the array will remain - * unchanged. + * at the sixth position. The length of the array will remain + * unchanged. * $EXAMPLES$ * LOCAL aArray:={"Harbour","is","Power!","!!!"} * AINS(aArray,4) @@ -551,4 +551,3 @@ * ASCAN(),EVAL(),SORT * $END$ */ - diff --git a/harbour/doc/en/binnum.txt b/harbour/doc/en/binnum.txt index 5282e62f52..48d785855d 100644 --- a/harbour/doc/en/binnum.txt +++ b/harbour/doc/en/binnum.txt @@ -7,7 +7,8 @@ * www - http://www.harbour-project.org * * Copyright 2000 Chen Kedem - * Documentation for all functions + * Documentation for: BIN2W(), BIN2I(), BIN2L(), BIN2U(), I2BIN(), W2BIN(), + * L2BIN(), U2BIN() * * See doc/license.txt for licensing terms. * diff --git a/harbour/doc/en/browse.txt b/harbour/doc/en/browse.txt index f81278fad1..8a1d63780e 100644 --- a/harbour/doc/en/browse.txt +++ b/harbour/doc/en/browse.txt @@ -7,10 +7,7 @@ * www - http://www.harbour-project.org * * Copyright 1999 Chen Kedem - * BROWSE() documentation - * DBEDIT() documentation - * TBROWSEDB() documentation - * DBSKIPPER() documentation + * Documentation for: BROWSE(), DBEDIT(), TBROWSEDB(), DBSKIPPER() * * See doc/license.txt for licensing terms. * diff --git a/harbour/doc/en/dir.txt b/harbour/doc/en/dir.txt index 50e04e9456..cbacd94de3 100644 --- a/harbour/doc/en/dir.txt +++ b/harbour/doc/en/dir.txt @@ -7,8 +7,7 @@ * www - http://www.harbour-project.org * * Copyright 1999 Chen Kedem - * ADIR() documentation - * __DIR() documentation + * Documentation for: __DIR(), DIR, ADIR() * * See doc/license.txt for licensing terms. * @@ -16,7 +15,7 @@ /* $DOC$ * $FUNCNAME$ - * __Dir()* + * __Dir()* * $CATEGORY$ * File management * $ONELINER$ @@ -106,10 +105,10 @@ * * // list all PRG files in Harbour Run-Time library * // for DOS compatible operating systems - * Dir "c:\harbour\source\rtl\*.prg" + * Dir "c:\harbour\source\rtl\*.prg" * * // list all files in the public section on a Unix like machine - * Dir "/pub" + * Dir "/pub" * $TESTS$ * $STATUS$ * $COMPLIANCE$ @@ -192,11 +191,11 @@ * ENDIF * $TESTS$ * $STATUS$ - * R + * R * $COMPLIANCE$ * is going to be fill with long file name and not necessarily * the 8.3 uppercase name. - * + * * $SEEALSO$ * ARRAY(),DIRECTORY(),SET DEFAULT * $END$ diff --git a/harbour/doc/en/error.txt b/harbour/doc/en/error.txt index a137341edf..f621e998ed 100644 --- a/harbour/doc/en/error.txt +++ b/harbour/doc/en/error.txt @@ -7,7 +7,7 @@ * www - http://www.harbour-project.org * * Copyright 1999 Chen Kedem - * ERRORSYS() documentation + * Documentation for: ERRORSYS() * * See doc/license.txt for licensing terms. * @@ -40,4 +40,3 @@ * ERRORBLOCK(),Error class * $END$ */ - diff --git a/harbour/doc/en/file.txt b/harbour/doc/en/file.txt index e48ce76ebd..3bbf43ac5c 100644 --- a/harbour/doc/en/file.txt +++ b/harbour/doc/en/file.txt @@ -7,20 +7,11 @@ * www - http://www.harbour-project.org * * Copyright 2000 Chen Kedem - * __TYPEFILE() / TYPE documentation + * Documentation for: __TYPEFILE(), TYPE * * Copyright 2000 Luiz Rafael Culik - * FOPEN() Documentation - * FCLOSE() Documentation - * FWRITE() Documentation - * FSEEK() Documentation - * FREAD() Documentation - * FILE() Documentation - * FREADSTR() Documentation - * FRENAME() Documentation - * FERROR() Documentation - * RENAME Documentation - * ERASE Documentation + * Documentation for: FOPEN(), FCLOSE(), FWRITE(), FSEEK(), FREAD(), FILE(), + * FREADSTR(), FRENAME(), FERROR(), RENAME, ERASE * * See doc/license.txt for licensing terms. * diff --git a/harbour/doc/en/hvm.txt b/harbour/doc/en/hvm.txt index b5ce073983..d77b86a76e 100644 --- a/harbour/doc/en/hvm.txt +++ b/harbour/doc/en/hvm.txt @@ -7,12 +7,10 @@ * www - http://www.harbour-project.org * * Copyright 1999 Chen Kedem - * CLIPINIT() documentation - * __SETHELPK() documentation + * Documentation for: CLIPINIT(), __SETHELPK() * * Copyright 1999 Ryszard Glab - * DO() documentation - * EVAL() documentation + * Documentation for: DO() * * See doc/license.txt for licensing terms. * @@ -220,7 +218,7 @@ * $COMPLIANCE$ * __QUIT() is fully CA-Clipper compliant. * $SEEALSO$ - * QUIT + * QUIT * $END$ */ @@ -252,7 +250,7 @@ * $PLATFORMS$ * $FILES$ * $SEEALSO$ - * INIT PROCEDURE + * INIT PROCEDURE * $END$ */ diff --git a/harbour/doc/en/input.txt b/harbour/doc/en/input.txt index 230bb9ae1c..11dab36e70 100644 --- a/harbour/doc/en/input.txt +++ b/harbour/doc/en/input.txt @@ -7,7 +7,7 @@ * www - http://www.harbour-project.org * * Copyright 1999 Chen Kedem - * READKEY() documentation + * Documentation for: READKEY() * * See doc/license.txt for licensing terms. * diff --git a/harbour/doc/en/menu.txt b/harbour/doc/en/menu.txt index cadd2d2c4f..7a2b190bfb 100644 --- a/harbour/doc/en/menu.txt +++ b/harbour/doc/en/menu.txt @@ -7,8 +7,7 @@ * www - http://www.harbour-project.org * * Copyright 1999 Chen Kedem - * __ATPROMPT() documentation - * __MENUTO() documentation + * Documentation for: __ATPROMPT(), @...PROMPT, __MENUTO(), MENU TO * * See doc/license.txt for licensing terms. * @@ -91,7 +90,7 @@ /* $DOC$ * $FUNCNAME$ - * __AtPrompt() + * __AtPrompt() * $CATEGORY$ * Data input and output * $ONELINER$ @@ -155,7 +154,7 @@ /* $DOC$ * $FUNCNAME$ - * @...PROMPT + * @...PROMPT * $CATEGORY$ * Command * $ONELINER$ @@ -218,7 +217,7 @@ /* $DOC$ * $FUNCNAME$ - * __MenuTo() + * __MenuTo() * $CATEGORY$ * Data input and output * $ONELINER$ diff --git a/harbour/doc/en/misc.txt b/harbour/doc/en/misc.txt index f65aea913c..0d1ddbf92e 100644 --- a/harbour/doc/en/misc.txt +++ b/harbour/doc/en/misc.txt @@ -7,7 +7,7 @@ * www - http://www.harbour-project.org * * Copyright 2000 Chen Kedem - * TONE() + * Documentation for: TONE() * * See doc/license.txt for licensing terms. * @@ -54,7 +54,7 @@ * and C compiler Version when the parameter is used. * $DESCRIPTION$ * This function returns the HARBOUR Version or the Harbour Version+C - * compiler Version used to create the Harbour runtime library + * compiler Version used to create the Harbour runtime library * $EXAMPLES$ * ? QOUT(VERSION()) // Displays Harbour version only * ? QOUT(VERSION(NIL)) // Displays Harbour and C Compiler versions @@ -122,7 +122,7 @@ * $CATEGORY$ * DOS * $ONELINER$ - * Run a external program + * Run a external program * $SYNTAX$ * __RUN( ) * $CATEGORY$ diff --git a/harbour/doc/en/objfunc.txt b/harbour/doc/en/objfunc.txt index 470b49d142..5e8c467edd 100644 --- a/harbour/doc/en/objfunc.txt +++ b/harbour/doc/en/objfunc.txt @@ -7,7 +7,12 @@ * www - http://www.harbour-project.org * * Copyright 1999 Chen Kedem - * Documentation for all functions + * Documentation for: __objHasData(), __objHasMethod(), __objGetMsgList(), + * __objGetMethodList(), __objGetValueList(), + * __ObjSetValueList(), __objAddMethod(), + * __objAddInline(), __objAddData(), __objModMethod(), + * __objModInline(), __objDelMethod(), __objDelInline(), + * __objDelData() * * See doc/license.txt for licensing terms. * diff --git a/harbour/doc/en/set.txt b/harbour/doc/en/set.txt index 1a26022084..b84b9a6956 100644 --- a/harbour/doc/en/set.txt +++ b/harbour/doc/en/set.txt @@ -7,21 +7,20 @@ * www - http://www.harbour-project.org * * Copyright 1999 David G. Holm - * SET() - * __SETCENTURY() + * Documentation for: SET(), __SETCENTURY() * * Copyright 1999 A White - * SETKEY() - * HB_SetKeyGet() - * HB_SETKEYSAVE() - * HB_SetKeyCheck() - * SET KEY + * Documentation for: SETKEY(), HB_SetKeyGet(), HB_SETKEYSAVE(), + * HB_SetKeyCheck(), SET KEY * * Copyright 1999 Chen Kedem - * __SetFunction() documentation + * Documentation for: __SetFunction(), SET FUNCTION * * Copyright 1999 Jose Lalin - * SETTYPEAHEAD() + * Documentation for: SETTYPEAHEAD() + * + * Copyright 1999 Victor Szakats + * Documentation for: __XHELP() * * See doc/license.txt for licensing terms. * @@ -472,8 +471,8 @@ * $RETURNS$ * Current assigned action-block * $DESCRIPTION$ - * The HB_SetKeyGet() function returns the current code-block assigned to - * a key, and optionally assignes the condition-block to the + * The HB_SetKeyGet() function returns the current code-block assigned to + * a key, and optionally assignes the condition-block to the * return-parameter * $EXAMPLES$ * local bOldF10, bOldF10Cond @@ -506,11 +505,11 @@ * $RETURNS$ * Current set-key list * $DESCRIPTION$ - * HB_SetKeySave() is designed to act like the set() function which - * returns the current state of an environment setting, and optionally - * assigning a new value. In this case, the "environment setting" is the - * internal set-key list, and the optional new value is either a value - * returned from a previous call to SetKeySave() - to restore that list, + * HB_SetKeySave() is designed to act like the set() function which + * returns the current state of an environment setting, and optionally + * assigning a new value. In this case, the "environment setting" is the + * internal set-key list, and the optional new value is either a value + * returned from a previous call to SetKeySave() - to restore that list, * or the value of NIL to clear the current list. * $EXAMPLES$ * local aKeys := HB_SetKeySave( NIL ) // removes all current set=keys @@ -546,8 +545,8 @@ * If there is a hot-key association (before checking any condition): * - if there is a condition-block, it is passed one parameter - * - when the hot-key code-block is called, it is passed 1 to 4 parameters, - * depending on the parameters passed to HB_SetKeyCheck(). Any - * parameters so passed are directly passed to the code-block, with an + * depending on the parameters passed to HB_SetKeyCheck(). Any + * parameters so passed are directly passed to the code-block, with an * additional parameter being * $DESCRIPTION$ * HB_SetKeyCheck() is intended as a common interface to the SetKey() @@ -643,7 +642,7 @@ * // Sets typeahead to 12 * SetTypeahead( 12 ) * $TESTS$ - * + * * $STATUS$ * R * $COMPLIANCE$ @@ -678,6 +677,6 @@ * $COMPLIANCE$ * __XHELP() is fully CA-Clipper compliant. * $SEEALSO$ - * + * * $END$ */ diff --git a/harbour/doc/en/terminal.txt b/harbour/doc/en/terminal.txt index 217a47c85c..2ce6e9ef85 100644 --- a/harbour/doc/en/terminal.txt +++ b/harbour/doc/en/terminal.txt @@ -7,22 +7,18 @@ * www - http://www.harbour-project.org * * Copyright 1999 Victor Szakats - * HB_HB_COLORINDEX() + * Documentation for: HB_COLORINDEX() * * Copyright 1999 Jose Lalin - * __WAIT() documentation - * __INPUT() documentation + * Documentation for: __WAIT(), __INPUT() * * Copyright 1999 Chen Kedem - * ALERT() documentation - * __NONOALERT() documentation - * __XSaveScreen() documentation - * __XRestScreen() documentation - * __TextSave() documentation - * __TextRestore() documentation + * Documentation for: ALERT(), __NONOALERT(), __XSaveScreen(), SAVE SCREEN + * __XRestScreen(), RESTORE SCREEN, __TextSave(), + * __TextRestore() * * Copyright 1999 David G. Holm - * DEVOUTPICT() documentation + * Documentation for: DEVOUTPICT() * * See doc/license.txt for licensing terms. * @@ -30,7 +26,7 @@ /* $DOC$ * $FUNCNAME$ - * __XSaveScreen() + * __XSaveScreen() * $CATEGORY$ * Data input and output * $ONELINER$ @@ -117,7 +113,7 @@ /* $DOC$ * $FUNCNAME$ - * __XRestScreen() + * __XRestScreen() * $CATEGORY$ * Data input and output * $ONELINER$ @@ -161,7 +157,7 @@ /* $DOC$ * $FUNCNAME$ - * RESTORE SCREEN + * RESTORE SCREEN * $CATEGORY$ * Command * $ONELINER$ @@ -437,7 +433,7 @@ * $CATEGORY$ * Data input and output * $ONELINER$ - * Stops application + * Stops application * $SYNTAX$ * __INPUT( ) --> * $ARGUMENTS$ @@ -448,11 +444,11 @@ * This function waits for a console input and returns macroed * expression entered. * $EXAMPLES$ - * - * + * + * * $TESTS$ - * - * + * + * * $STATUS$ * S * $COMPLIANCE$ @@ -468,7 +464,7 @@ * $CATEGORY$ * Internal * $ONELINER$ - * Redirect console output to printer or file and save old settings + * Redirect console output to printer or file and save old settings * $SYNTAX$ * __TextSave( ) --> NIL * $ARGUMENTS$ @@ -553,4 +549,3 @@ * __ACCEPT(),__INPUT() * $END$ */ - diff --git a/harbour/doc/en/tgetlist.txt b/harbour/doc/en/tgetlist.txt index 917551b862..bc44a10ee6 100644 --- a/harbour/doc/en/tgetlist.txt +++ b/harbour/doc/en/tgetlist.txt @@ -7,7 +7,7 @@ * www - http://www.harbour-project.org * * Copyright 1999 Chen Kedem - * READVAR() documentation + * Documentation for: READVAR() * * See doc/license.txt for licensing terms. * @@ -59,4 +59,3 @@ * @...GET,@...PROMPT,MENU TO,READ,SET KEY,__AtPrompt(),__MenuTo() * $END$ */ - diff --git a/harbour/doc/en/var.txt b/harbour/doc/en/var.txt index 65ebaf84e1..38a5c4953b 100644 --- a/harbour/doc/en/var.txt +++ b/harbour/doc/en/var.txt @@ -7,13 +7,13 @@ * www - http://www.harbour-project.org * * Copyright 1999 Ryszard Glab - * __MV*() documentation - * MEMVARBLOCK() documentation - * TYPE() documentation + * Documentation for: __MVPUBLIC(), __MVPRIVATE(), __MVXRELEASE(), + * __MVRELEASE(), __MVSCOPE(), __MVCLEAR(), + * __MVDBGINFO(), __MVGET(), __MVPUT(), MEMVARBLOCK(), + * TYPE() * * Copyright 1999 Chen Kedem - * FIELDBLOCK() documentation - * FIELDWBLOCK() documentation + * Documentation for: FIELDBLOCK(), FIELDWBLOCK() * * See doc/license.txt for licensing terms. * @@ -156,7 +156,7 @@ * $CATEGORY$ * Variable Management * $ONELINER$ - * This function releases PRIVATE variables + * This function releases PRIVATE variables * $SYNTAX$ * __MVRELEASE( , ) * $ARGUMENTS$ @@ -309,8 +309,8 @@ * It also returns the name of a variable if optional third argument * is passed by reference. * - * If requested variable doesn't exist (requested position is - * greater then the number of defined variables) then NIL value is + * If requested variable doesn't exist (requested position is + * greater then the number of defined variables) then NIL value is * returned and variable name is set to "?" * * The dynamic symbols table is used to find a PUBLIC variable then @@ -469,29 +469,29 @@ * $ONELINER$ * Returns a codeblock that sets/gets a value of memvar variable * $SYNTAX$ - * MEMVARBLOCK( ) + * MEMVARBLOCK( ) * $ARGUMENTS$ - * - a string that contains the name of variable + * - a string that contains the name of variable * $RETURNS$ - * a codeblock that sets/get the value of variable + * a codeblock that sets/get the value of variable * $DESCRIPTION$ - * This function returns a codeblock that sets/gets the value of - * PRIVATE or PUBLIC variable. When this codeblock is evaluated - * without any parameters passed then it returns the current value - * of given variable. If the second parameter is passed for - * the codeblock evaluation then its value is used to set the new - * value of given variable - the passed value is also returned - * as a value of the codeblock evaluation. + * This function returns a codeblock that sets/gets the value of + * PRIVATE or PUBLIC variable. When this codeblock is evaluated + * without any parameters passed then it returns the current value + * of given variable. If the second parameter is passed for + * the codeblock evaluation then its value is used to set the new + * value of given variable - the passed value is also returned + * as a value of the codeblock evaluation. * $EXAMPLES$ - * PROCEDURE MAIN() - * LOCAL cbSetGet - * PUBLIC xPublic - * - * cbSetGet = MEMVARBLOCK( "xPublic" ) - * EVAL( cbSetGet, "new value" ) - * ? "Value of xPublic variable", EVAL( cbSetGet ) + * PROCEDURE MAIN() + * LOCAL cbSetGet + * PUBLIC xPublic * - * RETURN + * cbSetGet = MEMVARBLOCK( "xPublic" ) + * EVAL( cbSetGet, "new value" ) + * ? "Value of xPublic variable", EVAL( cbSetGet ) + * + * RETURN * $TESTS$ * $STATUS$ * R @@ -639,7 +639,7 @@ * If there is a call for any non-reserved Harbour function then "UI" * is returned (in other words there is no call for passed UDF function * during a data type determination - this is Clipper compatible - * behavior). Additionally if requested user defined function is not + * behavior). Additionally if requested user defined function is not * linked into executable then "U" is returned. * * The data type of expression is checked by invoking a macro compiler @@ -652,14 +652,14 @@ * the type of passed argument of any type. TYPE() requires a string * argument with a valid Harbour expression - the data type of this * expression is returned. - * + * * Notes: * - Incompatibility with Clipper: * In the following code: - * + * * PRIVATE lCond := 0 * ? TYPE( "IIF( lCond, 'true', MyUDF() )" ) - * + * * Clipper will print "UE" - in Harbour the output will be "UI" * * - if "UI" is returned then the syntax of the expression is