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

2012-11-15 19:41 UTC+0100 Viktor Szakats (harbour syenar.net)

Browse Source 
* contrib/hbct/doc/en/atnum.txt
  * contrib/hbct/doc/en/ctstr.txt
  * contrib/hbct/doc/en/token1.txt
  * contrib/hbct/doc/en/token2.txt
  * contrib/hbct/doc/en/trig.txt
    ! some fixes to prev. (my regex is not yet perfect)
This commit is contained in:
Viktor Szakats
2012-11-15 18:42:23 +00:00
parent 873f90f31a
commit 781419604b
6 changed files with 83 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
harbour/ChangeLog
View File

@@ -16,6 +16,14 @@
The license applies to all entries newer than 2009-04-28.
*/
2012-11-15 19:41 UTC+0100 Viktor Szakats (harbour syenar.net)
* contrib/hbct/doc/en/atnum.txt
* contrib/hbct/doc/en/ctstr.txt
* contrib/hbct/doc/en/token1.txt
* contrib/hbct/doc/en/token2.txt
* contrib/hbct/doc/en/trig.txt
! some fixes to prev. (my regex is not yet perfect)
2012-11-15 19:10 UTC+0100 Viktor Szakats (harbour syenar.net)
* contrib/hbct/doc/en/*.txt
* contrib/hbgd/doc/en/hbgd.txt

18
harbour/contrib/hbct/doc/en/atnum.txt
View File

@@ -54,19 +54,19 @@
$FILES$
Library is libct.
$SEEALSO$
AtNum(),BEFORAtNum(),CSetAtMupa(),SetAtLike()
AtNum(),BeforAtNum(),CSetAtMupa(),SetAtLike()
$END$
*/
/* $DOC$
$NAME$
BEFORAtNum()
BeforAtNum()
$CATEGORY$
CT3 string functions
$ONELINER$
Returns string portion before nth occurence of substring
$SYNTAX$
BEFORAtNum( <cStringToMatch>, <cString>, [<nCounter>],
BeforAtNum( <cStringToMatch>, <cString>, [<nCounter>],
[<nIgnore>] ) --> cRestString
$ARGUMENTS$
<cStringToMatch> is the substring scanned for
@@ -94,17 +94,17 @@
second character of the matched substring otherwise.
The function will also consider the settings of SetAtLike().
$EXAMPLES$
? BEFORAtNum( "!", "What is the answer ? 4 ! 5 !" ) // -> "What is the answer ? 4 ! 5 "
? BEFORAtNum( "!", "What is the answer ? 4 ! 5 ?" ) // -> "What is the answer ? 4 "
? BeforAtNum( "!", "What is the answer ? 4 ! 5 !" ) // -> "What is the answer ? 4 ! 5 "
? BeforAtNum( "!", "What is the answer ? 4 ! 5 ?" ) // -> "What is the answer ? 4 "
<TODO: add some examples here with CSetAtMupa() and SetAtLike()>
$TESTS$
BEFORAtNum( "..", "..This..is..a..test!" ) == "..This..is..a"
BEFORAtNum( "..", "..This..is..a..test!", 2 ) == "..This"
BEFORAtNum( "..", "..This..is..a..test!", 2, 2 ) == "..This..is"
BeforAtNum( "..", "..This..is..a..test!" ) == "..This..is..a"
BeforAtNum( "..", "..This..is..a..test!", 2 ) == "..This"
BeforAtNum( "..", "..This..is..a..test!", 2, 2 ) == "..This..is"
$STATUS$
Ready
$COMPLIANCE$
BEFORAtNum() is compatible with CT3's BEFORAtNum().
BeforAtNum() is compatible with CT3's BeforAtNum().
$PLATFORMS$
All
$FILES$

6
harbour/contrib/hbct/doc/en/ctstr.txt
View File

@@ -82,7 +82,7 @@
$DESCRIPTION$
CSETATMUPA determines how the following CT3 string functions
AtNum() AFTERAtNum() BEFORAtNum()
AtNum() AfterAtNum() BeforAtNum()
AtRepl() NumAt() AtAdjust()
WordToChar() WordRepl()
@@ -102,7 +102,7 @@
$FILES$
Library is libct.
$SEEALSO$
AtNum() AFTERAtNum() BEFORAtNum()
AtNum() AfterAtNum() BeforAtNum()
AtRepl() NumAt() AtAdjust()
WordToChar() WordRepl()
$END$
@@ -135,7 +135,7 @@
In the following CT3 functions, strings are compared on a character
base:
AtAdjust() AtNum() AFTERAtNum()
AtAdjust() AtNum() AfterAtNum()
BEFOREAtNum() AtRepl() NumAt()
StrDiff()

22
harbour/contrib/hbct/doc/en/token1.txt
View File

@@ -60,7 +60,7 @@
$FILES$
Library is libct.
$SEEALSO$
Token(),NUMToken(),TokenLower(),TokenUpper(),TokenSep()
Token(),NumToken(),TokenLower(),TokenUpper(),TokenSep()
$END$
*/
@@ -129,19 +129,19 @@
$FILES$
Library is libct.
$SEEALSO$
NUMToken(),AtToken(),TokenLower(),TokenUpper(),TokenSep()
NumToken(),AtToken(),TokenLower(),TokenUpper(),TokenSep()
$END$
*/
/* $DOC$
$NAME$
NUMToken()
NumToken()
$CATEGORY$
CT3 string functions
$ONELINER$
Retrieves the number of tokens in a string
$SYNTAX$
NUMToken( <cString>, [<cTokenizer>], [<nSkipWidth>] ) -> nTokenCount
NumToken( <cString>, [<cTokenizer>], [<nSkipWidth>] ) -> nTokenCount
$ARGUMENTS$
$RETURNS$
@@ -151,13 +151,13 @@
$EXAMPLES$
$TESTS$
numToken( "Hello, World!" ) == 2
numToken( "This is good. See you! How do you do?", ".!?" ) == 3
numToken( "one,,three,four,,six", ",", 1 ) == 6
NumToken( "Hello, World!" ) == 2
NumToken( "This is good. See you! How do you do?", ".!?" ) == 3
NumToken( "one,,three,four,,six", ",", 1 ) == 6
$STATUS$
Ready
$COMPLIANCE$
NUMToken() is compatible with CT3's NUMToken().
NumToken() is compatible with CT3's NumToken().
$PLATFORMS$
All
$FILES$
@@ -225,7 +225,7 @@
$FILES$
Library is libct.
$SEEALSO$
Token(),NUMToken(),AtToken(),TokenUpper(),TokenSep(),CSetRef()
Token(),NumToken(),AtToken(),TokenUpper(),TokenSep(),CSetRef()
$END$
*/
@@ -287,7 +287,7 @@
$FILES$
Library is libct.
$SEEALSO$
Token(),NUMToken(),AtToken(),TokenLower(),TokenSep(),CSetRef()
Token(),NumToken(),AtToken(),TokenLower(),TokenSep(),CSetRef()
$END$
*/
@@ -328,6 +328,6 @@
$FILES$
Library is libct.
$SEEALSO$
Token(),NUMToken(),AtToken(),TokenLower(),TokenUpper()
Token(),NumToken(),AtToken(),TokenLower(),TokenUpper()
$END$
*/

34
harbour/contrib/hbct/doc/en/token2.txt
View File

@@ -82,7 +82,7 @@
$FILES$
Library is libct.
$SEEALSO$
Token(),TokenExit(),TokenNext(),TokenNum(),TokenAt(),SAVEToken(),RESTToken(),TokenEnd()
Token(),TokenExit(),TokenNext(),TokenNum(),TokenAt(),SaveToken(),RestToken(),TokenEnd()
$END$
*/
@@ -141,7 +141,7 @@
$FILES$
Library is libct.
$SEEALSO$
TokenInit(),TokenExit(),TokenNum(),TokenAt(),SAVEToken(),RESTToken(),TokenEnd()
TokenInit(),TokenExit(),TokenNum(),TokenAt(),SaveToken(),RestToken(),TokenEnd()
$END$
*/
@@ -178,7 +178,7 @@
$FILES$
Library is libct.
$SEEALSO$
TokenInit(),TokenExit(),TokenNext(),TokenAt(),SAVEToken(),RESTToken(),TokenEnd()
TokenInit(),TokenExit(),TokenNext(),TokenAt(),SaveToken(),RestToken(),TokenEnd()
$END$
*/
@@ -222,7 +222,7 @@
$FILES$
Library is libct.
$SEEALSO$
TokenInit(),TokenExit(),TokenNext(),TokenNum(),TokenAt(),SAVEToken(),RESTToken()
TokenInit(),TokenExit(),TokenNext(),TokenNum(),TokenAt(),SaveToken(),RestToken()
$END$
*/
@@ -262,7 +262,7 @@
$FILES$
Library is libct.
$SEEALSO$
TokenInit(),TokenNext(),TokenNum(),TokenAt(),SAVEToken(),RESTToken(),TokenEnd()
TokenInit(),TokenNext(),TokenNum(),TokenAt(),SaveToken(),RestToken(),TokenEnd()
$END$
*/
@@ -319,25 +319,25 @@
$FILES$
Library is libct.
$SEEALSO$
TokenInit(),TokenExit(),TokenNext(),TokenNum(),SAVEToken(),RESTToken(),TokenEnd()
TokenInit(),TokenExit(),TokenNext(),TokenNum(),SaveToken(),RestToken(),TokenEnd()
$END$
*/
/* $DOC$
$NAME$
SAVEToken()
SaveToken()
$CATEGORY$
CT3 string functions
$ONELINER$
Save the global token environment
$SYNTAX$
SAVEToken() -> cStaticTokenEnvironment
SaveToken() -> cStaticTokenEnvironment
$ARGUMENTS$
$RETURNS$
<cStaticTokenEnvironment> a binary string encoding the global TE
$DESCRIPTION$
The SAVEToken() function can be used to store the global TE for future
The SaveToken() function can be used to store the global TE for future
use or when two or more incremental tokenizers must the nested.
Note however that the latter can now be solved with locally stored
token environments.
@@ -348,33 +348,33 @@
$STATUS$
Ready
$COMPLIANCE$
SAVEToken() is compatible with CTIII's SAVEToken(),
SaveToken() is compatible with CTIII's SaveToken(),
$PLATFORMS$
All
$FILES$
Library is libct.
$SEEALSO$
TokenInit(),TokenExit(),TokenNext(),TokenNum(),TokenAt(),RESTToken(),TokenEnd()
TokenInit(),TokenExit(),TokenNext(),TokenNum(),TokenAt(),RestToken(),TokenEnd()
$END$
*/
/* $DOC$
$NAME$
RESTToken()
RestToken()
$CATEGORY$
CT3 string functions
$ONELINER$
Restore global token environment
$SYNTAX$
RESTToken( <cStaticTokenEnvironment> ) -> cOldStaticEnvironment
RestToken( <cStaticTokenEnvironment> ) -> cOldStaticEnvironment
$ARGUMENTS$
<cStaticTokenEnvironment> a binary string encoding a TE
$RETURNS$
<cOldStaticEnvironment> a string encoding the old global TE
$DESCRIPTION$
The RESTToken() function restores the global TE to the one encoded
The RestToken() function restores the global TE to the one encoded
in <cStaticTokenEnvironment>. This can either be the return value
of SAVEToken() or the value stored in the 4th parameter in a
of SaveToken() or the value stored in the 4th parameter in a
TokenInit() call.
$EXAMPLES$
@@ -383,12 +383,12 @@
$STATUS$
Ready
$COMPLIANCE$
RESTToken() is compatible with CTIII's RESTToken(),
RestToken() is compatible with CTIII's RestToken(),
$PLATFORMS$
All
$FILES$
Library is libct.
$SEEALSO$
TokenInit(),TokenExit(),TokenNext(),TokenNum(),TokenAt(),SAVEToken(),TokenEnd()
TokenInit(),TokenExit(),TokenNext(),TokenNum(),TokenAt(),SaveToken(),TokenEnd()
$END$
*/

70
harbour/contrib/hbct/doc/en/trig.txt
View File

@@ -35,7 +35,7 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ASin(),ACos(),ATan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR()
Sin(),Cos(),Tan(),Cot(),Asin(),ACos(),Atan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR()
$END$
*/
@@ -75,7 +75,7 @@
$FILES$
Library is libct.
$SEEALSO$
Cos(),Tan(),Cot(),ASin(),ACos(),ATan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
Cos(),Tan(),Cot(),Asin(),ACos(),Atan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
@@ -115,7 +115,7 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Tan(),Cot(),ASin(),ACos(),ATan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
Sin(),Tan(),Cot(),Asin(),ACos(),Atan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
@@ -155,7 +155,7 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Cot(),ASin(),ACos(),ATan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
Sin(),Cos(),Cot(),Asin(),ACos(),Atan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
@@ -193,48 +193,48 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),ASin(),ACos(),ATan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
Sin(),Cos(),Tan(),Asin(),ACos(),Atan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
/* $DOC$
$NAME$
ASin()
Asin()
$CATEGORY$
CT3 math functions
$ONELINER$
Arcus sine of the argument
$SYNTAX$
ASin( nSine ) -> nRadiant
Asin( nSine ) -> nRadiant
$ARGUMENTS$
<nSine> the sine of an angle
$RETURNS$
<nRadiant> the angle whose sine is <nSine>
$DESCRIPTION$
The function ASin() is the inverse function of Sin(). It takes a
The function Asin() is the inverse function of Sin(). It takes a
sine value and returns the smallest(!) angle whose sine equals to the argument.
The return value is given in radiants (full angle equals 2*Pi -
see DToR() if you need to convert it into degress).
Note, that <nSine> must be between -1 and 1 and that <nRadiant>
is always between -Pi()/2 and Pi()/2.
$EXAMPLES$
? aSin( 0.0 ) // --> 0.0
? aSin( 0.5 ) // --> 0.5235...
? Asin( 0.0 ) // --> 0.0
? Asin( 0.5 ) // --> 0.5235...
$TESTS$
aSin( 0.0 ) == 0.0
aSin( Sqrt( 1 / 2 ) ) == Pi() / 4
aSin( 1.0 ) == Pi() / 2
aSin( 0.0 ) == 0.0 // and not Pi(), since the smallest angle is returned !
Asin( 0.0 ) == 0.0
Asin( Sqrt( 1 / 2 ) ) == Pi() / 4
Asin( 1.0 ) == Pi() / 2
Asin( 0.0 ) == 0.0 // and not Pi(), since the smallest angle is returned !
$STATUS$
Ready
$COMPLIANCE$
ASin() is compatible with CT3's ASin().
Asin() is compatible with CT3's Asin().
$PLATFORMS$
All
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ACos(),ATan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
Sin(),Cos(),Tan(),Cot(),ACos(),Atan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
@@ -276,13 +276,13 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ASin(),ATan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
Sin(),Cos(),Tan(),Cot(),Asin(),Atan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
/* $DOC$
$NAME$
ATan()
Atan()
$CATEGORY$
CT3 math functions
$ONELINER$
@@ -294,27 +294,27 @@
$RETURNS$
<nRadiant> the angle whose tangent is <nTangent>
$DESCRIPTION$
The function ATan() is the inverse function of Tan(). It takes a
The function Atan() is the inverse function of Tan(). It takes a
tangent value and returns the smallest(!) angle whose tangent equals to the argument.
The return value is given in radiants between -Pi()/2 and Pi()/2
(full angle equals 2*Pi - see DToR() if you need to convert it into degress).
$EXAMPLES$
? aTan( 0.0 ) // --> 0.0
? aTan( 0.5 ) // --> 0.4636...
? Atan( 0.0 ) // --> 0.0
? Atan( 0.5 ) // --> 0.4636...
$TESTS$
aTan( 0.0 ) == 0.0
aTan( 1.0 ) == Pi() / 4
aTan( 0.0 ) == 0.0 // and not Pi(), although Tan( Pi() ) == 0.0 !
Atan( 0.0 ) == 0.0
Atan( 1.0 ) == Pi() / 4
Atan( 0.0 ) == 0.0 // and not Pi(), although Tan( Pi() ) == 0.0 !
$STATUS$
Ready
$COMPLIANCE$
ATan() is compatible with CT3's ATan().
Atan() is compatible with CT3's Atan().
$PLATFORMS$
All
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ASin(),ACos(),ATan(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
Sin(),Cos(),Tan(),Cot(),Asin(),ACos(),Atan(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
@@ -334,9 +334,9 @@
<nRadiant> the angle whose tangent is <nSine>/<nCosine>
$DESCRIPTION$
The function Atn2() is an alternate function for calculating
the arcus tangent, Atn2(x,y) = aTan(x/y).
the arcus tangent, Atn2(x,y) = Atan(x/y).
It takes two arguments, the sine and the cosine
of the angle that should be calculated. Thus, in contrast to the ATan()
of the angle that should be calculated. Thus, in contrast to the Atan()
function, Atn2() can distinguish whether the sine or the cosine has
a negative sign (or both being positive or negative), so that
the return value can be between -Pi() and Pi() and covers the full
@@ -349,7 +349,7 @@
$TESTS$
Atn2( 0.0, 1.0 ) == 0.0
Atn2( Sqrt( 1 / 2 ), Sqrt( 1 / 2 ) ) == Pi() / 4
Atn2( -Sqrt( 1 / 2 ), -Sqrt( 1 / 2 ) ) == -3 / 4 * Pi() // aTan() would return Pi() / 4 !
Atn2( -Sqrt( 1 / 2 ), -Sqrt( 1 / 2 ) ) == -3 / 4 * Pi() // Atan() would return Pi() / 4 !
$STATUS$
Ready
$COMPLIANCE$
@@ -359,7 +359,7 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ASin(),ACos(),ATan(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
Sin(),Cos(),Tan(),Cot(),Asin(),ACos(),Atan(),Sinh(),Cosh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
@@ -398,7 +398,7 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ASin(),ACos(),ATan(),Atn2(),Cosh(),Tanh(),RToD(),DToR(),Pi()
Sin(),Cos(),Tan(),Cot(),Asin(),ACos(),Atan(),Atn2(),Cosh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
@@ -437,7 +437,7 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ASin(),ACos(),ATan(),Atn2(),Sinh(),Tanh(),RToD(),DToR(),Pi()
Sin(),Cos(),Tan(),Cot(),Asin(),ACos(),Atan(),Atn2(),Sinh(),Tanh(),RToD(),DToR(),Pi()
$END$
*/
@@ -472,7 +472,7 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ASin(),ACos(),ATan(),Atn2(),Sinh(),Cosh(),RToD(),DToR(),Pi()
Sin(),Cos(),Tan(),Cot(),Asin(),ACos(),Atan(),Atn2(),Sinh(),Cosh(),RToD(),DToR(),Pi()
$END$
*/
@@ -508,7 +508,7 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ASin(),ACos(),ATan(),Atn2(),Sinh(),Cosh(),Tanh(),DToR(),Pi()
Sin(),Cos(),Tan(),Cot(),Asin(),ACos(),Atan(),Atn2(),Sinh(),Cosh(),Tanh(),DToR(),Pi()
$END$
*/
@@ -543,6 +543,6 @@
$FILES$
Library is libct.
$SEEALSO$
Sin(),Cos(),Tan(),Cot(),ASin(),ACos(),ATan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),Pi()
Sin(),Cos(),Tan(),Cot(),Asin(),ACos(),Atan(),Atn2(),Sinh(),Cosh(),Tanh(),RToD(),Pi()
$END$
*/