fivedev/harbour-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cleanups and fixes in comments/docs mostly

Browse Source
This commit is contained in:
vszakats
2013-03-16 17:38:53 +01:00
parent 90f84f6472
commit 80ff78d719
17 changed files with 58 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
ChangeLog.txt
View File

@@ -10,6 +10,25 @@
* Change, ! Fix, % Optimization, + Addition, - Removal, ; Comment * 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) 2013-03-16 16:59 UTC+0100 Viktor Szakats (harbour syenar.net)
* contrib/hbct/screen2.c * contrib/hbct/screen2.c
! fixed to use HB_SIZE instead of int ! fixed to use HB_SIZE instead of int

2
bin/commit.hb
View File

@@ -2,7 +2,7 @@
* Harbour Project source code: * Harbour Project source code:
* Commit preparer * Commit preparer
* *
* Copyright 2012 Viktor Szakats (harbour syenar.net) * Copyright 2012-2013 Viktor Szakats (harbour syenar.net)
* www - http://harbour-project.org * www - http://harbour-project.org
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify

2
contrib/hbblat/tests/test.prg
View File

@@ -84,7 +84,7 @@ PROCEDURE Main()
oBlat:lRequestReturnReceipt := .T. oBlat:lRequestReturnReceipt := .T.
oBlat:cAttachTextFiles := "f_subjct.txt" 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:cAttachListTextFile := "f_listtx.txt"
oBlat:cLogFile := "log.txt" oBlat:cLogFile := "log.txt"

22
contrib/hbmisc/doc/en/ht_file.txt
View File

@@ -7,11 +7,11 @@
$ONELINER$ $ONELINER$
Change the Current Directory Change the Current Directory
$SYNTAX$ $SYNTAX$
CD(<cDir>) --> lSuccess CD( <cDir> ) --> lSuccess
$ARGUMENTS$ $ARGUMENTS$
<cDir> DIR TO BE CHANGED <cDir> DIR TO BE CHANGED
$RETURNS$ $RETURNS$
<lSucess> .T. IF SUCESSFUL; otherwise .F. <lSucess> .T. IF SUCCESSFUL; otherwise .F.
$DESCRIPTION$ $DESCRIPTION$
CHANGE THE CURRENT DIRECTORY CHANGE THE CURRENT DIRECTORY
$EXAMPLES$ $EXAMPLES$
@@ -21,7 +21,7 @@
RETURN .F. RETURN .F.
ENDIF ENDIF
$FILES$ $FILES$
Header is Fileio.ch Header is fileio.ch
$SEEALSO$ $SEEALSO$
MD(),RD() MD(),RD()
$END$ $END$
@@ -35,13 +35,13 @@
$ONELINER$ $ONELINER$
Creates a Directory Creates a Directory
$SYNTAX$ $SYNTAX$
MD(<cDir>) -> <lSucess> MD( <cDir> ) -> <lSucess>
$ARGUMENTS$ $ARGUMENTS$
<cDir> DIRECTORY TO BE CREATED <cDir> DIRECTORY TO BE CREATED
$RETURNS$ $RETURNS$
<lSucess> .T. IF SUCESSFUL; otherwise .F. <lSucess> .T. IF SUCCESSFUL; otherwise .F.
$DESCRIPTION$ $DESCRIPTION$
CREATE A DIRECTORY CREATE A DIRECTORY
$EXAMPLES$ $EXAMPLES$
IF MD( "OLA" ) IF MD( "OLA" )
RETURN .T. RETURN .T.
@@ -49,7 +49,7 @@
RETURN .F. RETURN .F.
ENDIF ENDIF
$FILES$ $FILES$
Header is Fileio.ch Header is fileio.ch
$SEEALSO$ $SEEALSO$
CD(),MD() CD(),MD()
$END$ $END$
@@ -63,13 +63,13 @@
$ONELINER$ $ONELINER$
Remove a Directory Remove a Directory
$SYNTAX$ $SYNTAX$
RD(<cDir>) --> <lSucess> RD( <cDir> ) --> <lSucess>
$ARGUMENTS$ $ARGUMENTS$
<cDir> DIR TO BE DELETED <cDir> DIR TO BE DELETED
$RETURNS$ $RETURNS$
<lSucess> .T. IF SUCESSFUL; otherwise .F. <lSucess> .T. IF SUCCESSFUL; otherwise .F.
$DESCRIPTION$ $DESCRIPTION$
REMOVE A DIRECTORY REMOVE A DIRECTORY
$EXAMPLES$ $EXAMPLES$
IF RD( "OLA" ) IF RD( "OLA" )
RETURN .T. RETURN .T.
@@ -77,7 +77,7 @@
RETURN .F. RETURN .F.
ENDIF ENDIF
$FILES$ $FILES$
Header is Fileio.ch Header is fileio.ch
$SEEALSO$ $SEEALSO$
CD(),MD() CD(),MD()
$END$ $END$

7
contrib/hbmysql/diff-en.txt
View File

@@ -1,13 +1,10 @@
2004-02
February 2004
I.Q. David Arturo Macias Corona I.Q. David Arturo Macias Corona
Modifications Modifications
tmysql.prg Program *****************************************
Class TMySQLRow --------------------------------------------- Class TMySQLRow ---------------------------------------------
- DATA new TMySQLRow:aOriValue - DATA new TMySQLRow:aOriValue
Store originals values of aRow, during creation of TMySQLRow object Store originals values of aRow, during creation of TMySQLRow object
@@ -237,8 +234,6 @@ Class TMySQLTable -------------------------------------------
corresponding to field name corresponding to field name
Program tsqlbrw.prg ************************************
- Skipper() - Skipper()
Modification of movement control in order to apply new definitions of Modification of movement control in order to apply new definitions of
TMySQLQuery:Bof() and TMySQLQuery:Eof() TMySQLQuery:Bof() and TMySQLQuery:Eof()

2
contrib/hbnf/doc/en/video1.txt
View File

@@ -60,7 +60,7 @@
on screen in a specified color attribute. This function is useful on screen in a specified color attribute. This function is useful
for constructing screens with a lot of text or repetitive screen prints for constructing screens with a lot of text or repetitive screen prints
where speed is important. It is faster and requires less memory than 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$ $EXAMPLES$
FOR nX := 1 TO MaxRow() FOR nX := 1 TO MaxRow()
FOR nY := 1 TO MaxCol() FOR nY := 1 TO MaxCol()

3
contrib/hbnf/doc/en/woy.txt
View File

@@ -77,8 +77,5 @@
// last day of year // last day of year
nDayNum := ft_DoY( hb_SToD( "19911231" ) ) // result: 365 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$ $END$
*/ */

4
contrib/hbnf/tests/datecnfg.prg
View File

@@ -55,8 +55,8 @@ PROCEDURE Main()
#if 0 #if 0
aTemp := ft_DateCnfg( "1980-01-03", 1 ) // Date string in user's format. aTemp := ft_DateCnfg( "1980-01-03", 1 ) // Date string in user's format.
#endif #endif
cFY_Start := aTemp[ 1 ] // See ft_DateCnfg() in ft_date0.prg cFY_Start := aTemp[ 1 ] // See ft_DateCnfg()
nDOW_Start := ATEMP[ 2 ] // FOR PARAMETERS. nDOW_Start := aTemp[ 2 ] // for parameters.
dDate := Date() - 500 dDate := Date() - 500
CLS CLS

1
contrib/hbtip/ftpcli.prg
View File

@@ -73,7 +73,6 @@
Cleaned unused variables. Cleaned unused variables.
2007-09-08 21:34 UTC+0100 Patrick Mast <patrick/dot/mast/at/xharbour.com> 2007-09-08 21:34 UTC+0100 Patrick Mast <patrick/dot/mast/at/xharbour.com>
* source\tip\ftpcln.prg
* Formatting * Formatting
+ METHOD StartCleanLogFile() + METHOD StartCleanLogFile()
Starts a clean log file, overwriting current logfile. Starts a clean log file, overwriting current logfile.

1
doc/Makefile
View File

@@ -1,3 +1,4 @@
ROOT := ../ ROOT := ../
DOC_FILES := \ DOC_FILES := \

4
doc/en/diskspac.txt
View File

@@ -39,7 +39,7 @@
$EXAMPLES$ $EXAMPLES$
? "You can use : " + hb_ntos( DiskSpace() ) + " bytes " ? "You can use : " + hb_ntos( DiskSpace() ) + " bytes "
Note: See tests\tstdspac.prg for another example Note: See tests/diskspac.prg for another example
$STATUS$ $STATUS$
R R
$COMPLIANCE$ $COMPLIANCE$
@@ -101,7 +101,7 @@
? "You can use : " + hb_ntos( hb_DiskSpace() ) + " bytes " +; ? "You can use : " + hb_ntos( hb_DiskSpace() ) + " bytes " +;
"Out of a total of " + hb_ntos( hb_DiskSpace( "C:", HB_FS_TOTAL ) ) "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$ $STATUS$
R R
$COMPLIANCE$ $COMPLIANCE$

4
doc/en/file.txt
View File

@@ -952,8 +952,8 @@
device (e.g. LPT1). This command does not observe the SET PATH TO or device (e.g. LPT1). This command does not observe the SET PATH TO or
SET DEFAULT TO settings. SET DEFAULT TO settings.
$EXAMPLES$ $EXAMPLES$
COPY FILE C:\harbour\tests\adirtest.prg TO C:\temp\adirtest.prg COPY FILE C:\harbour\tests\adir.prg TO C:\temp\adir.prg
COPY FILE C:\harbour\tests\adirtest.prg TO LPT1 COPY FILE C:\harbour\tests\adir.prg TO LPT1
$STATUS$ $STATUS$
R R
$COMPLIANCE$ $COMPLIANCE$

4
doc/en/hbflock.txt
View File

@@ -44,7 +44,7 @@
r an error has occurred or the lock has been obtained) by r an error has occurred or the lock has been obtained) by
g Ox0200 to the above values. g Ox0200 to the above values.
$EXAMPLES$ $EXAMPLES$
refer to tfl.prg refer to tests/tflock.prg
$STATUS$ $STATUS$
R R
$COMPLIANCE$ $COMPLIANCE$
@@ -94,7 +94,7 @@
<nBytes> is the length of the region to be unlocked in bytes. <nBytes> is the length of the region to be unlocked in bytes.
$EXAMPLES$ $EXAMPLES$
refer to tfl.prg refer to tests/tflock.prg
$STATUS$ $STATUS$
R R
$COMPLIANCE$ $COMPLIANCE$

4
doc/en/set.txt
View File

@@ -903,7 +903,7 @@
value of the logical expression <lWrap> is a logical false (.F.), value of the logical expression <lWrap> is a logical false (.F.),
the wrapping mode is set OFF; otherwise,it is set ON. the wrapping mode is set OFF; otherwise,it is set ON.
$EXAMPLES$ $EXAMPLES$
See tests/menutest.prg See tests/menuto.prg
$STATUS$ $STATUS$
R R
$COMPLIANCE$ $COMPLIANCE$
@@ -946,7 +946,7 @@
witch suppresses all messages output. witch suppresses all messages output.
The British spelling of CENTRE is also supported. The British spelling of CENTRE is also supported.
$EXAMPLES$ $EXAMPLES$
See tests/menutest.prg See tests/menuto.prg
$STATUS$ $STATUS$
R R
$COMPLIANCE$ $COMPLIANCE$

2
doc/en/tbrowse.txt
View File

@@ -167,7 +167,7 @@
DispCell( nColumn, cColor ) Displays a single cell DispCell( nColumn, cColor ) Displays a single cell
$EXAMPLES$ $EXAMPLES$
See tests/testbrw.prg See tests/tbrowse.prg
$STATUS$ $STATUS$
S S
$COMPLIANCE$ $COMPLIANCE$

6
doc/pcode.txt
View File

@@ -2,7 +2,7 @@
The Clipper OBJ and pcode model (GNU|Open|Clipper project) 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() 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() of pcode bytes contained in the array pcode[] = { ... }. All our MAIN()
function does is invoke, at run-time, a Clipper VirtualMachine() that will function does is invoke, at run-time, a Clipper VirtualMachine() that will
process those pcode bytes. 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 0000 (2A) LINE 0 2A 00 00
0003 (2A) LINE 3 2A 03 00 0003 (2A) LINE 3 2A 03 00

18
tests/db_brows.prg
View File

@@ -108,7 +108,7 @@ PROCEDURE Main( filename )
// //
// Function DBFLIST() // 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() // 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() // Function VIVNAMES()
// //
// Called from ( db_brows.prg ) 3 - function dbflist() // Called from 3 - function dbflist()
// //
// -------------------------------------------------------------------- // --------------------------------------------------------------------
@@ -513,7 +513,7 @@ FUNCTION VIVNAMES( mslist )
// //
// Function WNDVIVOD() // 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() // Static Procedure VIVSTR()
// //
// Called from ( db_brows.prg ) 5 - function dbflist() // Called from 5 - function dbflist()
// 1 - function wndvivod() // 1 - function wndvivod()
// //
// -------------------------------------------------------------------- // --------------------------------------------------------------------
@@ -596,7 +596,7 @@ STATIC PROCEDURE VIVSTR( mslist, nstroka, vybfld )
// //
// Function FLDSTR() // Function FLDSTR()
// //
// Called from ( db_brows.prg ) 1 - function dbflist() // Called from 1 - function dbflist()
// 1 - function fldcount() // 1 - function fldcount()
// 1 - function vivnames() // 1 - function vivnames()
// 3 - static procedure vivstr() // 3 - static procedure vivstr()
@@ -651,7 +651,7 @@ FUNCTION FLDSTR( mslist, numf )
// //
// Function InitList() // Function InitList()
// //
// Called from ( db_brows.prg ) 1 - PROCEDURE Main() // Called from 1 - PROCEDURE Main()
// 1 - function dbflist() // 1 - function dbflist()
// //
// -------------------------------------------------------------------- // --------------------------------------------------------------------
@@ -685,7 +685,7 @@ FUNCTION InitList
// //
// Function Defpict() // 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() // Function NUM_STR()
// //
// Called from ( db_brows.prg ) 1 - function defpict() // Called from 1 - function defpict()
// //
// -------------------------------------------------------------------- // --------------------------------------------------------------------