From ded727a2fbb3f5e12548793284c7d2d7f305ffa3 Mon Sep 17 00:00:00 2001 From: Luiz Rafael Culik Date: Sun, 2 Apr 2000 00:13:17 +0000 Subject: [PATCH] See changelog 20000101 21:00 --- harbour/doc/en/array.txt | 250 +++++++++--------- harbour/doc/en/datetime.txt | 492 ++++++++++++++++++++++++++++++++++++ harbour/doc/en/ht_conv.txt | 60 ++--- harbour/doc/en/ht_dbf.txt | 37 +-- harbour/doc/en/ht_doc.txt | 151 ++++++----- harbour/doc/en/ht_str.txt | 16 +- harbour/doc/en/math.txt | 34 ++- harbour/doc/en/menu.txt | 150 ++++++----- harbour/doc/en/rdd.txt | 37 ++- harbour/doc/en/set.txt | 156 +++++++++++- harbour/doc/en/terminal.txt | 11 +- harbour/doc/en/var.txt | 6 +- 12 files changed, 1046 insertions(+), 354 deletions(-) create mode 100644 harbour/doc/en/datetime.txt diff --git a/harbour/doc/en/array.txt b/harbour/doc/en/array.txt index 490d47e68a..cf5079e098 100644 --- a/harbour/doc/en/array.txt +++ b/harbour/doc/en/array.txt @@ -26,28 +26,25 @@ * $SYNTAX$ * ARRAY( [, ...]) --> aArray * $ARGUMENTS$ - * is the number of elements in the specified dimension. + * is the number of elements in the specified dimension. * $RETURNS$ - * an array of specified dimensions. + * an array of specified dimensions. * $DESCRIPTION$ * This function returns an uninitialized array with the length of * . Nested arrays are uninitialized within the same array - * pointer reference if additional parameters are specified. - + * pointer reference if additional parameters are specified. * Establishing a memory variable with the same name as the array may * destroy the original array and release the entire contents of the * array. This depends, of course, on the data storage type of either - * the array or the variable with the same name as the array. - * $EXAMPLES$ - + * the array or the variable with the same name as the array. + * $EXAMPLES$ * FUNCTION Main() * LOCAL aArray:=Array(10) * LOCAL x:=1 * FOR x:=1 to LEN(aArray) * aArray[x]:=Array(x) * NEXT - * Return Nil - + * Return Nil * $STATUS$ * R * $SEEALSO$ @@ -55,7 +52,7 @@ * $COMPLIANCE$ * This function is CA-CLIPPER Compliant in all Cases, except that * arrays in Harbour can have an unlimited number of dimensions, while - * Clipper has a limit of 4096 array elements. + * Clipper has a limit of 4096 array elements. * $END$ */ @@ -69,26 +66,25 @@ * $SYNTAX$ * AADD([, ]) --> Value * $ARGUMENTS$ - * The name of an array - * Element to add to array + * The name of an array + + * Element to add to array * $RETURNS$ * if specified , will return , otherwise this - * function returns a NIL value. + * function returns a NIL value. * $DESCRIPTION$ * This function dynamically increases the length of the array named * by one element and stores the value of to that - * newly created element. + * newly created element. * may be an array reference pointer, which in turn may be - * stored to an array's subscript position. - * $EXAMPLES$ - + * stored to an array's subscript position. + * $EXAMPLES$ * LOCAL aArray:={} * AADD(aArray,10) * FOR x:=1 to 10 * AADD(aArray,x) - * NEXT - + * NEXT * $STATUS$ * R * $SEEALSO$ @@ -106,28 +102,28 @@ * $SYNTAX$ * ASIZE(, ) --> aTarget * $ARGUMENTS$ - * Name of array to be dynamically altered - * Numeric value representing the new size of + * Name of array to be dynamically altered + + * Numeric value representing the new size of * $RETURNS$ - * an array pointer reference to . + * an array pointer reference to . * $DESCRIPTION$ * This function will dynamically increase or decrease the size of * by adjusting the length of the array to subscript - * positions. + * positions. * If the length of the array is shortened, those former * subscript positions are lost. If the length of the array is - * lengthened a NIL value is assigned to the new subscript position. - * $EXAMPLES$ - + * lengthened a NIL value is assigned to the new subscript position. + * $EXAMPLES$ * aArray := { 1 } // Result: aArray is { 1 } * ASIZE(aArray, 3) // Result: aArray is { 1, NIL, NIL } - * ASIZE(aArray, 1) // Result: aArray is { 1 } + * ASIZE(aArray, 1) // Result: aArray is { 1 } * $STATUS$ * R * $COMPLIANCE$ * If HB_COMPAT_C53 is defined, the function generates an Error, - * else it will return the array itself. + * else it will return the array itself. * $SEEALSO$ * AADD(),ADEL(),AFILL(),AINS() * $INCLUDE$ @@ -145,22 +141,20 @@ * $SYNTAX$ * ATAIL() --> Element * $ARGUMENTS$ - * is the array. + * is the array. * $RETURNS$ - * the expression of the last element in the array. + * the expression of the last element in the array. * $DESCRIPTION$ * This function return the value of the last element in the array * named . This function does not alter the size of the - * array or any of the subscript values. - * $EXAMPLES$ - + * array or any of the subscript values. + * $EXAMPLES$ * LOCAL array:= {"Harbour", "is", "Supreme", "Power"} - * ? ATAIL(aArray) - + * ? ATAIL(aArray) * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * LEN(),ARRAY(),ASIZE(),AADD() * $END$ @@ -176,13 +170,14 @@ * $SYNTAX$ * AINS(, ) --> aTarget * $ARGUMENTS$ - * Array name. - * Subscript position in + * Array name. + + * Subscript position in * $RETURNS$ - * an array pointer reference. + * an array pointer reference. * $DESCRIPTION$ * This function inserts a NIL value in the array named - * at the th position. + * at the th position. * All array elements starting with the th position will be * shifted down one subscript position in the array list and the @@ -190,16 +185,14 @@ * 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. - * $EXAMPLES$ - + * will remain unchanged. + * $EXAMPLES$ * LOCAL aArray:={"Harbour","is","Power!","!!!"} - * AINS(aArray,4) - + * AINS(aArray,4) * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * AADD(),ACOPY(),ADEL(),AEVAL(),AFILL(),ASIZE() * $INCLUDE$ @@ -217,10 +210,11 @@ * $SYNTAX$ * ADEL(, ) --> aTarget * $ARGUMENTS$ - * Name of array from which an element is to be removed. - * Subscript of the element to be removed. + * Name of array from which an element is to be removed. + + * Subscript of the element to be removed. * $RETURNS$ - * an array pointer reference. + * an array pointer reference. * $DESCRIPTION$ * This function deletes the element found at subscript position * in the array . All elements in the array below the @@ -228,18 +222,18 @@ * array. In other words, what was formerly the sixth subscript position * will become the fifth subscript position. The length of the array * will remain unchanged,as the last element in the array will - * become a NIL data type. + * become a NIL data type. * $EXAMPLES$ - + * LOCAL aArray * aArray := { "Harbour","is","Power" } // Result: aArray is * * ADEL(aArray, 2) // Result: aArray is - + * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * ACOPY(),AINS(),AFILL() * @@ -256,12 +250,15 @@ * $SYNTAX$ * AFILL(, ,[], []) --> aTarget * $ARGUMENTS$ - * Name of array to be filled. - * Expression to be globally filled in - * Subscript starting position - * Number of subscript to be filled + * Name of array to be filled. + + * Expression to be globally filled in + + * Subscript starting position + + * Number of subscript to be filled * $RETURNS$ - * an array pointer. + * an array pointer. * $DESCRIPTION$ * This function will fill each element of an array named with * the value . If specified, denotes the beginning @@ -269,21 +266,19 @@ * filled for positions. If Not specified, the value of * will be 1, and the value of will be the value * of LEN(); thus, all subscript positions in the array - * will be filled with the value of . + * will be filled with the value of . * This function will work on only a single dimension of . * If there are array pointer references within a subscript , * those values will be lost, since this function will overwrite those - * values with new values. + * values with new values. * $EXAMPLES$ - * LOCAL aTest:={Nil,0,1,2} - * Afill(aTest,5) - + * Afill(aTest,5) * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * AADD(),AEVAL(),DBSTRUCT(),DIRECTORY() * $END$ @@ -299,40 +294,41 @@ * $SYNTAX$ * ASCAN(, ,[], []) --> nStoppedAt * $ARGUMENTS$ - * Name of array to be scanned. - * Expression to search for in - * Beginning subscript position at which to start the search. - * Number of elements to scan with . + * Name of array to be scanned. + + * Expression to search for in + + * Beginning subscript position at which to start the search. + + * Number of elements to scan with . * $RETURNS$ - * A numeric value of subscript position where was found. + * A numeric value of subscript position where was found. * $DESCRIPTION$ * This function scan the content of array named for the * value of . The return value is the position in the array * in which was found. If it was not found, the - * return value will be 0. + * return value will be 0. * If specified, the beginning subscript position at which to start * scanning may be set with the value passed as . The default - * is 1. + * is 1. * If specified, the number of array elements to scan may be set with * the value passed as . The default is the number of elements - * in the array . + * in the array . * If is a code block, the operation of the function is * slightly different. Each array subscript pointer reference is * passed to the code block to be evaluated. The scanning routine * will continue until the value obtained from the code block is a - * logical true (.T.) or until the end of the array has been reached. - * $EXAMPLES$ - + * logical true (.T.) or until the end of the array has been reached. + * $EXAMPLES$ * aDir:=Directory("*.prg") - * AScan(aDir,,,{|x,y| x[1]="Test.prg"}) - + * AScan(aDir,,,{|x,y| x[1]="Test.prg"}) * $STATUS$ * R * $COMPLIANCE$ - * This function is not CA-Clipper compatible. Clipper ASCAN() is affected by the SET EXACT ON/OFF Condition + * This function is not CA-Clipper compatible. Clipper ASCAN() is affected by the SET EXACT ON/OFF Condition * $SEEALSO$ * AEVAL() * $END$ @@ -348,31 +344,34 @@ * $SYNTAX$ * AEVAL(, , [], []) --> aArray * $ARGUMENTS$ - * Is the array to be evaluated. - * Is a code block to evaluate for each element processed. - * The beginning array element to evaluate. - * The number of elements to process. + * Is the array to be evaluated. + + * Is a code block to evaluate for each element processed. + + * The beginning array element to evaluate. + + * The number of elements to process. * $RETURNS$ - * an array pointer reference. + * an array pointer reference. * $DESCRIPTION$ * This function will evaluate and process the subscript elements * in . A code block passed as defines the operation * to be executed on each element of the array. All elements in * will be evaluated unless specified by a beginning subscript position - * in for elements. + * in for elements. * Two parameters are passed to the code block . The individual * elements in an array are the first parameter and the subscript position - * is the second. + * is the second. * AEVAL() does not replace a FOR...NEXT loop for processing arrays. If * an array is an autonomous unit, AEVAL() is appropriate. If the array * is to be altered or if elements are to be reevaluated, a FOR...NEXT - * loop is more appropriate. + * loop is more appropriate. * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * EVAL(),DBEVAL() * $END$ @@ -388,48 +387,50 @@ * $SYNTAX$ * ACOPY(, , [], [], []) --> aTarget * $ARGUMENTS$ - * is the array to copy elements from. - * is the array to copy elements to. - * is the beginning subscript position to copy from - * the number of subscript elements to copy from . - * the starting subscript position in to copy elements to. + * is the array to copy elements from. + + * is the array to copy elements to. + + * is the beginning subscript position to copy from + + * the number of subscript elements to copy from . + + * the starting subscript position in to copy elements to. * $RETURNS$ - * an array pointer reference + * an array pointer reference * $DESCRIPTION$ * This function copies array elements from to . * is the beginning element to be copied from ; - * the default is 1. + * the default is 1. * is the number of elements to be copied from ; - * the default is the entire array. + * the default is the entire array. * is the subscript number in the target array,, - * to which array elements are to be copied; the default is 1 + * to which array elements are to be copied; the default is 1 - * This function will copy all data types in to . + * This function will copy all data types in to . * If an array element in is a pointer reference to another * array, that array pointer will be copied to ; not all * subdimensions will be copied from one array to the next. This must - * be accomplished via the ACLONE() function. + * be accomplished via the ACLONE() function. - * Note + * Note * If array is larger then , array elements will * start copying at and continue copying until the end * of array is reached. The ACOPY() function doesn't append * subscript positions to the target array, the size of the target - * array remains constant. - * $EXAMPLES$ - + * array remains constant. + * $EXAMPLES$ * LOCAL nCount := 2, nStart := 1, aOne, aTwo * aOne := {"HABOUR"," is ","POWER"} * aTwo := {"CLIPPER"," was ","POWER"} - * ACOPY(aOne, aTwo, nStart, nCount) - + * ACOPY(aOne, aTwo, nStart, nCount) * $STATUS$ * R * $COMPLIANCE$ - * This function is CA Clipper compliant + * This function is CA Clipper compliant * $SEEALSO$ * ACLONE(),ADEL(),AEVAL(),AFILL(),AINS(),ASORT() * $END$ @@ -445,27 +446,25 @@ * $SYNTAX$ * ACLONE() --> aDuplicate * $ARGUMENTS$ - * Name of the array to be cloned. + * Name of the array to be cloned. * $RETURNS$ * A new array pointer reference complete with nested - * array values. + * array values. * $DESCRIPTION$ * This function makes a complete copy of the array expressed as * and return a cloned set of array values.This provides * a complete set of arrays values for all dimensions within the - * original array - * $EXAMPLES$ - + * original array + * $EXAMPLES$ * LOCAL aOne, aTwo * aOne := {"Harbour"," is ","POWER"} * aTwo := ACLONE(aOne) // Result: aTwo is {1, 2, 3} * aOne[1] := "The Harbour Compiler" // Result: aOne is {99, 2, 3} - * // aTwo is still {1, 2, 3} - + * // aTwo is still {1, 2, 3} * $STATUS$ * R * $COMPLIANCE$ - * Clipper will return NIL if the parameter is not an array. + * Clipper will return NIL if the parameter is not an array. * $SEEALSO$ * ACOPY(),ADEL(),AINS(),ASIZE() * $END$ @@ -481,23 +480,26 @@ * $SYNTAX$ * ASORT( , [], [], [] ) --> aArray * $ARGUMENTS$ - * Array to be sorted. - * The first element to start the sort from, default is 1. + * Array to be sorted. + + * The first element to start the sort from, default is 1. + * Number of elements starting from to sort, default - * is all elements. + * is all elements. + * Code block for sorting order, default is ascending order * {| x, y | x < y }. The code block should accept two parameters and - * must return .T. if the sort is in order, .F. if not. + * must return .T. if the sort is in order, .F. if not. * $RETURNS$ * reference to the now sorted or NIL if the - * passed is not an array. + * passed is not an array. * $DESCRIPTION$ * ASORT() sort all or part of a given array. If is omitted, * the function expect to be one dimensional array containing * single data type (one of: Character, Date, Logical, Numeric) and sort * this array in ascending order: Character are sorted by their ASCII * value, Dates are sorted chronologically, Logical put .F. values before - * .T., Numeric are sorted by their value. + * .T., Numeric are sorted by their value. * If is specified, it is used to handle the sorting order. With * each time the block is evaluate, two array elements are passed to the @@ -505,9 +507,8 @@ * those elements are in order (.T.) or not (.F.). Using this block you * can sort multidimensional array, descending orders or even (but why * would you want to do that) sort array that contain different data - * type. - * $EXAMPLES$ - * + * type. + * $EXAMPLES$ * // sort numeric values in ascending order * ASORT( { 3, 1, 4, 42, 5, 9 } ) // result: { 1, 3, 4, 5, 9, 42 } * @@ -519,8 +520,7 @@ * // sort two-dimensional array according to 2nd element of each pair * aPair := { {"Sun",8}, {"Mon",1}, {"Tue",57}, {"Wed",-6} } * ASORT( aPair,,, {| x, y | x[2] < y[2] } ) - * // result: { {"Wed",-6}, {"Mon",1}, {"Sun",8}, {"Tue",57} } - * + * // result: { {"Wed",-6}, {"Mon",1}, {"Sun",8}, {"Tue",57} } * $STATUS$ * R * $COMPLIANCE$ @@ -528,7 +528,7 @@ * This will result in a small incompatibility since the code block * will be called one more time for the first logical element than * in Clipper. But this is block calling frequency and order differs - * from Clipper anyway, since they use different sorting algorithm. + * from Clipper anyway, since they use different sorting algorithm. * $SEEALSO$ * ASCAN(),EVAL(),SORT * $END$ diff --git a/harbour/doc/en/datetime.txt b/harbour/doc/en/datetime.txt new file mode 100644 index 0000000000..c927aac232 --- /dev/null +++ b/harbour/doc/en/datetime.txt @@ -0,0 +1,492 @@ +/* + * $Id$ + */ + + +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 2000 Luiz Rafael Culik + * Documentation for: CDOW(),CMONTH(),DATE(),CTOD(),DAY(),DAYS() + * DOW(),DTOS(),DTOC(),ELAPTIME(),MONTH(),SECONDS(),SECS(),TIME(),YEAR() + * See doc/license.txt for licensing terms. + * + */ + +/* $DOC$ + * $FUNCNAME$ + * CDOW() + * $CATEGORY$ + * Date + * $ONELINER$ + * Converts a date to the day of week + * $SYNTAX$ + * CDOW() --> cDay + * $ARGUMENTS$ + * Any date expression. + * $RETURNS$ + * The current day of week. + * $DESCRIPTION$ + * This function returns a character string of the day of the week, + * from a date expression passed to it. + * If a NULL date is passed to the function, the value of the function + * will be a NULL byte. + * $EXAMPLES$ + * ? CDOW(DATE()) + * if CDOW(DATE()+10) =="SUNDAY" + * ? "This is a sunny day." + * Endif + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant. + * $PLATFORMS$ + * All + * $SEEALSO$ + * DAY(),DOW(),DATE(),CMONTH() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * CMONTH() + * $CATEGORY$ + * Date + * $ONELINER$ + * Return the name of the month. + * $SYNTAX$ + * CMONTH() --> cMonth + * $ARGUMENTS$ + * Any date expression. + * $RETURNS$ + * The current month name + * $DESCRIPTION$ + * This function returns the name of the month (January,February,etc.) + * from a date expression passed to it. + * If a NULL date is passed to the function, the value of the function + * will be a NULL byte. + * $EXAMPLES$ + * ? CMONTH(DATE()) + * if CMONTH(DATE()+10) =="March" + * ? "Have you done your system BACKUP?" + * Endif + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * CDOW(),DATE(),MONTH(),YEAR(),DOW(),DTOC() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * DATE() + * $CATEGORY$ + * Date + * $ONELINER$ + * Return the Current OS Date + * $SYNTAX$ + * DATE() --> dCurDate + * $ARGUMENTS$ + * None + * $RETURNS$ + * Current system date. + * $DESCRIPTION$ + * This function returns the current system date. + * $EXAMPLES$ + * ? Date() + * $TESTS$ + * ? "Today is ",Day(date())," of ",cMonth(date())," of ",Year(date()) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper Compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * CTOD(),DTOS(),DTOC(),DAY(),MONTH(),CMONTH() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * CTOD() + * $CATEGORY$ + * Date + * $ONELINER$ + * Converts a character string to a date expression + * $SYNTAX$ + * CTOD() --> dDate + * $ARGUMENTS$ + * A character date in format 'mm/dd/yy' + * $RETURNS$ + * A date expression + * $DESCRIPTION$ + * This function converts a date that has been entered as a character + * expression to a date expression.The character expression will be in + * the form "MM/DD/YY" (based on the default value in SET DATE) or in + * the appropriate format specified by the SET DATE TO command. If an + * improper character string is passed to the function,an empty date + * value will be returned. + * $EXAMPLES$ + * ? CTOD('12/21/00') + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * SET DATE,DATE(),DTOS() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * DAY() + * $CATEGORY$ + * Date + * $ONELINER$ + * Return the numeric day of th month. + * $SYNTAX$ + * DAY() --> nMonth + * $ARGUMENTS$ + * Any valid date expression. + * $RETURNS$ + * Numeric value of the day of month. + * $DESCRIPTION$ + * This function returns the numeric value of the day of month from a + * date. + * $EXAMPLES$ + * ? Day(DATE()) + * ? Day(DATE()+6325) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * CTOD(),DTOS(),DTOC(),DATE(),MONTH(),CMONTH() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * DAYS() + * $CATEGORY$ + * Date + * $ONELINER$ + * Convert elapsed seconds into days + * $SYNTAX$ + * DAYS( ) --> nDay + * $ARGUMENTS$ + * The number of seconds + * $RETURNS$ + * The number of days + * $DESCRIPTION$ + * This function converst seconds to the equivalent number + * of days;86399 seconds represent one day,0 seconds being midnight. + * $EXAMPLES$ + * ? DAYS(2434234) + * ? "Has been passed ",DAYS(63251),' since midnight' + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * SECONDS(),SECS(),ELAPTIME() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * DOW() + * $CATEGORY$ + * Date + * $ONELINER$ + * Value for the day of week. + * $SYNTAX$ + * DOW() --> nDay + * $ARGUMENTS$ + * Any valid date expression + * $RETURNS$ + * The current day number + * $DESCRIPTION$ + * This function returns the number representing the day of the week + * for the date expressed as . + * $EXAMPLES$ + * ? DOW(DATE()) + * ? DOW(DATE()-6584) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * DTOC(),CDOW(),DATE(),DTOS(),DAY() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * DTOC() + * $CATEGORY$ + * Date + * $ONELINER$ + * Date to character conversion + * $SYNTAX$ + * DTOC() --> cDate + * $ARGUMENTS$ + * Any date + * $RETURNS$ + * Character represention of date + * $DESCRIPTION$ + * This function converts any date expression (a field or variable ) + * expressed as to a character expression in the default + * format "MM/DD/YY".The date format is expressed by this function is + * controled in part by the date format specified in the SET DATE + * command + * $EXAMPLES$ + * ? DTOC(Date()) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * SET DATE,DATE(),DTOS() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * DTOS() + * $CATEGORY$ + * Date + * $ONELINER$ + * Date to string conversion + * $SYNTAX$ + * DTOS() --> cDate + * $ARGUMENTS$ + * Any date + * $RETURNS$ + * String notation of the date + * $DESCRIPTION$ + * This function returns the value of as a character + * string in the format of YYYYMMDD.If the value of is + * an empty date , this function will returbn eight blank spaces. + * $EXAMPLES$ + * ? DTOS(Date()) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * DTOC(),DATE(),DTOS() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ELAPTIME() + * $CATEGORY$ + * Time + * $ONELINER$ + * Calculates elapted time. + * $SYNTAX$ + * ELAPTIME(,) --> cDiference + * $ARGUMENTS$ + * Start in time as a string format + * End time as a string format + * $RETURNS$ + * Difference between the times + * $DESCRIPTION$ + * This function returns a string that shows the difference between + * the starting time represented as and the ending time + * as . If the stating time is greater then the ending + * time,the function will assume that the date changed once. + * $EXAMPLES$ + * Static cStartTime + * Init Proc Startup + * cStartTime:=Time() + * + * Exit Proc StartExit + * ? "You used this program by",ELAPTIME(cStartTime,Time()) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * SECS(),SECONDS(),TIME(),DAY() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * MONTH() + * $CATEGORY$ + * Date + * $ONELINER$ + * Converts a date expression to a month value + * $SYNTAX$ + * MONTH() --> nMonth + * $ARGUMENTS$ + * Any valid date expression + * $RETURNS$ + * Corresponding number of the month in the year, ranging from + * 0 to 12 + * $DESCRIPTION$ + * This function returns a number that representate the month of given + * date expression . If a NULL date (CTOD('')) is passed to the + * function, the value of the function will be 0. + * $EXAMPLES$ + * ? Month(DATE()) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * CDOW(),DOW(),YEAR(),CMONTH() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SECONDS() + * $CATEGORY$ + * Time + * $ONELINER$ + * Returns the number of elapsed seconds past midnight. + * $SYNTAX$ + * SECONDS() --> nSeconds + * $ARGUMENTS$ + * None + * $RETURNS$ + * Number of seconds since midnight + * $DESCRIPTION$ + * This function returns a numeric value representing the number of + * elapsed seconds based on the current system time. + * The system time is considered to start at 0 (midnight);it continues + * up to 86399 seconds.The value of the return expression is displayed + * in both seconds and hundredths of seconds. + * $EXAMPLES$ + * ? Seconds() + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * TIME() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SECS() + * $CATEGORY$ + * Time + * $ONELINER$ + * Return the number of seconds from the system date. + * $SYNTAX$ + * SECS( ) --> nSeconds + * $ARGUMENTS$ + * Character expression in a time string format + * $RETURNS$ + * Number of seconds + * $DESCRIPTION$ + * This function returns a numeric value that is a number of elapsed + * seconds from midnight base on a time string given as . + * $EXAMPLES$ + * ? Secs(Time()) + * ? Secs(time()-10) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * SECONDS(),ELAPTIME(),TIME() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * TIME() + * $CATEGORY$ + * Time + * $ONELINER$ + * Returns the system time as a string + * $SYNTAX$ + * TIME() --> cTime + * $ARGUMENTS$ + * None + * $RETURNS$ + * Character string representing time + * $DESCRIPTION$ + * This function returns the system time represented as a character + * expression in the format of HH:MM:SS + * $EXAMPLES$ + * ? Time() + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * DATE(),SECONDS() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * YEAR() + * $CATEGORY$ + * Date + * $ONELINER$ + * Converts the year portion of a date into a numeric value + * $SYNTAX$ + * YEAR() --> nYear + * $ARGUMENTS$ + * Any valid date expression + * $RETURNS$ + * The year portion of the date. + * $DESCRIPTION$ + * This function returns the numeric value for the year in . + * This value will always be a four-digit number and is not affected + * by the setting of the SET CENTURY and SET DATE commands. Addition + * ally, an empty date expression passed to this function will yield + * a zero value. + * + * $EXAMPLES$ + * ? Year(date()) + * ? year(CTOD("01/25/3251")) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant + * $PLATFORMS$ + * All + * $SEEALSO$ + * DAY(),MONTH() + * $END$ + */ + diff --git a/harbour/doc/en/ht_conv.txt b/harbour/doc/en/ht_conv.txt index fd4a3c6cae..27bca39356 100644 --- a/harbour/doc/en/ht_conv.txt +++ b/harbour/doc/en/ht_conv.txt @@ -23,11 +23,11 @@ * $SYNTAX$ * ISBIN() -> * $ARGUMENTS$ - * STRING TO BE CHECKED + * STRING TO BE CHECKED * $RETURNS$ - * .T. IF THE STRING IS BYNARY,otherwise .F. + * .T. IF THE STRING IS BYNARY,otherwise .F. * $DESCRIPTION$ - * check if the passed string is a bynary number or not + * check if the passed string is a bynary number or not * $SEEALSO$ * ISOCTAL(),ISDEC(),ISHEXA() * $INCLUDE$ @@ -45,11 +45,11 @@ * $SYNTAX$ * ISOCTAL() -> * $ARGUMENTS$ - * STRING TO BE CHECKED + * STRING TO BE CHECKED * $RETURNS$ - * .T. IF THE STRING IS OCTAL;otherwise .F. + * .T. IF THE STRING IS OCTAL;otherwise .F. * $DESCRIPTION$ - * check if the passed string is a octal number or not + * check if the passed string is a octal number or not * $SEEALSO$ * ISBIN(),ISDEC(),ISHEXA() * $INCLUDE$ @@ -67,11 +67,11 @@ * $SYNTAX$ * ISDEC() -> * $ARGUMENTS$ - * STRING TO BE CHECKED + * STRING TO BE CHECKED * $RETURNS$ - * .T. IF THE STRING IS DECIMAL;otherwise .F. + * .T. IF THE STRING IS DECIMAL;otherwise .F. * $DESCRIPTION$ - * check if the passed string is a decimal number or not + * check if the passed string is a decimal number or not * $SEEALSO$ * ISOCTAL(),ISBIN(),ISHEXA() * $INCLUDE$ @@ -89,11 +89,11 @@ * $SYNTAX$ * ISHEXA() -> * $ARGUMENTS$ - * STRING TO BE CHECKED + * STRING TO BE CHECKED * $RETURNS$ - * .T. IF THE STRING IS HEXA;otherwise .F. + * .T. IF THE STRING IS HEXA;otherwise .F. * $DESCRIPTION$ - * check if the passed string is a hexa number or not + * check if the passed string is a hexa number or not * $SEEALSO$ * ISOCTAL(),ISDEC(),ISBIN() * $INCLUDE$ @@ -111,12 +111,12 @@ * $SYNTAX$ * DECTOBIN() -> * $ARGUMENTS$ - * NUMBER TO BE CONVERTED + * NUMBER TO BE CONVERTED * $RETURNS$ - * NUMBER CONVERTED + * NUMBER CONVERTED * $DESCRIPTION$ * This function converts a string from an decimal value - * to an binary value. + * to an binary value. * $SEEALSO$ * Dectohexa(),dectooctal() * $INCLUDE$ @@ -134,12 +134,12 @@ * $SYNTAX$ * DECTOOCTAL() -> * $ARGUMENTS$ - * NUMBER TO BE CONVERTED + * NUMBER TO BE CONVERTED * $RETURNS$ - * NUMBER CONVERTED + * NUMBER CONVERTED * $DESCRIPTION$ * This function converts a string from an decimal value - * to an octal value. + * to an octal value. * $SEEALSO$ * Dectohexa(),dectobin() * $INCLUDE$ @@ -157,12 +157,12 @@ * $SYNTAX$ * DECTOHEXA() -> * $ARGUMENTS$ - * NUMBER TO BE CONVERTED + * NUMBER TO BE CONVERTED * $RETURNS$ - * NUMBER CONVERTED + * NUMBER CONVERTED * $DESCRIPTION$ * This function converts a string from an decimal value - * to an hexadecimal value. + * to an hexadecimal value. * $SEEALSO$ * Dectobin(),dectooctal() * $INCLUDE$ @@ -180,12 +180,12 @@ * $SYNTAX$ * BIntODEC() -> * $ARGUMENTS$ - * NUMBER TO BE CONVERTED + * NUMBER TO BE CONVERTED * $RETURNS$ - * NUMBER CONVERTED + * NUMBER CONVERTED * $DESCRIPTION$ * This function converts a string from an binary value - * to a numeric decimal value. + * to a numeric decimal value. * $SEEALSO$ * OctaltoDec(),HexatoDec() * $INCLUDE$ @@ -203,12 +203,12 @@ * $SYNTAX$ * OCTALTODEC() -> * $ARGUMENTS$ - * NUMBER TO BE CONVERTED + * NUMBER TO BE CONVERTED * $RETURNS$ - * NUMBER CONVERTED + * NUMBER CONVERTED * $DESCRIPTION$ * This function converts a string from an octal value - * to a numeric decimal value. + * to a numeric decimal value. * $SEEALSO$ * BintoDec(),HexatoDec() * $INCLUDE$ @@ -226,12 +226,12 @@ * $SYNTAX$ * HEXATODEC() -> * $ARGUMENTS$ - * NUMBER TO BE CONVERTED + * NUMBER TO BE CONVERTED * $RETURNS$ - * NUMBER CONVERTED + * NUMBER CONVERTED * $DESCRIPTION$ * This function converts a string from an hexadecimal value - * to a numeric decimal value. + * to a numeric decimal value. * $SEEALSO$ * OctaltoDec(),BintoDec() * $INCLUDE$ diff --git a/harbour/doc/en/ht_dbf.txt b/harbour/doc/en/ht_dbf.txt index 742e72d4d5..62f751b8bc 100644 --- a/harbour/doc/en/ht_dbf.txt +++ b/harbour/doc/en/ht_dbf.txt @@ -25,16 +25,16 @@ * $SYNTAX$ * FIELDTYPE() --> cFieldType * $ARGUMENTS$ - * Data field , which type need to be determined. + * Data field , which type need to be determined. * $RETURNS$ - * FIELDTYPE() returns the character that designates the type of a given field: - * 'C' - character string; - * 'N' - numeric; - * 'L' - logical; - * 'D' - date; - * 'M' - memo. + * FIELDTYPE() returns the character that designates the type of a given field: + * 'C' - character string; + * 'N' - numeric; + * 'L' - logical; + * 'D' - date; + * 'M' - memo. * $DESCRIPTION$ - * This function determines the type of a field, designated by its number. + * This function determines the type of a field, designated by its number. * $EXAMPLES$ * FUNCTION Main() * LOCAL i @@ -44,10 +44,11 @@ * NEXT * USE * RETURN NIL + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-CLIPPER TOOLS compatible + * This function is CA-CLIPPER TOOLS compatible * $SEEALSO$ * FIELDSIZE(),FIELDDECI() * $END$ @@ -63,11 +64,11 @@ * $SYNTAX$ * FIELDSIZE() --> nFieldSize * $ARGUMENTS$ - * Data field , which size need to be determined. + * Data field , which size need to be determined. * $RETURNS$ - * FIELDSIZE() returns the number that designates the size of a given field. + * FIELDSIZE() returns the number that designates the size of a given field. * $DESCRIPTION$ - * This function determines the size of a field, designated by its number. + * This function determines the size of a field, designated by its number. * $EXAMPLES$ * FUNCTION Main() * LOCAL i @@ -77,10 +78,11 @@ * NEXT * USE * RETURN NIL + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-CLIPPER TOOLS compatible + * This function is CA-CLIPPER TOOLS compatible * $SEEALSO$ * FIELDTYPE(),FIELDDECI() * $END$ @@ -97,12 +99,12 @@ * FIELDDECI() --> nFieldDeci * $ARGUMENTS$ * Numeric data field , for which number of decimal - * places need to be determined. + * places need to be determined. * $RETURNS$ * FIELDDECI() returns the numeric value that designates the number - * of decimal places of a given field. + * of decimal places of a given field. * $DESCRIPTION$ - * This function determines the number of decimal places of a given numeric field. + * This function determines the number of decimal places of a given numeric field. * $EXAMPLES$ * FUNCTION Main() * LOCAL i @@ -112,10 +114,11 @@ * NEXT * USE * RETURN NIL + * * $STATUS$ * R * $COMPLIANCE$ - * This function is CA-CLIPPER TOOLS compatible + * This function is CA-CLIPPER TOOLS compatible * $SEEALSO$ * FIELDTYPE(),FIELDSIZE() * $END$ diff --git a/harbour/doc/en/ht_doc.txt b/harbour/doc/en/ht_doc.txt index 674968623a..a73b9a3308 100644 --- a/harbour/doc/en/ht_doc.txt +++ b/harbour/doc/en/ht_doc.txt @@ -21,22 +21,22 @@ * $ONELINER$ * Html Class * $SYNTAX$ - * oHtml:=THtml():New() + * oHtml:=THtml():New() --> oHtm * $ARGUMENTS$ - * Name of the Html file to create + * Name of the Html file to create * $RETURNS$ - * An instance of the THtml Class + * An instance of the THtml Class * $DESCRIPTION$ * THtml() is a class that creates an .html file of the same - * name you pass to the constructor. - * The class methods are as follows: - * New() Create a new instance of the THtml class - * Close() Close the created file - * WriteTitle() Write the file title - * WritePar() Writes a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink(,) Write a link to another topic - * WriteText() Write any text + * name you pass to the constructor. + * The class methods are as follows: + * New() Create a new instance of the THtml class + * Close() Close the created file + * WriteTitle() Write the file title + * WritePar() Writes a paragraph + * WriteParBold() Same as WritePar(), but the text is bold + * WriteLink(,) Write a link to another topic + * WriteText() Write any text * $EXAMPLES$ * FUNCTION MAIN() * @@ -51,13 +51,13 @@ * oHtm:WritePar( "See the Links Above" ) * oHtm:Close() * RETURN Nil - * + * * $STATUS$ * R * $COMPLIANCE$ - * This is a new Harbour Tools class + * This is a new Harbour Tools class * $PLATFORMS$ - * ALL + * ALL * $SEEALSO$ * TCLASS() * $END$ @@ -71,23 +71,23 @@ * $ONELINER$ * OS/2 Documentation Class * $SYNTAX$ - * oNg:=TOs2():New() + * oNg:=TOs2():New() --> oOs2 * $ARGUMENTS$ - * Name of the IPF Source file to create + * Name of the IPF Source file to create * $RETURNS$ - * An instance of the TOs2 Class + * An instance of the TOs2 Class * $DESCRIPTION$ * TOs2() is a class that creates the OS/2 IPF Source - * of the same name you pass to the constructor. - * The class methods are as follows: - * New() Create a new instance of the TOs2 class - * Close() Close the created file - * WriteTitle(,) Write the file title - * WritePar() Write a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink() Write a link to another topic - * ScanLink() Scan the aLinkRef array for a valid topic - * DosToOs2Text() Convert a Dos string to a OS/2 String + * of the same name you pass to the constructor. + * The class methods are as follows: + * New() Create a new instance of the TOs2 class + * Close() Close the created file + * WriteTitle(,) Write the file title + * WritePar() Write a paragraph + * WriteParBold() Same as WritePar(), but the text is bold + * WriteLink() Write a link to another topic + * ScanLink() Scan the aLinkRef array for a valid topic + * DosToOs2Text() Convert a Dos string to a OS/2 String * $EXAMPLES$ * FUNCTION MAIN() * @@ -102,15 +102,13 @@ * oNg:WritePar( "See the Links Above" ) * oNg:Close() * RETURN Nil - * + * * $STATUS$ * R * $COMPLIANCE$ - * This is a new Harbour Tools class + * This is a new Harbour Tools class * $PLATFORMS$ - * ALL - * $FILES$ - * + * ALL * $SEEALSO$ * TNortonGuide() * $END$ @@ -124,21 +122,21 @@ * $ONELINER$ * Norton Guide Class * $SYNTAX$ - * oNg:=TNortonGuide():New() + * oNg:=TNortonGuide():New() --> oNg * $ARGUMENTS$ - * Name of the Ng Source file to create + * Name of the Ng Source file to create * $RETURNS$ - * An instance of the TNortonGuide Class + * An instance of the TNortonGuide Class * $DESCRIPTION$ * TNortonGuide() is a class that creates the Norton Guide Source - * Code of the same name you pass to the constructor. - * The class methods are as follows: - * New() Create an instance of the TNortonGuide class - * Close() Close the created file - * WriteTitle(,) Write the file title - * WritePar() Write a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink() Write a link to another topic + * Code of the same name you pass to the constructor. + * The class methods are as follows: + * New() Create an instance of the TNortonGuide class + * Close() Close the created file + * WriteTitle(,) Write the file title + * WritePar() Write a paragraph + * WriteParBold() Same as WritePar(), but the text is bold + * WriteLink() Write a link to another topic * $EXAMPLES$ * FUNCTION MAIN() * @@ -153,12 +151,13 @@ * oNg:WritePar( "See the Links Above" ) * oNg:Close() * RETURN Nil + * * $STATUS$ * R * $COMPLIANCE$ - * This is a new Harbour Tools class + * This is a new Harbour Tools class * $PLATFORMS$ - * ALL + * ALL * $SEEALSO$ * TTroff(),TRtf(),THtml(),TOs2() * $END$ @@ -172,23 +171,23 @@ * $ONELINER$ * Rtf Class * $SYNTAX$ - * oNg:=TRtf():New() + * oNg:=TRtf():New() --> oRtf * $ARGUMENTS$ - * Name of the RTF file to create + * Name of the RTF file to create * $RETURNS$ - * An instance of the TRtf Class + * An instance of the TRtf Class * $DESCRIPTION$ * TRtf() is a class that creates the RTF Documentation Source - * Code of the same name you pass to the constructor. - * The class methods are as follows: - * New() Create a new instance of the TRtf class - * Close() Close the create file - * WriteTitle(,) Write the file title - * WritePar() Write a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink() Write a link to another topic - * WriteHeader() Write the RTF header - * EndPar() Write the end paragraph delimiter + * Code of the same name you pass to the constructor. + * The class methods are as follows: + * New() Create a new instance of the TRtf class + * Close() Close the create file + * WriteTitle(,) Write the file title + * WritePar() Write a paragraph + * WriteParBold() Same as WritePar(), but the text is bold + * WriteLink() Write a link to another topic + * WriteHeader() Write the RTF header + * EndPar() Write the end paragraph delimiter * $EXAMPLES$ * FUNCTION MAIN() * @@ -204,13 +203,13 @@ * oRtf:WritePar( "See the Links Above" ):EndPar() * oRtf:Close() * RETURN Nil - * + * * $STATUS$ * R * $COMPLIANCE$ - * This is a new Harbour Tools class + * This is a new Harbour Tools class * $PLATFORMS$ - * ALL + * ALL * $SEEALSO$ * TNortonGuide() * $END$ @@ -224,22 +223,22 @@ * $ONELINER$ * Troff Class * $SYNTAX$ - * oTroff:=TTrof():New() + * oTroff:=TTrof():New() --> oTrf * $ARGUMENTS$ - * Name of the Troff file to create + * Name of the Troff file to create * $RETURNS$ - * An instance of the TTroff Class + * instance of the TTroff Class * $DESCRIPTION$ * TTroff() is a class that creates the TROFF Documentation Source - * Code of the same name you pass to the constructor. - * The class methods are as follows: + * Code of the same name you pass to the constructor. + * The class methods are as follows: * New() Create a new instance of the THtml class - * Close() Close the created file - * WriteTitle(,) Write the file title - * WritePar() Write a paragraph - * WriteParBold() Same as WritePar(), but the text is bold - * WriteLink() Write a link to another topic - * WriteText() Writes text without formating + * Close() Close the created file + * WriteTitle(,) Write the file title + * WritePar() Write a paragraph + * WriteParBold() Same as WritePar(), but the text is bold + * WriteLink() Write a link to another topic + * WriteText() Writes text without formating * $EXAMPLES$ * FUNCTION MAIN() * @@ -254,13 +253,13 @@ * oTroff:Close() * * RETURN Nil - * + * * $STATUS$ * R * $COMPLIANCE$ - * This is a new Harbour Tools class + * This is a new Harbour Tools class * $PLATFORMS$ - * ALL + * ALL * $SEEALSO$ * TNortonGuide() * $END$ diff --git a/harbour/doc/en/ht_str.txt b/harbour/doc/en/ht_str.txt index 2dd447a1c0..f2248b3373 100644 --- a/harbour/doc/en/ht_str.txt +++ b/harbour/doc/en/ht_str.txt @@ -23,22 +23,23 @@ * $SYNTAX$ * StrFormat([, [, [, ...]]) --> cString * $ARGUMENTS$ - * Holds the mask for the resulting string + * Holds the mask for the resulting string * Holds the strings to be inserted in the mask - * maximum 9 of them can be specified. + * maximum 9 of them can be specified. * $RETURNS$ - * Return the mask with all the parameters inserted. + * Return the mask with all the parameters inserted. * $DESCRIPTION$ * String replacment, can be useful when writing international * apps. You can separate the constant strings from the variable ones. * Each %1 - %9 marks will be replaced with the appropriate parameter - * from the parameter list. - * Marks can be in any order, and can be duplicated. - * You can print "%" character with "%%". + * from the parameter list. + * Marks can be in any order, and can be duplicated. + * You can print "%" character with "%%". * $EXAMPLES$ * StrFormat("Please insert disk %1 to drive %2", LTrim(Str(2)), "A:") * StrFormat("This is %1 from %2", "Victor", "Hungary") * StrFormat("%2 %1 %2", "Param1", "Param2") + * * $TESTS$ * ? StrFormat("Please insert disk %1 to drive %2", LTrim(Str(2)), "A:") * ? StrFormat("This is %1 from %2", "Victor", "Hungary") @@ -50,10 +51,11 @@ * ? StrFormat("%2 - %", "one", "two") * ? StrFormat("%% - %", "one", "two") * ? StrFormat("%9 - %", "one", "two") + * * $STATUS$ * Done * $COMPLIANCE$ - * All platforms + * All platforms * $END$ */ diff --git a/harbour/doc/en/math.txt b/harbour/doc/en/math.txt index 847f978786..43373c9661 100644 --- a/harbour/doc/en/math.txt +++ b/harbour/doc/en/math.txt @@ -8,7 +8,7 @@ * * Copyright 2000 Luiz Rafael Culik * Documentation for: ABS(),EXP(),LOG(),INT(),MAX() - * MIN() + * MIN(),SQRT() * See doc/license.txt for licensing terms. * */ @@ -251,3 +251,35 @@ * % * $END$ */ + +/* $DOC$ + * $FUNCNAME$ + * SQRT() + * $CATEGORY$ + * Math + * $ONELINER$ + * Calculates the square root of a number + * $SYNTAX$ + * SQRT( ) --> + * $ARGUMENTS$ + * Any numeric value + * $RETURNS$ + * Square root of + * $DESCRIPTION$ + * This function returns the square rot of . The precsion of + * this evaluation is based solly on the settings of the SET DECIMAL TO + * command.Any negative number passed as will always return a 0. + * $EXAMPLES$ + * SET Decimal to 5 + * ? SQRT(632512.62541) + * ? SQRT(845414111.91440) + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is CA-Clipper compliant. + * $PLATFORMS$ + * All + * $SEEALSO$ + * ROUND() + * $END$ + */ diff --git a/harbour/doc/en/menu.txt b/harbour/doc/en/menu.txt index bd053ef2df..35d877bd79 100644 --- a/harbour/doc/en/menu.txt +++ b/harbour/doc/en/menu.txt @@ -21,55 +21,49 @@ * $ONELINER$ * Allows selection of an element from an array * $SYNTAX$ - * ACHOICE(, , , , - * , - * [ | ], - * [ | ], - * [], - * []) --> nPosition - * + * ACHOICE(, , , , , [ | ], [ | ], [], []) --> nPosition * $ARGUMENTS$ - * - topmost row used to display array (default 0) - * - leftmost row used to display array (default 0) - * - bottommost row used to display array (default MAXROW()) - * - rightmost row used to display array (default MAXCOL()) - * - the character array of items from which to select + * - topmost row used to display array (default 0) + * - leftmost row used to display array (default 0) + * - bottommost row used to display array (default MAXROW()) + * - rightmost row used to display array (default MAXCOL()) + * - the character array of items from which to select * - an array of items, either logical or character, * which is used to determine if a particular item * may be selected. If the type of a given item is * character, it is macro evaluated, and the result * is expected to be a logical. A value of .T. means * that the item may be selected, .F. that it may not. - * (See next argument: lSelectableItems) + * (See next argument: lSelectableItems) * - a logical value which is used to apply to all * items in acMenuItems. If .T., all items may be * selected; if .F., none may be selected. * (See previous argument: alSelectableItems) - * Default .T. + * Default .T. * - the name of a function to be called which may * affect special processing of keystrokes. It is * specified without parentheses or parameters. * When it is called, it will be supplied with the * parameters: nMode, nCurElement, and nRowPos. - * Default NIL. + * Default NIL. * - a codeblock to be called which may * affect special processing of keystrokes. It * should be specified in the form * {|nMode, nCurElemenet, nRowPos| ; * MyFunc(nMode, nCurElemenet, nRowPos) }. - * Default NIL. + * Default NIL. * - the number of the element to be highlighted as * the current item when the array is initially - * displayed. 1 origin. Default 1. + * displayed. 1 origin. Default 1. * - the number of the window row on which the initial - * item is to be displayed. 0 origin. Default 0. + * item is to be displayed. 0 origin. Default 0. * $RETURNS$ - * - the number of the item to be selected, or 0 if the - * selection was aborted. + * - the number of the item to be selected, or 0 if the + * selection was aborted. * $DESCRIPTION$ - * Allows selection of an element from an array. + * Allows selection of an element from an array. * Please see standard Clipper documentation for ACHOICE for - * additional detail. + * additional detail. * $EXAMPLES$ * aItems := { "One", "Two", "Three" } * nChoice := ACHOICE( 10, 10, 20, 20, aItems ) @@ -79,9 +73,9 @@ * ? "You chose element " + LTRIM( STR( nChoice ) ) * ?? " which has a value of " + aItems[ nChoice ] * ENDIF - * + * * $SEEALSO$ - * + * MENU TO * $END$ */ @@ -96,19 +90,19 @@ * __AtPrompt( , , , [] ) --> .F. * $ARGUMENTS$ * is the row number to display the menu . Value could - * range from zero to MAXROW(). + * range from zero to MAXROW(). * * is the column number to display the menu . Value - * could range from zero to MAXCOL(). + * could range from zero to MAXCOL(). * - * is the menu item character string to display. + * is the menu item character string to display. * * define a message to display each time this menu item is * highlighted. could be a character string or code block that * is evaluated to a character string. If is not specified or - * got the wrong type, an empty string ("") would be used. + * got the wrong type, an empty string ("") would be used. * $RETURNS$ - * __AtPrompt() always return .F. + * __AtPrompt() always return .F. * $DESCRIPTION$ * With __AtPrompt() you define and display a menu item, each call to * __AtPrompt() add another item to the menu, to start the menu itself @@ -116,10 +110,10 @@ * define any row and column combination and they will be displayed at * the order of definition. After each call to __AtPrompt(), the cursor * is placed one column to the right of the last text displayed, and - * ROW() and COL() are updated. + * ROW() and COL() are updated. * * @...PROMPT command is preprocessed into __AtPrompt() function during - * compile time. + * compile time. * $EXAMPLES$ * // display a two line menu with status line at the bottom * // let the user select favorite day @@ -135,12 +129,13 @@ * CASE nChoice == 2 // user select 2nd menu item * ? "Just another day for some" * ENDCASE + * * $STATUS$ * R * $COMPLIANCE$ * CA-Clipper array is limited to 4096 items, and therefor 4096 menu * items are the maximum that could be defined per one menu, Harbour - * does not have this limit (not that you'll ever need that). + * does not have this limit (not that you'll ever need that). * $SEEALSO$ * ACHOICE(),MENU TO,SET MESSAGE,SET INTENSITY,SET WRAP,__MENUTO() * $END$ @@ -157,19 +152,19 @@ * @ , PROMPT [MESSAGE ] * $ARGUMENTS$ * is the row number to display the menu . Value could - * range from zero to MAXROW(). + * range from zero to MAXROW(). * * is the column number to display the menu . Value - * could range from zero to MAXCOL(). + * could range from zero to MAXCOL(). * - * is the menu item character string to display. + * is the menu item character string to display. * * define a message to display each time this menu item is * highlighted. could be a character string or code block that * is evaluated to a character string. If is not specified or - * got the wrong type, an empty string ("") would be used. + * got the wrong type, an empty string ("") would be used. * $RETURNS$ - * @...Prompt always return .F. + * @...Prompt always return .F. * $DESCRIPTION$ * With @...Prompt you define and display a menu item, each call to * @...Prompt add another item to the menu, to start the menu itself @@ -177,10 +172,10 @@ * define any row and column combination and they will be displayed at * the order of definition. After each call to @...Prompt, the cursor * is placed one column to the right of the last text displayed, and - * ROW() and COL() are updated. + * ROW() and COL() are updated. * * @...PROMPT command is preprocessed into __AtPrompt() function during - * compile time. + * compile time. * $EXAMPLES$ * // display a two line menu with status line at the bottom * // let the user select favorite day @@ -196,12 +191,13 @@ * CASE nChoice == 2 // user select 2nd menu item * ? "Just another day for some" * ENDCASE + * * $STATUS$ * R * $COMPLIANCE$ * CA-Clipper array is limited to 4096 items, and therefor 4096 menu * items are the maximum that could be defined per one menu, Harbour - * does not have this limit (not that you'll ever need that). + * does not have this limit (not that you'll ever need that). * $SEEALSO$ * ACHOICE(),MENU TO,SET MESSAGE,SET INTENSITY,SET WRAP,__MENUTO() * $END$ @@ -217,54 +213,54 @@ * $SYNTAX$ * __MenuTo( , ) --> nChoice * $ARGUMENTS$ - * is a set/get code block for variable named . + * is a set/get code block for variable named . * * is a character string that contain the name of the * variable to hold the menu choices, if this variable does not exist * a PRIVATE variable with the name would be created to - * hold the result. + * hold the result. * $RETURNS$ * __MenuTo() return the number of select menu item, or 0 if there was - * no item to select from or if the user pressed the Esc key. + * no item to select from or if the user pressed the Esc key. * $DESCRIPTION$ * __MenuTo() invoked the menu define by previous __AtPrompt() call * and display a highlight bar that the user can move to select an * option from the menu. If does not exist or not visible, * a PRIVATE variable named is created and hold the current * menu selection. If there is a variable named , its value - * is used to select the first highlighted item. + * is used to select the first highlighted item. * * Menu prompts and messages are displayed in current Standard color, - * highlighted bar is displayed using current Enhanced color. + * highlighted bar is displayed using current Enhanced color. * * Pressing the arrow keys move the highlighted bar. When a menu item * is highlighted the message associated with it is displayed on the * line specified with SET MESSAGE. If SET WRAP is ON and the user * press UP arrow while on the first selection the last menu item is * highlighted, if the user press Down arrow while on the last item, - * the first item is highlighted. + * the first item is highlighted. * - * Following are active keys that handled by __MenuTo(): - * ----------------------------------------------------- - * - * Up - Move to previous item - * Down - Move to next item - * Left - Move to previous item - * Right - Move to next item - * Home - Move to the first item - * End - Move to the last item - * Page-Up - Select menu item, return position - * Page-Down - Select menu item, return position - * Enter - Select menu item, return position - * Esc - Abort selection, return 0 - * First letter - Select next menu with the same first letter, + * Following are active keys that handled by __MenuTo(): + * ----------------------------------------------------- + * + * Up Move to previous item + * Down Move to next item + * Left Move to previous item + * Right Move to next item + * Home Move to the first item + * End Move to the last item + * Page-Up Select menu item, return position + * Page-Down Select menu item, return position + * Enter Select menu item, return position + * Esc Abort selection, return 0 + * First letter Select next menu with the same first letter, * | return this item position. - * + *
* upon exit the cursor is placed at MAXROW()-1, 0 - * __MenuTo() can be nested without loosing the previous prompts. + * __MenuTo() can be nested without loosing the previous prompts. * * MENU TO command is preprocessed into __MenuTo() function during - * compile time. + * compile time. * $EXAMPLES$ * // display menu item on each screen corner and let user select one * CLS @@ -281,10 +277,11 @@ * else * ?? "Selected option is", nChoice * endif + * * $STATUS$ * R * $COMPLIANCE$ - * This command is CA-Clipper compliant + * This command is CA-Clipper compliant * $SEEALSO$ * @...PROMPT,ACHOICE(),SET MESSAGE,SET INTENSITY,SET WRAP,__ATPROMPT() * $END$ @@ -303,31 +300,31 @@ * is a character string that contain the name of the * variable to hold the menu choices, if this variable does not exist * a PRIVATE variable with the name would be created to - * hold the result. + * hold the result. * $RETURNS$ * Menu To return the number of select menu item, or 0 if there was - * no item to select from or if the user pressed the Esc key. + * no item to select from or if the user pressed the Esc key. * $DESCRIPTION$ * Menu To() invoked the menu define by previous __AtPrompt() call * and display a highlight bar that the user can move to select an * option from the menu. If does not exist or not visible, * a PRIVATE variable named is created and hold the current * menu selection. If there is a variable named , its value - * is used to select the first highlighted item. + * is used to select the first highlighted item. * * Menu prompts and messages are displayed in current Standard color, - * highlighted bar is displayed using current Enhanced color. + * highlighted bar is displayed using current Enhanced color. * * Pressing the arrow keys move the highlighted bar. When a menu item * is highlighted the message associated with it is displayed on the * line specified with SET MESSAGE. If SET WRAP is ON and the user * press UP arrow while on the first selection the last menu item is * highlighted, if the user press Down arrow while on the last item, - * the first item is highlighted. - * - * Following are active keys that handled by Menu To: - * ----------------------------------------------------- + * the first item is highlighted. * + * Following are active keys that handled by Menu To: + * ----------------------------------------------------- + * * Up - Move to previous item * Down - Move to next item * Left - Move to previous item @@ -340,12 +337,12 @@ * Esc - Abort selection, return 0 * First letter - Select next menu with the same first letter, * | return this item position. - * + *
* upon exit the cursor is placed at MAXROW()-1, 0 - * Menu To can be nested without loosing the previous prompts. + * Menu To can be nested without loosing the previous prompts. * * MENU TO command is preprocessed into __MenuTo() function during - * compile time. + * compile time. * $EXAMPLES$ * // display menu item on each screen corner and let user select one * CLS @@ -362,10 +359,11 @@ * else * ?? "Selected option is", nChoice * endif + * * $STATUS$ * R * $COMPLIANCE$ - * This command is CA Clipper compliant + * This command is CA Clipper compliant * $SEEALSO$ * @...PROMPT,ACHOICE(),SET MESSAGE,SET INTENSITY,SET WRAP,__ATPROMPT() * $END$ diff --git a/harbour/doc/en/rdd.txt b/harbour/doc/en/rdd.txt index 28cbd64563..bf7a02ac54 100644 --- a/harbour/doc/en/rdd.txt +++ b/harbour/doc/en/rdd.txt @@ -26,8 +26,11 @@ * AFields([,][,][,]) --> * $ARGUMENTS$ * Array of field names + * Array of field names + * Array of field names + * Array of field names * $RETURNS$ * Number od fields in a database or work area @@ -59,8 +62,7 @@ * R * $COMPLIANCE$ * AFIELDS() is fully CA-Clipper compliant. - * $SEEALSO$ - * $END$ + * $END$ */ /* $DOC$ @@ -112,10 +114,15 @@ * [] ) --> NIL * $ARGUMENTS$ * Operation that is to be performed + * Code block for the For condition + * Code block for the WHILE condition + * Number of NEXT records to process + * Record number to work on exactly + * Toggle to rewind record pointer * $RETURNS$ * DBEVAL() always returns NIL @@ -219,7 +226,7 @@ * $ONELINER$ * Appends a new record to a database file. * $SYNTAX$ - * DbAppend(<]) --> NIL + * DbAppend(]) --> NIL * $ARGUMENTS$ * Toggle to release record locks * $RETURNS$ @@ -233,8 +240,8 @@ * with NULL bytes.The header of the database is not updated until * the record is flushed from the buffer and the contents are * written to the disk. - * Under a networking enviroment, DBAPPEND() performs an addi- - * tional operation: It attrmps to lock the newly added record. If + * Under a networking enviroment, DBAPPEND() performs an additional + * operation: It attrmps to lock the newly added record. If * the database file is currently locked or if a locking assignment * if made to LASTREC()+1,NETERR() will return a logical true (.T.) * immediately after the DBAPPEND() function. This function does @@ -263,7 +270,7 @@ /* $DOC$ * $FUNCNAME$ - * DBCLEARFILTER() + * DBCLEARFILTER() * $CATEGORY$ * DATA BASE * $ONELINER$ @@ -273,7 +280,7 @@ * $RETURNS$ * DbClearFilTer() always returns NIL * $DESCRIPTION$ - * This function clears any active filter condiction + * This function clears any active filter condiction * for the current or selected work area. * $EXAMPLES$ * Function Main() @@ -300,7 +307,7 @@ /* $DOC$ * $FUNCNAME$ - * DBCLOSEALL() + * DBCLOSEALL() * $CATEGORY$ * DATA BASE * $ONELINER$ @@ -541,10 +548,14 @@ * []) --> NIL * $ARGUMENTS$ * Name of database to be create + * Name of a multidimensional array that contains the a database * structure + * Name of the RDD + * Toggle to Open the create File + * Name of database Alias * $RETURNS$ * DBCREATE() always returns NIL. @@ -947,7 +958,9 @@ * DBSEEK(, [],[]) --> lFound * $ARGUMENTS$ * Any expression + * Toggle SOFTSEEK condition + * is an optional logical value that set the current * record position to the last record if successful * $RETURNS$ @@ -1123,6 +1136,7 @@ * DBSETFILTER(, []) --> NIL * $ARGUMENTS$ * Code block expression for filtered evaluation. + * Optional character expression of code block. * $RETURNS$ * DBSETFILTER() always returns NIL. @@ -1270,10 +1284,15 @@ * [], []) --> NIL * $ARGUMENTS$ * A optional logical expression for the new work area + * Database driver name + * File Name + * Alias name + * Shared/exclusive status flag + * Read-write status flag. * $RETURNS$ * DBUSEAREA() always returns NIL. @@ -1653,7 +1672,7 @@ * $SYNTAX$ * FOUND() --> lSuccess * $ARGUMENTS$ - * + * None. * $RETURNS$ * A logical true (.T.) is successful;otherwise, false (.F.) * $DESCRIPTION$ diff --git a/harbour/doc/en/set.txt b/harbour/doc/en/set.txt index a6046e1469..912590ea13 100644 --- a/harbour/doc/en/set.txt +++ b/harbour/doc/en/set.txt @@ -22,7 +22,9 @@ * * Copyright 2000 Luiz Rafael Culik * Documentation for: SET WRAP,SET DEFAULT,SET MESSAGE - * Documentation for: SET PATH + * Documentation for: SET PATH,SET INTENSITY,SET ALTERNATE + * Documentation for: SET CENTURY,SET DATE,SET CONSOLE + * Documentation for: SET EPOCH * * See doc/license.txt for licensing terms. * @@ -797,7 +799,7 @@ * $ONELINER$ * Specifies a search path for opening files * $SYNTAX$ - * SET WRAP TO [] + * SET PATH TO [] * $ARGUMENTS$ * Search path for files * $DESCRIPTION$ @@ -818,3 +820,153 @@ * SET DEFAULT,CURDIR(),SET() * $END$ */ + +/* $DOC$ + * $COMMANDNAME$ + * SET INTENSITY + * $CATEGORY$ + * Command + * $ONELINER$ + * Toggles the enhaced display of PROMPT's and GETs. + * $SYNTAX$ + * SET INTENSITY [ON / OFF] [()] + * $ARGUMENTS$ + * Logical expression for toggle command + * $DESCRIPTION$ + * This command set the field input color and @...PROMPT menu color + * to either highlighted (inverse video) or normal color. The default + * condition is ON (highlighted). + * $EXAMPLES$ + * SET INTENSITY ON + * $STATUS$ + * R + * $COMPLIANCE$ + * This command is Ca-Clipper Compliant. + * $SEEALSO$ + * @...GET,@...PROMPT,@...SAY,SET() + * $END$ + */ + +/* $DOC$ + * $COMMANDNAME$ + * SET ALTERNATE + * $CATEGORY$ + * Command + * $ONELINER$ + * Toggle and echos output to an alternate file + * $SYNTAX$ + * SET ALTERNATE to [ADDITIVE] + * SET ALTERNATE [ON / OFF] [()] + * $ARGUMENTS$ + * Name of alternate file. + * + * Logical expression for toggle + * $DESCRIPTION$ + * This command toggles and output console information to the alternate + * file ,provided that the command is toggled on or the condition + * is set to a logical true (.T.). If does not has a + * file extension, .TXT will be assumed.The file name may optionally + * have a drive letter and/or directory path.If none is speficied, the + * current drive and directory will be used. + * If the ALTERNATE file is created but no ALTERNATE ON command is + * issued,nothing will be echoed to the file. + * If ADDITIVE clause is used,then the information will be appended + * to the existing alternate file.Otherwise,a new file will be created + * with the specified name (or an existing one will be overwritten) and + * the information will be appended to the file.The default is to create + * a new file. + * A SET ALTERNATE TO command will close the alternate file + * $EXAMPLES$ + * SET ALTERNATE TO test.txt + * SET ALTERNATE ON + * ? 'Harbour' + * ? "is" + * ? "Power" + * SET ALTERNATE TO + * SET ALTERNATE OFF + * $STATUS$ + * R + * $COMPLIANCE$ + * This command is Ca-Clipper Compliant. + * $SEEALSO$ + * CLOSE,SET PRINTER,SET CONSOLE,SET() + * $END$ + */ + +/* $DOC$ + * $COMMANDNAME$ + * SET CENTURY + * $CATEGORY$ + * Command + * $ONELINER$ + * Toggle the century digits in all ates display + * $SYNTAX$ + * SET CENTURY [ON / OFF] [()] + * $ARGUMENTS$ + * Logical expression for toggle + * $DESCRIPTION$ + * This command allows the input and display of dates with the century + * prefix.It will be in the standart MM/DD/YYYY format unless specified + * by the SET DATE command or SET() function.If is a logical + * true (.T.),the command will be set on;otherwise, the command will + * be set off + * $EXAMPLES$ + * SET CENTURY ON + * ? DATE() + * SET CENTURY OFF + * $STATUS$ + * R + * $COMPLIANCE$ + * This command is Ca-Clipper compliant + * $SEEALSO$ + * SET DATE,SET EPOCH,CTOD(),DATE(),DTOC(),SET() + * $END$ + */ + +/* $DOC$ + * $COMMANDNAME$ + * SET DATE + * $CATEGORY$ + * Command + * $ONELINER$ + * Assings a date format or chooses a predefined date data set. + * $SYNTAX$ + * SET DATE FORMAT [TO] + * SET DATE [TO] [ ANSI / BRITISH / FRENCH / GERMAN / ITALIAN / JAPAN / + * USA / AMERICAN] + * $ARGUMENTS$ + * Keyword for date format + * $DESCRIPTION$ + * This command sets the date format for function display purposes. + * If specified, may be a customized date format in which the + * letters d,m and y may be used to desing a date format.The default + * is an AMERICAN date format;specifying no parameters will set the + * date format to AMERICAN.Below is a table of the varius predefined + * dates formats. + * + * + * Syntax Date Format + * ANSI yy.mm.dd + * BRITISH dd/mm/yy + * FRENCH dd/mm/yy + * GERMAN dd.mm.yy + * ITALIAN dd-mm-yy + * JAPAN yy.mm.dd + * USA mm-dd-yy + * AMERICAN mm/dd/yy + *
+ * $EXAMPLES$ + * SET DATE JAPAN + * ? DATE() + * SET DATE GERMAN + * ? Date() + * $TESTS$ + * See tests/dates.prg + * $STATUS$ + * R + * $COMPLIANCE$ + * This command is Ca-Clipper compliant + * $SEEALSO$ + * SET DATE,SET EPOCH,CTOD(),DATE(),DTOC(),SET() + * $END$ + */ diff --git a/harbour/doc/en/terminal.txt b/harbour/doc/en/terminal.txt index 0daa288cc3..9f5696af2b 100644 --- a/harbour/doc/en/terminal.txt +++ b/harbour/doc/en/terminal.txt @@ -106,7 +106,6 @@ * $PLATFORMS$ * __XSaveScreen() is part of the GT API, and supported only by some * platforms. - * $FILES$ * $SEEALSO$ * RESTORE SCREEN,__XRESTSCREEN(),__XSAVESCREEN() * $END$ @@ -193,7 +192,6 @@ * $PLATFORMS$ * Rest Screen is part of the GT API, and supported only by some * platforms. - * $FILES$ * $SEEALSO$ * __XRESTSCREEN(),SAVE SCREEN,__XSAVESCREEN() * $END$ @@ -281,12 +279,12 @@ * displayed. * * ON: Only the first four valid are taken. - * OFF: could contain as many as needed options. + * OFF: could contain as many as needed options. * * is a Harbour extension, or at least un-documented - * in Clipper 5.2 NG. + * in Clipper 5.2 NG. * - * is a Harbour extension. + * is a Harbour extension. * $SEEALSO$ * @...PROMPT,MENU TO,STDOUT(),__NONOALERT() * $END$ @@ -317,7 +315,6 @@ * R * $COMPLIANCE$ * __NONOALERT() is an undocumented CA-Clipper function - * $SEEALSO$ * $END$ */ @@ -386,7 +383,7 @@ * ? hb_ColorIndex( "W/N, N/W", CLR_ENHANCED ) // "N/W" * * $TESTS$ - * see the regression test suit for comprehensive tests. + * see the regression test suit for comprehensive tests. * * $STATUS$ * R diff --git a/harbour/doc/en/var.txt b/harbour/doc/en/var.txt index 260cf39d0e..46b8f8b0ea 100644 --- a/harbour/doc/en/var.txt +++ b/harbour/doc/en/var.txt @@ -161,7 +161,7 @@ * that match passed skeleton should be either included in deletion * (if .T.) or excluded from deletion (if .F.) * $RETURNS$ - * Nothing + * Nothing * $DESCRIPTION$ * This function releases values stored in memory variables. It shouldn't * be called directly, it should be placed into RELEASE ALL command. @@ -206,8 +206,6 @@ * function/procedure * HB_MV_PRIVATE_LOCAL =for private variables declared in current * function/procedure - * $DESCRIPTION$ - * * $EXAMPLES$ * * PROCEDURE MAIN() @@ -241,7 +239,7 @@ * $COMPLIANCE$ * This function is a Harbour Extension * $SEEALSO$ - * include/hbmemvar.ch + * include/hbmemvar.ch * $END$ */