From 80ff78d719a59f4958e6618744d79c0dd50b6026 Mon Sep 17 00:00:00 2001 From: vszakats Date: Sat, 16 Mar 2013 17:38:53 +0100 Subject: [PATCH] cleanups and fixes in comments/docs mostly --- ChangeLog.txt | 19 +++++++++++++++++++ bin/commit.hb | 2 +- contrib/hbblat/tests/test.prg | 2 +- contrib/hbmisc/doc/en/ht_file.txt | 22 +++++++++++----------- contrib/hbmysql/diff-en.txt | 7 +------ contrib/hbnf/doc/en/video1.txt | 2 +- contrib/hbnf/doc/en/woy.txt | 3 --- contrib/hbnf/tests/datecnfg.prg | 4 ++-- contrib/hbtip/ftpcli.prg | 1 - doc/Makefile | 1 + doc/en/diskspac.txt | 4 ++-- doc/en/file.txt | 4 ++-- doc/en/hbflock.txt | 4 ++-- doc/en/set.txt | 4 ++-- doc/en/tbrowse.txt | 2 +- doc/pcode.txt | 6 +++--- tests/db_brows.prg | 18 +++++++++--------- 17 files changed, 58 insertions(+), 47 deletions(-) diff --git a/ChangeLog.txt b/ChangeLog.txt index e132dba4d4..d715d9646c 100644 --- a/ChangeLog.txt +++ b/ChangeLog.txt @@ -10,6 +10,25 @@ * Change, ! Fix, % Optimization, + Addition, - Removal, ; Comment */ +2013-03-16 17:38 UTC+0100 Viktor Szakats (harbour syenar.net) + * bin/commit.hb + * contrib/hbblat/tests/test.prg + * contrib/hbmisc/doc/en/ht_file.txt + * contrib/hbmysql/diff-en.txt + * contrib/hbnf/doc/en/video1.txt + * contrib/hbnf/doc/en/woy.txt + * contrib/hbnf/tests/datecnfg.prg + * contrib/hbtip/ftpcli.prg + * doc/en/diskspac.txt + * doc/en/file.txt + * doc/en/hbflock.txt + * doc/en/set.txt + * doc/en/tbrowse.txt + * doc/Makefile + * doc/pcode.txt + * tests/db_brows.prg + ! cleanups and fixes in comments/docs mostly + 2013-03-16 16:59 UTC+0100 Viktor Szakats (harbour syenar.net) * contrib/hbct/screen2.c ! fixed to use HB_SIZE instead of int diff --git a/bin/commit.hb b/bin/commit.hb index 80aa13dff2..21b8cfbb9c 100644 --- a/bin/commit.hb +++ b/bin/commit.hb @@ -2,7 +2,7 @@ * Harbour Project source code: * Commit preparer * - * Copyright 2012 Viktor Szakats (harbour syenar.net) + * Copyright 2012-2013 Viktor Szakats (harbour syenar.net) * www - http://harbour-project.org * * This program is free software; you can redistribute it and/or modify diff --git a/contrib/hbblat/tests/test.prg b/contrib/hbblat/tests/test.prg index 957ed16300..7bb9fe033c 100644 --- a/contrib/hbblat/tests/test.prg +++ b/contrib/hbblat/tests/test.prg @@ -84,7 +84,7 @@ PROCEDURE Main() oBlat:lRequestReturnReceipt := .T. oBlat:cAttachTextFiles := "f_subjct.txt" - oBlat:aAttachTextFiles := { "f_ps.txt", "blattest.prg", "blatcmd.prg" } + oBlat:aAttachTextFiles := { __FILE__, "blatcmd.prg", "f_ps.txt" } oBlat:cAttachListTextFile := "f_listtx.txt" oBlat:cLogFile := "log.txt" diff --git a/contrib/hbmisc/doc/en/ht_file.txt b/contrib/hbmisc/doc/en/ht_file.txt index d9e4d5b243..f75c379593 100644 --- a/contrib/hbmisc/doc/en/ht_file.txt +++ b/contrib/hbmisc/doc/en/ht_file.txt @@ -7,11 +7,11 @@ $ONELINER$ Change the Current Directory $SYNTAX$ - CD() --> lSuccess + CD( ) --> lSuccess $ARGUMENTS$ DIR TO BE CHANGED $RETURNS$ - .T. IF SUCESSFUL; otherwise .F. + .T. IF SUCCESSFUL; otherwise .F. $DESCRIPTION$ CHANGE THE CURRENT DIRECTORY $EXAMPLES$ @@ -21,7 +21,7 @@ RETURN .F. ENDIF $FILES$ - Header is Fileio.ch + Header is fileio.ch $SEEALSO$ MD(),RD() $END$ @@ -35,13 +35,13 @@ $ONELINER$ Creates a Directory $SYNTAX$ - MD() -> + MD( ) -> $ARGUMENTS$ DIRECTORY TO BE CREATED $RETURNS$ - .T. IF SUCESSFUL; otherwise .F. + .T. IF SUCCESSFUL; otherwise .F. $DESCRIPTION$ - CREATE A DIRECTORY + CREATE A DIRECTORY $EXAMPLES$ IF MD( "OLA" ) RETURN .T. @@ -49,7 +49,7 @@ RETURN .F. ENDIF $FILES$ - Header is Fileio.ch + Header is fileio.ch $SEEALSO$ CD(),MD() $END$ @@ -63,13 +63,13 @@ $ONELINER$ Remove a Directory $SYNTAX$ - RD() --> + RD( ) --> $ARGUMENTS$ DIR TO BE DELETED $RETURNS$ - .T. IF SUCESSFUL; otherwise .F. + .T. IF SUCCESSFUL; otherwise .F. $DESCRIPTION$ - REMOVE A DIRECTORY + REMOVE A DIRECTORY $EXAMPLES$ IF RD( "OLA" ) RETURN .T. @@ -77,7 +77,7 @@ RETURN .F. ENDIF $FILES$ - Header is Fileio.ch + Header is fileio.ch $SEEALSO$ CD(),MD() $END$ diff --git a/contrib/hbmysql/diff-en.txt b/contrib/hbmysql/diff-en.txt index 56e383b26b..959c2b4da2 100644 --- a/contrib/hbmysql/diff-en.txt +++ b/contrib/hbmysql/diff-en.txt @@ -1,13 +1,10 @@ - -February 2004 +2004-02 I.Q. David Arturo Macias Corona Modifications -tmysql.prg Program ***************************************** - Class TMySQLRow --------------------------------------------- - DATA new TMySQLRow:aOriValue Store originals values of aRow, during creation of TMySQLRow object @@ -237,8 +234,6 @@ Class TMySQLTable ------------------------------------------- corresponding to field name -Program tsqlbrw.prg ************************************ - - Skipper() Modification of movement control in order to apply new definitions of TMySQLQuery:Bof() and TMySQLQuery:Eof() diff --git a/contrib/hbnf/doc/en/video1.txt b/contrib/hbnf/doc/en/video1.txt index d60dc398e5..cf9f89129a 100644 --- a/contrib/hbnf/doc/en/video1.txt +++ b/contrib/hbnf/doc/en/video1.txt @@ -60,7 +60,7 @@ on screen in a specified color attribute. This function is useful for constructing screens with a lot of text or repetitive screen prints where speed is important. It is faster and requires less memory than - ft_VidStr(). A working example is contained in clrtable.prg. + ft_VidStr(). $EXAMPLES$ FOR nX := 1 TO MaxRow() FOR nY := 1 TO MaxCol() diff --git a/contrib/hbnf/doc/en/woy.txt b/contrib/hbnf/doc/en/woy.txt index 0e252b3492..0af49f215d 100644 --- a/contrib/hbnf/doc/en/woy.txt +++ b/contrib/hbnf/doc/en/woy.txt @@ -77,8 +77,5 @@ // last day of year nDayNum := ft_DoY( hb_SToD( "19911231" ) ) // result: 365 - - // For a demonstration of this function, compile and link the - // program woy.prg in the Nanforum Toolkit source code. $END$ */ diff --git a/contrib/hbnf/tests/datecnfg.prg b/contrib/hbnf/tests/datecnfg.prg index 3ba2745584..5076846a67 100644 --- a/contrib/hbnf/tests/datecnfg.prg +++ b/contrib/hbnf/tests/datecnfg.prg @@ -55,8 +55,8 @@ PROCEDURE Main() #if 0 aTemp := ft_DateCnfg( "1980-01-03", 1 ) // Date string in user's format. #endif - cFY_Start := aTemp[ 1 ] // See ft_DateCnfg() in ft_date0.prg - nDOW_Start := ATEMP[ 2 ] // FOR PARAMETERS. + cFY_Start := aTemp[ 1 ] // See ft_DateCnfg() + nDOW_Start := aTemp[ 2 ] // for parameters. dDate := Date() - 500 CLS diff --git a/contrib/hbtip/ftpcli.prg b/contrib/hbtip/ftpcli.prg index f315277604..fa9ba63285 100644 --- a/contrib/hbtip/ftpcli.prg +++ b/contrib/hbtip/ftpcli.prg @@ -73,7 +73,6 @@ Cleaned unused variables. 2007-09-08 21:34 UTC+0100 Patrick Mast - * source\tip\ftpcln.prg * Formatting + METHOD StartCleanLogFile() Starts a clean log file, overwriting current logfile. diff --git a/doc/Makefile b/doc/Makefile index fdc8c0e818..dd3519f4d3 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,3 +1,4 @@ + ROOT := ../ DOC_FILES := \ diff --git a/doc/en/diskspac.txt b/doc/en/diskspac.txt index ad23877e2f..4806804929 100644 --- a/doc/en/diskspac.txt +++ b/doc/en/diskspac.txt @@ -39,7 +39,7 @@ $EXAMPLES$ ? "You can use : " + hb_ntos( DiskSpace() ) + " bytes " - Note: See tests\tstdspac.prg for another example + Note: See tests/diskspac.prg for another example $STATUS$ R $COMPLIANCE$ @@ -101,7 +101,7 @@ ? "You can use : " + hb_ntos( hb_DiskSpace() ) + " bytes " +; "Out of a total of " + hb_ntos( hb_DiskSpace( "C:", HB_FS_TOTAL ) ) - Note: See tests\tstdspac.prg for another example + Note: See tests/diskspac.prg for another example $STATUS$ R $COMPLIANCE$ diff --git a/doc/en/file.txt b/doc/en/file.txt index 8dfb959bf4..4902ee1793 100644 --- a/doc/en/file.txt +++ b/doc/en/file.txt @@ -952,8 +952,8 @@ 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 - COPY FILE C:\harbour\tests\adirtest.prg TO LPT1 + COPY FILE C:\harbour\tests\adir.prg TO C:\temp\adir.prg + COPY FILE C:\harbour\tests\adir.prg TO LPT1 $STATUS$ R $COMPLIANCE$ diff --git a/doc/en/hbflock.txt b/doc/en/hbflock.txt index 6456094ec6..d69f3b8457 100644 --- a/doc/en/hbflock.txt +++ b/doc/en/hbflock.txt @@ -44,7 +44,7 @@ r an error has occurred or the lock has been obtained) by g Ox0200 to the above values. $EXAMPLES$ - refer to tfl.prg + refer to tests/tflock.prg $STATUS$ R $COMPLIANCE$ @@ -94,7 +94,7 @@ is the length of the region to be unlocked in bytes. $EXAMPLES$ - refer to tfl.prg + refer to tests/tflock.prg $STATUS$ R $COMPLIANCE$ diff --git a/doc/en/set.txt b/doc/en/set.txt index 23efa7b330..fdb92ed23d 100644 --- a/doc/en/set.txt +++ b/doc/en/set.txt @@ -903,7 +903,7 @@ value of the logical expression is a logical false (.F.), the wrapping mode is set OFF; otherwise,it is set ON. $EXAMPLES$ - See tests/menutest.prg + See tests/menuto.prg $STATUS$ R $COMPLIANCE$ @@ -946,7 +946,7 @@ witch suppresses all messages output. The British spelling of CENTRE is also supported. $EXAMPLES$ - See tests/menutest.prg + See tests/menuto.prg $STATUS$ R $COMPLIANCE$ diff --git a/doc/en/tbrowse.txt b/doc/en/tbrowse.txt index 19b6e03d08..28b03e6e06 100644 --- a/doc/en/tbrowse.txt +++ b/doc/en/tbrowse.txt @@ -167,7 +167,7 @@ DispCell( nColumn, cColor ) Displays a single cell $EXAMPLES$ - See tests/testbrw.prg + See tests/tbrowse.prg $STATUS$ S $COMPLIANCE$ diff --git a/doc/pcode.txt b/doc/pcode.txt index 98fcd64ab9..22947eb8dc 100644 --- a/doc/pcode.txt +++ b/doc/pcode.txt @@ -2,7 +2,7 @@ The Clipper OBJ and pcode model (GNU|Open|Clipper project) ========================================================== -Let's consider the following Clipper sample Test.prg: +Let's consider the following Clipper sample test.prg: FUNCTION Main() @@ -27,12 +27,12 @@ void MAIN( void ) } -Basically, Test.prg source code has been converted into a sequence +Basically, test.prg source code has been converted into a sequence of pcode bytes contained in the array pcode[] = { ... }. All our MAIN() function does is invoke, at run-time, a Clipper VirtualMachine() that will process those pcode bytes. -Let's review the Test.prg pcode structure in more detail: +Let's review the test.prg pcode structure in more detail: 0000 (2A) LINE 0 2A 00 00 0003 (2A) LINE 3 2A 03 00 diff --git a/tests/db_brows.prg b/tests/db_brows.prg index 807bc490c5..5940eddebd 100644 --- a/tests/db_brows.prg +++ b/tests/db_brows.prg @@ -108,7 +108,7 @@ PROCEDURE Main( filename ) // // Function DBFLIST() // -// Called from ( db_brows.prg ) 1 - PROCEDURE Main() +// Called from 1 - PROCEDURE Main() // // -------------------------------------------------------------------- @@ -450,7 +450,7 @@ FUNCTION DBFLIST( mslist, x1, y1, x2, y2, title, maskey ) // // Function FLDCOUNT() // -// Called from ( db_brows.prg ) 6 - function dbflist() +// Called from 6 - function dbflist() // // -------------------------------------------------------------------- @@ -477,7 +477,7 @@ FUNCTION FLDCOUNT( mslist, xstrt, xend, fld1 ) // // Function VIVNAMES() // -// Called from ( db_brows.prg ) 3 - function dbflist() +// Called from 3 - function dbflist() // // -------------------------------------------------------------------- @@ -513,7 +513,7 @@ FUNCTION VIVNAMES( mslist ) // // Function WNDVIVOD() // -// Called from ( db_brows.prg ) 8 - function dbflist() +// Called from 8 - function dbflist() // // -------------------------------------------------------------------- @@ -546,7 +546,7 @@ FUNCTION WNDVIVOD( mslist ) // // Static Procedure VIVSTR() // -// Called from ( db_brows.prg ) 5 - function dbflist() +// Called from 5 - function dbflist() // 1 - function wndvivod() // // -------------------------------------------------------------------- @@ -596,7 +596,7 @@ STATIC PROCEDURE VIVSTR( mslist, nstroka, vybfld ) // // Function FLDSTR() // -// Called from ( db_brows.prg ) 1 - function dbflist() +// Called from 1 - function dbflist() // 1 - function fldcount() // 1 - function vivnames() // 3 - static procedure vivstr() @@ -651,7 +651,7 @@ FUNCTION FLDSTR( mslist, numf ) // // Function InitList() // -// Called from ( db_brows.prg ) 1 - PROCEDURE Main() +// Called from 1 - PROCEDURE Main() // 1 - function dbflist() // // -------------------------------------------------------------------- @@ -685,7 +685,7 @@ FUNCTION InitList // // Function Defpict() // -// Called from ( db_brows.prg ) 1 - function dbflist() +// Called from 1 - function dbflist() // // -------------------------------------------------------------------- @@ -709,7 +709,7 @@ FUNCTION Defpict( mslist, i, maxlen ) // // Function NUM_STR() // -// Called from ( db_brows.prg ) 1 - function defpict() +// Called from 1 - function defpict() // // --------------------------------------------------------------------