From 7526351f80c503a58588ba88968520e23e8738fd Mon Sep 17 00:00:00 2001 From: Viktor Szakats Date: Tue, 3 Jul 2012 09:34:31 +0000 Subject: [PATCH] 2012-07-03 11:32 UTC+0200 Viktor Szakats (harbour syenar.net) * doc/en/file.txt ! Spelling. by Alexey Myronenko ! some more * doc/en/array.txt * doc/en/binnum.txt * doc/en/browse.txt * formatted $EXAMPLES$ * made $EXAMPLES$ unicode-ready --- harbour/ChangeLog | 12 +++ harbour/doc/en/array.txt | 78 ++++++++++---------- harbour/doc/en/binnum.txt | 150 +++++++++++++++++++------------------- harbour/doc/en/browse.txt | 4 +- harbour/doc/en/file.txt | 34 ++++----- 5 files changed, 146 insertions(+), 132 deletions(-) diff --git a/harbour/ChangeLog b/harbour/ChangeLog index a87fda331a..40b259bc2e 100644 --- a/harbour/ChangeLog +++ b/harbour/ChangeLog @@ -16,6 +16,18 @@ The license applies to all entries newer than 2009-04-28. */ +2012-07-03 11:32 UTC+0200 Viktor Szakats (harbour syenar.net) + * doc/en/file.txt + ! Spelling. + by Alexey Myronenko + ! some more + + * doc/en/array.txt + * doc/en/binnum.txt + * doc/en/browse.txt + * formatted $EXAMPLES$ + * made $EXAMPLES$ unicode-ready + 2012-07-03 10:03 UTC+0200 Viktor Szakats (harbour syenar.net) * doc/en/file.txt ! Examples for FOPEN, FCREATE, DELETE FILE are corrected, filenarne to filename changed diff --git a/harbour/doc/en/array.txt b/harbour/doc/en/array.txt index b22237c084..659beeceed 100644 --- a/harbour/doc/en/array.txt +++ b/harbour/doc/en/array.txt @@ -47,13 +47,13 @@ * the array or the variable with the same name as the array. * $EXAMPLES$ * PROCEDURE Main() - * LOCAL aArray:=Array(10) - * LOCAL x - * FOR x:=1 to LEN(aArray) - * aArray[x]:=Array(x) - * NEXT - * // Result is: { { NIL }, { NIL, NIL }, ... } - * RETURN + * LOCAL aArray := Array( 10 ) + * LOCAL x + * FOR x := 1 TO Len( aArray ) + * aArray[ x ] := Array( x ) + * NEXT + * // Result is: { { NIL }, { NIL, NIL }, ... } + * RETURN * $STATUS$ * R * $COMPLIANCE$ @@ -93,11 +93,11 @@ * may be an array reference pointer, which in turn may be * stored to an array's subscript position. * $EXAMPLES$ - * LOCAL aArray:={} + * LOCAL aArray := {} * LOCAL x - * AADD(aArray,10) - * FOR x:=1 to 10 - * AADD(aArray,x) + * AAdd( aArray, 10 ) + * FOR x := 1 TO 10 + * AAdd( aArray, x ) * NEXT * // Result is: { 10, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 } * $STATUS$ @@ -139,9 +139,9 @@ * subscript positions are lost. If the length of the array is * 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 } + * LOCAL aArray := { 1 } // Result: aArray is { 1 } + * ASize( aArray, 3 ) // Result: aArray is { 1, NIL, NIL } + * ASize( aArray, 1 ) // Result: aArray is { 1 } * $STATUS$ * R * $COMPLIANCE$ @@ -176,8 +176,8 @@ * named . This function does not alter the size of the * array or any of the subscript values. * $EXAMPLES$ - * LOCAL array:= {"Harbour", "is", "Supreme", "Power"} - * ? ATAIL(aArray) // Result is "Power" + * LOCAL aArray := { "Harbour", "is", "Supreme", "Power" } + * ? ATail( aArray ) // Result is "Power" * $STATUS$ * R * $COMPLIANCE$ @@ -220,8 +220,8 @@ * be located at the sixth position. The length of the array * will remain unchanged. * $EXAMPLES$ - * LOCAL aArray:={"Harbour","is","Power!","!!!"} - * AINS(aArray,4) + * LOCAL aArray := { "Harbour", "is", "Power!", "!!!" } + * AIns( aArray, 4 ) * $STATUS$ * R * $COMPLIANCE$ @@ -261,10 +261,8 @@ * will remain unchanged,as the last element in the array will * become a NIL data type. * $EXAMPLES$ - * LOCAL aArray - * aArray := {"Harbour", "is", "Power"} - * - * ADEL(aArray, 2) // Result: aArray is {"Harbour", "Power"} + * LOCAL aArray := { "Harbour", "is", "Power" } + * ADel( aArray, 2 ) // Result: aArray is { "Harbour", "Power" } * $STATUS$ * R * $COMPLIANCE$ @@ -313,8 +311,8 @@ * those values will be lost, since this function will overwrite those * values with new values. * $EXAMPLES$ - * LOCAL aTest:={Nil,0,1,2} - * Afill(aTest,5) + * LOCAL aTest := { NIL, 0, 1, 2 } + * AFill( aTest, 5 ) * $STATUS$ * R * $COMPLIANCE$ @@ -370,8 +368,8 @@ * 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$ - * aDir:=Directory("*.prg") - * AScan(aDir,,,{|x,y| x[1]="Test.prg"}) + * LOCAL aDir := Directory( "*.prg" ) + * AScan( aDir,,, {| x, y | x[ 1 ] := "test.prg" } ) * $STATUS$ * R * $COMPLIANCE$ @@ -485,9 +483,9 @@ * array remains constant. * $EXAMPLES$ * LOCAL nCount := 2, nStart := 1, aOne, aTwo - * aOne := {"HARBOUR"," is ","POWER"} - * aTwo := {"CLIPPER"," was ","POWER"} - * ACOPY(aOne, aTwo, nStart, nCount) + * aOne := { "HARBOUR", " is ", "POWER"} + * aTwo := { "CLIPPER", " was ", "POWER"} + * ACopy( aOne, aTwo, nStart, nCount ) * $STATUS$ * R * $COMPLIANCE$ @@ -524,12 +522,12 @@ * original array * $EXAMPLES$ * LOCAL aOne, aTwo - * aOne := {"Harbour"," is ","POWER"} - * aTwo := ACLONE(aOne) // Result: aTwo is {"Harbour"," is ","POWER"} - * aOne[1] := "The Harbour Compiler" + * aOne := { "Harbour"," is ","POWER" } + * aTwo := AClone( aOne ) // Result: aTwo is {"Harbour"," is ","POWER"} + * aOne[ 1 ] := "The Harbour Compiler" * // Result: - * // aOne is {"The Harbour Compiler"," is ","POWER"} - * // aTwo is {"Harbour"," is ","POWER"} + * // aOne is { "The Harbour Compiler", " is ", "POWER" } + * // aTwo is { "Harbour"," is ","POWER" } * $STATUS$ * R * $COMPLIANCE$ @@ -585,17 +583,17 @@ * type. * $EXAMPLES$ * // sort numeric values in ascending order - * ASORT( { 3, 1, 4, 42, 5, 9 } ) // result: { 1, 3, 4, 5, 9, 42 } + * ASort( { 3, 1, 4, 42, 5, 9 } ) // result: { 1, 3, 4, 5, 9, 42 } * * // sort character strings in descending lexical order * aKeys := { "Ctrl", "Alt", "Delete" } - * bSort := {| x, y | UPPER( x ) > UPPER( y ) } - * ASORT( aKeys,,, bSort ) // result: { "Delete", "Ctrl", "Alt" } + * bSort := {| x, y | Upper( x ) > Upper( y ) } + * ASort( aKeys,,, bSort ) // result: { "Delete", "Ctrl", "Alt" } * * // 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} } + * 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 } } * $STATUS$ * R * $COMPLIANCE$ diff --git a/harbour/doc/en/binnum.txt b/harbour/doc/en/binnum.txt index 540480f536..b90e5f107c 100644 --- a/harbour/doc/en/binnum.txt +++ b/harbour/doc/en/binnum.txt @@ -49,18 +49,19 @@ * BIN2W() is the opposite of W2BIN() * $EXAMPLES$ * // Show header length of a DBF - * FUNCTION main() - * LOCAL nHandle, cBuffer := space( 2 ) - * nHandle := fopen( "test.dbf" ) - * IF nHandle > 0 - * fseek( nHandle, 8 ) - * fread( nHandle, @cBuffer, 2 ) - * ? "Length of DBF header in bytes:", BIN2W( cBuffer ) - * fclose( nHandle ) - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN NIL + * #include "fileio.ch" + * PROCEDURE Main() + * LOCAL nHandle, cBuffer := Space( 2 ) + * nHandle := FOpen( "test.dbf" ) + * IF nHandle != F_ERROR + * FSeek( nHandle, 8 ) + * FRead( nHandle, @cBuffer, hb_BLen( cBuffer ) ) + * ? "Length of DBF header in bytes:", Bin2W( cBuffer ) + * FClose( nHandle ) + * ELSE + * ? "Can not open file" + * ENDIF + * RETURN * $STATUS$ * R * $COMPLIANCE$ @@ -107,21 +108,22 @@ * BIN2I() is the opposite of I2BIN() * $EXAMPLES$ * // Show DBF last update date - * FUNCTION main() - * LOCAL nHandle, cYear, cMonth, cDay - * nHandle := fopen( "test.dbf" ) - * IF nHandle > 0 - * fseek( nHandle, 1 ) - * cYear := cMonth := cDay := " " - * fread( nHandle, @cYear , 1 ) - * fread( nHandle, @cMonth, 1 ) - * fread( nHandle, @cDay , 1 ) - * ? "Last update:", BIN2I( cYear ), BIN2I( cMonth ), BIN2I( cDay ) - * fclose( nHandle ) - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN NIL + * #include "fileio.ch" + * PROCEDURE Main() + * LOCAL nHandle, cYear, cMonth, cDay + * nHandle := FOpen( "test.dbf" ) + * IF nHandle != F_ERROR + * FSeek( nHandle, 1 ) + * cYear := cMonth := cDay := " " + * FRead( nHandle, @cYear , hb_BLen( cYear ) ) + * FRead( nHandle, @cMonth, hb_BLen( cMonth ) ) + * FRead( nHandle, @cDay , hb_BLen( cDay ) ) + * ? "Last update:", Bin2I( cYear ), Bin2I( cMonth ), Bin2I( cDay ) + * FClose( nHandle ) + * ELSE + * ? "Can not open file" + * ENDIF + * RETURN * $STATUS$ * R * $COMPLIANCE$ @@ -168,18 +170,19 @@ * BIN2L() is the opposite of L2BIN() * $EXAMPLES$ * // Show number of records in DBF - * FUNCTION main() - * LOCAL nHandle, cBuffer := space( 4 ) - * nHandle := fopen( "test.dbf" ) - * IF nHandle > 0 - * fseek( nHandle, 4 ) - * fread( nHandle, @cBuffer, 4 ) - * ? "Number of records in file:", BIN2L( cBuffer ) - * fclose( nHandle ) - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN NIL + * #include "fileio.ch" + * PROCEDURE Main() + * LOCAL nHandle, cBuffer := Space( 4 ) + * nHandle := FOpen( "test.dbf" ) + * IF nHandle != F_ERROR + * FSeek( nHandle, 4 ) + * FRead( nHandle, @cBuffer, hb_BLen( cBuffer ) ) + * ? "Number of records in file:", Bin2L( cBuffer ) + * FClose( nHandle ) + * ELSE + * ? "Can not open file" + * ENDIF + * RETURN * $STATUS$ * R * $COMPLIANCE$ @@ -226,18 +229,19 @@ * BIN2U() is the opposite of U2BIN() * $EXAMPLES$ * // Show number of records in DBF - * FUNCTION main() - * LOCAL nHandle, cBuffer := space( 4 ) - * nHandle := fopen( "test.dbf" ) - * IF nHandle > 0 - * fseek( nHandle, 4 ) - * fread( nHandle, @cBuffer, 4 ) - * ? "Number of records in file:", BIN2U( cBuffer ) - * fclose( nHandle ) - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN NIL + * #include "fileio.ch" + * PROCEDURE Main() + * LOCAL nHandle, cBuffer := Space( 4 ) + * nHandle := FOpen( "test.dbf" ) + * IF nHandle != F_ERROR + * FSeek( nHandle, 4 ) + * FRead( nHandle, @cBuffer, hb_BLen( cBuffer ) ) + * ? "Number of records in file:", Bin2U( cBuffer ) + * FClose( nHandle ) + * ELSE + * ? "Can not open file" + * ENDIF + * RETURN * $STATUS$ * R * $COMPLIANCE$ @@ -284,28 +288,28 @@ * $EXAMPLES$ * // Update DBF "last update" date * #include "fileio.ch" - * FUNCTION main() - * LOCAL nHandle, cYear, cMonth, cDay - * use test - * ? "Original update date is:", lupdate() - * close - * nHandle := fopen( "test.dbf", FO_READWRITE ) - * IF nHandle > 0 - * fseek( nHandle, 1, ) - * cYear := I2BIN( 68 ) - * cMonth := I2BIN( 8 ) - * cDay := I2BIN( 1 ) - * fwrite( nHandle, cYear , 1 ) // write only the first byte - * fwrite( nHandle, cMonth, 1 ) - * fwrite( nHandle, cDay , 1 ) - * fclose( nHandle ) - * use test - * ? "New update date is:", lupdate() - * close - * ELSE - * ? "Can not open file" - * ENDIF - * RETURN NIL + * PROCEDURE Main() + * LOCAL nHandle, cYear, cMonth, cDay + * USE test + * ? "Original update date is:", LUpdate() + * CLOSE + * nHandle := FOpen( "test.dbf", FO_READWRITE ) + * IF nHandle != F_ERROR + * FSeek( nHandle, 1 ) + * cYear := I2Bin( 68 ) + * cMonth := I2Bin( 8 ) + * cDay := I2Bin( 1 ) + * FWrite( nHandle, cYear , 1 ) // write only the first byte + * FWrite( nHandle, cMonth, 1 ) + * FWrite( nHandle, cDay , 1 ) + * FClose( nHandle ) + * USE test + * ? "New update date is:", lupdate() + * CLOSE + * ELSE + * ? "Can not open file" + * ENDIF + * RETURN * $STATUS$ * R * $COMPLIANCE$ diff --git a/harbour/doc/en/browse.txt b/harbour/doc/en/browse.txt index e138eaba37..6156d6deaf 100644 --- a/harbour/doc/en/browse.txt +++ b/harbour/doc/en/browse.txt @@ -181,7 +181,7 @@ * $EXAMPLES$ * // Browse a file using default values * USE Test - * DBEDIT() + * dbEdit() * $STATUS$ * S * $COMPLIANCE$ @@ -274,7 +274,7 @@ * $EXAMPLES$ * // this one shows you how to browse around * USE Around - * BROWSE() + * Browse() * $STATUS$ * S * $COMPLIANCE$ diff --git a/harbour/doc/en/file.txt b/harbour/doc/en/file.txt index 6a2fcd58cd..2e8915fc1e 100644 --- a/harbour/doc/en/file.txt +++ b/harbour/doc/en/file.txt @@ -65,7 +65,7 @@ * on this function. Directory names and paths must be specified along * with the file that is to be opened. * - * If an error has occured, see the returns values from FERROR() for + * If an error has occurred, see the returns values from FERROR() for * possible reasons for the error. * $EXAMPLES$ * #include "fileio.ch" @@ -307,7 +307,7 @@ * * $DESCRIPTION$ * After every low-level file function,this function will return - * a value that provides additional informationon the status of + * a value that provides additional information on the status of * the last low-level file functions's performance. If the FERROR() * function returns a 0, no error was detected. Below is a table * of possibles values returned by the FERROR() function. @@ -389,11 +389,11 @@ * ; neither the SET DEFAULT not the SET PATH command controls * the performance of this function. If the drive or path is not used, * the function will look for the file only on the currently selected - * direcytory on the logged drive. + * directory on the logged drive. * * If the function is able to successfully delete the file from the * disk, the value of the function will be 0; otherwise a -1 will - * be returned. If not successfu, aditional information may be + * be returned. If not successfull, additional information may be * obtained by calling the FERROR() function. * * Note: Any file to be removed by FERASE() must still be closed. @@ -434,7 +434,7 @@ * New filename * $RETURNS$ - * If sucessful, a 0 will be returned otherwise, + * If successful, a 0 will be returned otherwise, * a -1 will be returned. * $DESCRIPTION$ * This function renames the specified file to . @@ -577,7 +577,7 @@ * exist. * Dos skeletons symbols may be used in the filename in , - * as may the drive and/or path name. If a path is not explicity + * as may the drive and/or path name. If a path is not explicitly * specified, FILE() will look for the file in the SET DEFAULT path, * then in each SET PATH path, until the file is found or there are * no more paths to search. The DOS PATH is never searched and the @@ -614,7 +614,7 @@ * * Number of bytes to read. * $RETURNS$ - * an characted expression + * an character expression * $DESCRIPTION$ * This function returns a character string of bytes from a * file whose DOS file handle is . @@ -676,7 +676,7 @@ * This command changes the name of to . Both * and must include a file extension. This command * if not affected by the SET PATH TO or SET DEFAULT TO commands;drive - * and directoy designaters must be specified if either file is in a + * and directory designates must be specified if either file is in a * directory other then the default drive and directory. * * If id currently open or if it previously exists, this @@ -787,7 +787,7 @@ * $DESCRIPTION$ * __TYPEFILE() function type the content of a text file on the screen * with an option to send this information also to the printer. The - * file is displayed as is without any headings or formating. + * file is displayed as is without any headings or formatting. * * If contain no path, __TYPEFILE() try to find the file first * in the SET DEFAULT directory and then in search all of the SET PATH @@ -853,7 +853,7 @@ * TYPE command type the content of a text file on the screen * with an option to send this information also to the printer or to * an alternate file. The file is displayed as is without any headings - * or formating. + * or formatting. * * If contain no path, TYPE try to find the file first in the * SET DEFAULT directory and then in search all of the SET PATH @@ -909,7 +909,7 @@ * Name of directory * $DESCRIPTION$ * This function yields the name of the current OS directory on a - * specified drive. If is not speficied, the currently logged + * specified drive. If is not specified, the currently logged * drive will be used. * This function should not return the leading and trailing @@ -954,7 +954,7 @@ * Both files must have the file extension included; the drive and the * directory names must also be specified if they are different from * the default drive and/or director. also can refer to a OS - * device (e.g. LPT1). This command does not obsert the SET PATH TO or + * device (e.g. LPT1). This command does not observe the SET PATH TO or * SET DEFAULT TO settings. * $EXAMPLES$ * COPY FILE C:\harbour\tests\adirtest.prg TO C:\temp\adirtest.prg @@ -1030,7 +1030,7 @@ * the number of the last error. * $DESCRIPTION$ * This function attempt to remove the specified directory in - * If this function fail, the it will return the last OS error code number. + * If this function fails, it will return the last OS error code number. * See FERROR() function for the description of the error. * $EXAMPLES$ * cDir := ".\backup" @@ -1072,7 +1072,7 @@ * the number of the last error. * $DESCRIPTION$ * This function attempt to change the current directory to the one - * specidied in . If this function fail, the it will return + * specified in . If this function fails, it will return * the last OS error code number. See FERROR() function for the * description of the error. * $EXAMPLES$ @@ -1114,13 +1114,13 @@ * the number of the last error. * $DESCRIPTION$ * This function attempt to create a new directory with the name contained - * in . If this function fail, the it will return the last OS + * in . If this function fails, it will return the last OS * error code number. See FERROR() function for the description of the * error * $EXAMPLES$ * cDir := "temp" * IF MakeDir( cDir ) == 0 - * ? "Directory", cDir, "successfully created + * ? "Directory", cDir, "successfully created" * ENDIF * $TESTS$ * See examples @@ -1158,7 +1158,7 @@ * This function attempts to access a drive. If the access to the drive * was successfull, it will return true (.T.), otherwise false(.F.). This * function is usefull for backup function, so you can determine if the - * drive that will recieve the backup data is ready or not. + * drive that will receive the backup data is ready or not. * $EXAMPLES$ * IF IsDisk( "A" ) * ? "Drive is ready "