diff --git a/ChangeLog.txt b/ChangeLog.txt index d338e901a5..38e0f83684 100644 --- a/ChangeLog.txt +++ b/ChangeLog.txt @@ -10,6 +10,10 @@ * Change, ! Fix, % Optimization, + Addition, - Removal, ; Comment */ +2013-03-18 19:03 UTC+0100 Viktor Szakats (harbour syenar.net) + * doc/en/*.txt + * doc cleanups + 2013-03-18 17:22 UTC+0100 Viktor Szakats (harbour syenar.net) * contrib/hbcairo/pattern.c ! fixed cairo_pattern_get_radial_points() to cairo_pattern_get_radial_circles() diff --git a/doc/en/array.txt b/doc/en/array.txt index ac2fcc37b2..6a88568171 100644 --- a/doc/en/array.txt +++ b/doc/en/array.txt @@ -73,7 +73,7 @@ $ONELINER$ Dynamically add an element to an array $SYNTAX$ - AAdd([, ]) --> Value + AAdd( [, ] ) --> Value $ARGUMENTS$ The name of an array @@ -119,7 +119,7 @@ $ONELINER$ Adjust the size of an array $SYNTAX$ - ASize(, ) --> aTarget + ASize( , ) --> aTarget $ARGUMENTS$ Name of array to be dynamically altered @@ -241,7 +241,7 @@ $ONELINER$ Delete an element form an array. $SYNTAX$ - ADel(, ) --> aTarget + ADel( , ) --> aTarget $ARGUMENTS$ Name of array from which an element is to be removed. @@ -299,7 +299,7 @@ element to be filled and the array elements will continue to be 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 + of Len( ); thus, all subscript positions in the array will be filled with the value of . This function will work on only a single dimension of . @@ -389,7 +389,7 @@ $ONELINER$ Evaluates the subscript element of an array $SYNTAX$ - AEval(, , [], []) --> aArray + AEval( , , [], [] ) --> aArray $ARGUMENTS$ Is the array to be evaluated. @@ -505,7 +505,7 @@ $ONELINER$ Duplicate a multidimensional array $SYNTAX$ - AClone() --> aDuplicate + AClone( ) --> aDuplicate $ARGUMENTS$ Name of the array to be cloned. $RETURNS$ diff --git a/doc/en/datetime.txt b/doc/en/datetime.txt index 26f1e83dc4..c0417f760c 100644 --- a/doc/en/datetime.txt +++ b/doc/en/datetime.txt @@ -21,7 +21,7 @@ $ONELINER$ Converts a date to the day of week $SYNTAX$ - CDoW() --> cDay + CDoW( ) --> cDay $ARGUMENTS$ Any date expression. $RETURNS$ @@ -61,7 +61,7 @@ $ONELINER$ Return the name of the month. $SYNTAX$ - CMonth() --> cMonth + CMonth( ) --> cMonth $ARGUMENTS$ Any date expression. $RETURNS$ @@ -136,7 +136,7 @@ $ONELINER$ Converts a character string to a date expression $SYNTAX$ - CToD() --> dDate + CToD( ) --> dDate $ARGUMENTS$ A character date in format 'mm/dd/yy' $RETURNS$ @@ -176,7 +176,7 @@ $ONELINER$ Return the numeric day of the month. $SYNTAX$ - Day() --> nMonth + Day( ) --> nMonth $ARGUMENTS$ Any valid date expression. $RETURNS$ @@ -212,7 +212,7 @@ $ONELINER$ Convert elapsed seconds into days $SYNTAX$ - Days( ) --> nDay + Days( ) --> nDay $ARGUMENTS$ The number of seconds $RETURNS$ @@ -248,7 +248,7 @@ $ONELINER$ Value for the day of week. $SYNTAX$ - DoW() --> nDay + DoW( ) --> nDay $ARGUMENTS$ Any valid date expression $RETURNS$ @@ -284,7 +284,7 @@ $ONELINER$ Date to character conversion $SYNTAX$ - DToC() --> cDate + DToC( ) --> cDate $ARGUMENTS$ Any date $RETURNS$ @@ -322,7 +322,7 @@ $ONELINER$ Date to string conversion $SYNTAX$ - DToS() --> cDate + DToS( ) --> cDate $ARGUMENTS$ Any date $RETURNS$ @@ -358,7 +358,7 @@ $ONELINER$ Calculates elapted time. $SYNTAX$ - ElapTime(,) --> cDiference + ElapTime( , ) --> cDiference $ARGUMENTS$ Start in time as a string format End time as a string format @@ -402,7 +402,7 @@ $ONELINER$ Converts a date expression to a month value $SYNTAX$ - Month() --> nMonth + Month( ) --> nMonth $ARGUMENTS$ Any valid date expression $RETURNS$ @@ -548,7 +548,7 @@ $ONELINER$ Converts the year portion of a date into a numeric value $SYNTAX$ - Year() --> nYear + Year( ) --> nYear $ARGUMENTS$ Any valid date expression $RETURNS$ diff --git a/doc/en/eval.txt b/doc/en/eval.txt index 762a8340c0..623e6deaa1 100644 --- a/doc/en/eval.txt +++ b/doc/en/eval.txt @@ -21,7 +21,7 @@ $ONELINER$ Evaluate a code block $SYNTAX$ - Eval( [, [,...]]) --> xExpression + Eval( [, [,...] ] ) --> xExpression $ARGUMENTS$ Code block expression to be evaluated diff --git a/doc/en/file.txt b/doc/en/file.txt index c788daa874..31f62a864c 100644 --- a/doc/en/file.txt +++ b/doc/en/file.txt @@ -605,7 +605,7 @@ $ONELINER$ Reads a string from a file. $SYNTAX$ - FReadStr(, ) --> cString + FReadStr( , ) --> cString $ARGUMENTS$ File handle number. @@ -897,7 +897,7 @@ $ONELINER$ Returns the current OS directory name. $SYNTAX$ - CurDir( [] ) --> cPath + CurDir( [] ) --> cPath $ARGUMENTS$ OS drive letter $RETURNS$ diff --git a/doc/en/harbext.txt b/doc/en/harbext.txt index c208e54769..599b11275f 100644 --- a/doc/en/harbext.txt +++ b/doc/en/harbext.txt @@ -43,11 +43,11 @@ 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. - * SToD() --> dDate + * SToD() --> dDate New function that converts a yyyymmdd string to a Date value. diff --git a/doc/en/hbflock.txt b/doc/en/hbflock.txt index d256277936..7b208062b5 100644 --- a/doc/en/hbflock.txt +++ b/doc/en/hbflock.txt @@ -70,8 +70,7 @@ $ONELINER$ Unlocks part or all of any file $SYNTAX$ - hb_FUnlock( , , ) --> - + hb_FUnlock( , , ) --> $ARGUMENTS$ Dos file handle diff --git a/doc/en/math.txt b/doc/en/math.txt index 3f3fde6d5f..365f48fafe 100644 --- a/doc/en/math.txt +++ b/doc/en/math.txt @@ -26,7 +26,7 @@ $ONELINER$ Return the absolute value of a number. $SYNTAX$ - Abs() --> + Abs( ) --> $ARGUMENTS$ Any number. $RETURNS$ @@ -181,7 +181,7 @@ $ONELINER$ Returns the maximum of two numbers or dates. $SYNTAX$ - Max( , ) --> + Max( , ) --> $ARGUMENTS$ Any date or numeric value. @@ -223,7 +223,7 @@ $ONELINER$ Determines the minumum of two numbers or dates. $SYNTAX$ - Min( , ) --> + Min( , ) --> $ARGUMENTS$ Any date or numeric value. diff --git a/doc/en/menu.txt b/doc/en/menu.txt index 03d3d28d99..13645f0fee 100644 --- a/doc/en/menu.txt +++ b/doc/en/menu.txt @@ -21,7 +21,7 @@ $ONELINER$ Allows selection of an element from an array $SYNTAX$ - AChoice(, , , , , [ | ], [ | ], [], []) --> nPosition + AChoice( , , , , , [ | ], [ | ], [], [] ) --> nPosition $ARGUMENTS$ - topmost row used to display array (default 0) diff --git a/doc/en/misc.txt b/doc/en/misc.txt index 23c470628b..479956f6b3 100644 --- a/doc/en/misc.txt +++ b/doc/en/misc.txt @@ -49,7 +49,7 @@ $ONELINER$ Returns the HARBOUR Version or the Harbour/Compiler Version. $SYNTAX$ - Version() --> + Version() --> $ARGUMENTS$ None $RETURNS$ @@ -83,7 +83,7 @@ $ONELINER$ Obtains a system environmental setting. $SYNTAX$ - GetEnv( ) --> + GetEnv( ) --> $ARGUMENTS$ Enviromental variable to obtain. $RETURNS$ @@ -124,7 +124,7 @@ $ONELINER$ Obtains a system environmental setting. $SYNTAX$ - GetE( ) --> + GetE( ) --> $ARGUMENTS$ Enviromental variable to obtain. $RETURNS$ @@ -167,18 +167,11 @@ $ONELINER$ Obtains a system environmental setting. $SYNTAX$ - hb_GetEnv(, [], [] ) --> + hb_GetEnv( , [] ) --> $ARGUMENTS$ Enviromental variable to obtain. Optional value to return if is not found. - - optional logical parameter specifing whether to - apply automatic codepage conversion (to the codepage - specified by Set( _SET_OSCODEPAGE ) on the obtained value. - The default is .T. Note that if the default value is passed and the environment - value is not found, this codepage conversion is not performed against - the returned default value $RETURNS$ Value of the environment variable or or an empty string. $DESCRIPTION$ diff --git a/doc/en/rdddb.txt b/doc/en/rdddb.txt index 33cde6c2aa..6f32c72888 100644 --- a/doc/en/rdddb.txt +++ b/doc/en/rdddb.txt @@ -594,7 +594,7 @@ $ONELINER$ Position the record pointer to a specific location. $SYNTAX$ - dbGoto() + dbGoto( ) $ARGUMENTS$ Record number or unique identity $DESCRIPTION$ @@ -853,7 +853,7 @@ $ONELINER$ Searches for a value based on an active index. $SYNTAX$ - dbSeek(, [],[]) --> lFound + dbSeek( , [], [] ) --> lFound $ARGUMENTS$ Any expression @@ -927,7 +927,7 @@ $ONELINER$ Change to another work area $SYNTAX$ - dbSelectArea() - + dbSelectArea( ) - $ARGUMENTS$ Alias or work area $DESCRIPTION$ @@ -1054,7 +1054,7 @@ $ONELINER$ Establishes a filter condition for a work area. $SYNTAX$ - dbSetFilter(, []) + dbSetFilter( , [] ) $ARGUMENTS$ Code block expression for filtered evaluation. diff --git a/doc/en/rddmisc.txt b/doc/en/rddmisc.txt index f098f8fc3f..64b366ab78 100644 --- a/doc/en/rddmisc.txt +++ b/doc/en/rddmisc.txt @@ -23,7 +23,7 @@ $ONELINER$ Fills referenced arrays with database field information $SYNTAX$ - AFields([,][,][,]) --> + AFields( , [], [], [] ) --> $ARGUMENTS$ Array of field names @@ -344,7 +344,7 @@ $ONELINER$ Obtains the value of a specified field $SYNTAX$ - FieldGet() --> ValueField + FieldGet( ) --> ValueField $ARGUMENTS$ Is the numeric field position $RETURNS$ @@ -383,7 +383,7 @@ $ONELINER$ Return the name of a field at a numeric field location. $SYNTAX$ - FIELDNAME/FIELD() --> cFieldName + FieldName()/Field( ) --> cFieldName $ARGUMENTS$ Field order in the database. $RETURNS$ @@ -425,7 +425,7 @@ $ONELINER$ Return the ordinal position of a field. $SYNTAX$ - FieldPos() --> nFieldPos + FieldPos( ) --> nFieldPos $ARGUMENTS$ Name of a field. $RETURNS$ @@ -464,7 +464,7 @@ $ONELINER$ Set the value of a field variable $SYNTAX$ - FieldPut(, ) --> ValueAssigned + FieldPut( , ) --> ValueAssigned $ARGUMENTS$ The field numeric position diff --git a/doc/en/rddord.txt b/doc/en/rddord.txt index 36f871c5b0..35c4f18dcd 100644 --- a/doc/en/rddord.txt +++ b/doc/en/rddord.txt @@ -3,9 +3,9 @@ * www - http://harbour-project.org * * Copyright 1999 Luiz Rafael Culik - * DB*() documentation - * ORD*() documentation - * RDD*() documentation + * db*() documentation + * ord*() documentation + * rdd*() documentation * * See COPYING.txt for licensing terms. * @@ -66,7 +66,7 @@ $ONELINER$ Returns the Order Bag Name. $SYNTAX$ - ordBagName( | ) --> cOrderBagName + ordBagName( | ) --> cOrderBagName $ARGUMENTS$ A numeric value representing the Order bag number. @@ -165,8 +165,8 @@ $ONELINER$ Create an Order in an Order Bag $SYNTAX$ - ordCreate(,[], , - [], []) + ordCreate( ,[], , + [], [] ) $ARGUMENTS$ Name of the file that contains one or more Orders. @@ -236,7 +236,7 @@ $ONELINER$ Remove an Order from an Order Bag $SYNTAX$ - ordDestroy( [, ]) + ordDestroy( [, ] ) $ARGUMENTS$ Name of the order to remove @@ -282,8 +282,7 @@ $ONELINER$ Return the FOR expression of an Order $SYNTAX$ - ordFor([, ]) --> cForExp - + ordFor( [, ] ) --> cForExp $ARGUMENTS$ It the name of the target order,or the numeric position of the order. @@ -332,7 +331,7 @@ $ONELINER$ Return the key expression of an Order $SYNTAX$ - ordKey( | [, ]) --> cExpKey + ordKey( | [, ] ) --> cExpKey $ARGUMENTS$ It the name of the target order,or the numeric position of the order. @@ -418,7 +417,7 @@ $ONELINER$ Yields the key expression of a specified index file. $SYNTAX$ - IndexKey() --> + IndexKey( ) --> $ARGUMENTS$ Index order number $RETURNS$ diff --git a/doc/en/set.txt b/doc/en/set.txt index fdb92ed23d..487eba9022 100644 --- a/doc/en/set.txt +++ b/doc/en/set.txt @@ -64,7 +64,7 @@ $ONELINER$ Changes or evaluated environmental settings $SYNTAX$ - Set( [, [, ] ] ) --> xPreviousSetting + Set( [, [, ] ] ) --> xPreviousSetting $ARGUMENTS$ Set Number @@ -747,7 +747,7 @@ $ONELINER$ Assign an action block to a key $SYNTAX$ - SET KEY to p] [when ] ) + SET KEY TO ] [WHEN ] $ARGUMENTS$ is either a numeric key value, or an array of such values @@ -894,7 +894,7 @@ $ONELINER$ Toggle wrapping the PROMPTs in a menu. $SYNTAX$ - SET WRAP on | OFF | ( + SET WRAP on | OFF | ( ) $ARGUMENTS$ Logical expression for toggle $DESCRIPTION$ @@ -1001,7 +1001,7 @@ $ONELINER$ Toggles the enhanced display of PROMPT's and GETs. $SYNTAX$ - SET INTENSITY ON | off | () + SET INTENSITY ON | off | ( ) $ARGUMENTS$ Logical expression for toggle command $DESCRIPTION$ @@ -1031,8 +1031,8 @@ $ONELINER$ Toggle and echos output to an alternate file $SYNTAX$ - SET ALTERNATE to [ADDITIVE] - SET ALTERNATE on | OFF | () + SET ALTERNATE TO [ADDITIVE] + SET ALTERNATE on | OFF | ( ) $ARGUMENTS$ Name of alternate file. @@ -1081,7 +1081,7 @@ $ONELINER$ Toggle the century digits in all dates display $SYNTAX$ - SET CENTURY on | OFF | () + SET CENTURY on | OFF | ( ) $ARGUMENTS$ Logical expression for toggle $DESCRIPTION$ @@ -1195,7 +1195,7 @@ $ONELINER$ Set the number of decimal position to be displayed $SYNTAX$ - SET FIXED on | OFF | () + SET FIXED on | OFF | ( ) $ARGUMENTS$ Logical expression for toggle $DESCRIPTION$ @@ -1244,7 +1244,7 @@ Toggles the printer and controls the printer device $SYNTAX$ SET PRINTER on | OFF - SET PRINTER () + SET PRINTER ( ) SET PRINTER TO [] [ADDITIVE] $ARGUMENTS$ Logical condition by which to toggle the printer @@ -1300,7 +1300,7 @@ $ONELINER$ Toggle the console display $SYNTAX$ - SET CONSOLE ON | off | () + SET CONSOLE ON | off | ( ) $ARGUMENTS$ Logical expression for toggle command $DESCRIPTION$ @@ -1413,7 +1413,7 @@ $ONELINER$ Toggle the bell to sound once a GET has been completed. $SYNTAX$ - SET BELL on | OFF | () + SET BELL on | OFF | ( ) $ARGUMENTS$ Logical expression for toggle command $DESCRIPTION$ diff --git a/doc/en/string.txt b/doc/en/string.txt index 465cebf36f..7c51b55d1f 100644 --- a/doc/en/string.txt +++ b/doc/en/string.txt @@ -927,7 +927,7 @@ $ONELINER$ Converts an ASCII value to it character value $SYNTAX$ - Chr( ) --> cReturn + Chr( ) --> cReturn $ARGUMENTS$ Any ASCII character code. $RETURNS$ @@ -1004,7 +1004,7 @@ $ONELINER$ Centers an expression for a given width $SYNTAX$ - PadC( , , ) --> cString + PadC( , , ) --> cString $ARGUMENTS$ A Number, Character or Date value to pad @@ -1052,7 +1052,7 @@ $ONELINER$ Left-justifies an expression for a given width $SYNTAX$ - PadL( , , ) --> cString + PadL( , , ) --> cString $ARGUMENTS$ An number,Character or date to pad @@ -1228,7 +1228,7 @@ $ONELINER$ Remove trailing spaces from a string. $SYNTAX$ - Trim( ) --> cString + Trim( ) --> cString $ARGUMENTS$ Any character expression $RETURNS$ @@ -1270,7 +1270,7 @@ $ONELINER$ Repeats a single character expression $SYNTAX$ - Replicate( , ) --> cReplicateString + Replicate( , ) --> cReplicateString $ARGUMENTS$ Character string to be replicated @@ -1474,7 +1474,7 @@ $ONELINER$ Formats a value based on a specific picture template. $SYNTAX$ - Transform( , ) --> cFormatted + Transform( , ) --> cFormatted $ARGUMENTS$ Any expression to be formated. diff --git a/doc/en/tbrowse.txt b/doc/en/tbrowse.txt index 28b03e6e06..ba15f1459e 100644 --- a/doc/en/tbrowse.txt +++ b/doc/en/tbrowse.txt @@ -9,7 +9,7 @@ $ONELINER$ Create a Browse Object $CONSTRUCTOR$ - TBrowseNew(,,,) --> + TBrowseNew( , , , ) --> $ARGUMENTS$ Top Row @@ -192,7 +192,7 @@ $ONELINER$ Get an optionaly Set an new Code block associated to a inkey value $SYNTAX$ - SetKey([,]) --> bOldBlock + SetKey( [, ] ) --> bOldBlock $ARGUMENTS$ An valid inkey Code @@ -256,7 +256,7 @@ $ONELINER$ Evaluates an code block associated with an specific key $SYNTAX$ - ApplyKey() --> nResult + ApplyKey( ) --> nResult $ARGUMENTS$ An valid Inkey code $RETURNS$ diff --git a/doc/en/terminal.txt b/doc/en/terminal.txt index 3eba622aad..e6342725b1 100644 --- a/doc/en/terminal.txt +++ b/doc/en/terminal.txt @@ -757,7 +757,7 @@ $ONELINER$ Returns the current screen column position $SYNTAX$ - Col() --> nPosition + Col() --> nPosition $ARGUMENTS$ None. $RETURNS$ @@ -792,7 +792,7 @@ $ONELINER$ Returns the current screen row position $SYNTAX$ - Row() --> nPosition + Row() --> nPosition $ARGUMENTS$ None. $RETURNS$ @@ -827,7 +827,7 @@ $ONELINER$ Returns the maximun number of columns in the current video mode $SYNTAX$ - MaxCol() --> nPosition + MaxCol() --> nPosition $ARGUMENTS$ None. $RETURNS$ @@ -863,7 +863,7 @@ $ONELINER$ Returns the current screen row position $SYNTAX$ - MaxRow() --> nPosition + MaxRow() --> nPosition $ARGUMENTS$ None. $RETURNS$ diff --git a/doc/en/var.txt b/doc/en/var.txt index cf9495c637..104a9c3729 100644 --- a/doc/en/var.txt +++ b/doc/en/var.txt @@ -427,7 +427,7 @@ $ONELINER$ Determine if a given name is a PUBLIC or PRIVATE memory variable $SYNTAX$ - __mvExist( ) --> + __mvExist( ) --> $ARGUMENTS$ - string that specifies the name of variable to check $RETURNS$ @@ -468,7 +468,7 @@ $ONELINER$ This function returns value of memory variable $SYNTAX$ - __mvGet( ) --> + __mvGet( ) --> $ARGUMENTS$ - string that specifies the name of variable $RETURNS$ @@ -506,7 +506,7 @@ $ONELINER$ This function set the value of memory variable $SYNTAX$ - __mvGet( [, ] ) --> + __mvGet( [, ] ) --> $ARGUMENTS$ - string that specifies the name of variable - a value of any type that will be set - if it is not