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

doc cleanups

Browse Source
This commit is contained in:
Viktor Szakats
2013-03-24 23:47:36 +01:00
parent ea235e5477
commit 110d8a6749
3 changed files with 15 additions and 257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog.txt
View File

@@ -10,6 +10,11 @@
* Change, ! Fix, % Optimization, + Addition, - Removal, ; Comment
*/
2013-03-24 23:47 UTC+0100 Viktor Szakats (harbour syenar.net)
- contrib/hbmisc/doc/en/ht_doc.txt
* contrib/hbmisc/doc/en/ht_conv.txt
* doc cleanups
2013-03-24 23:38 UTC+0100 Viktor Szakats (harbour syenar.net)
* extras/hbdoc/_tmplates.prg
* extras/hbdoc/hbdoc.prg

20
contrib/hbmisc/doc/en/ht_conv.txt
View File

@@ -7,7 +7,7 @@
$ONELINER$
Check if the value is a Binary Number
$SYNTAX$
IsBin(<cN>) -><cNr>
IsBin( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> STRING TO BE CHECKED
$RETURNS$
@@ -29,7 +29,7 @@
$ONELINER$
Check if the value is a Octal Number
$SYNTAX$
IsOctal(<cN>) -><cNr>
IsOctal( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> STRING TO BE CHECKED
$RETURNS$
@@ -51,7 +51,7 @@
$ONELINER$
Check if the value is a Decimal Number
$SYNTAX$
IsDec(<cN>) -><cNr>
IsDec( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> STRING TO BE CHECKED
$RETURNS$
@@ -73,7 +73,7 @@
$ONELINER$
Check if the value is a Hexal Number
$SYNTAX$
IsHexa(<cN>) -><cNr>
IsHexa( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> STRING TO BE CHECKED
$RETURNS$
@@ -95,7 +95,7 @@
$ONELINER$
Converts a Decimal Value to Binary
$SYNTAX$
DecToBin(<cN>) -><cNr>
DecToBin( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> NUMBER TO BE CONVERTED
$RETURNS$
@@ -118,7 +118,7 @@
$ONELINER$
Converts a Decimal Value to Octal
$SYNTAX$
DecToOctal(<cN>) -><cNr>
DecToOctal( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> NUMBER TO BE CONVERTED
$RETURNS$
@@ -141,7 +141,7 @@
$ONELINER$
Converts a Decimal Value to Hexa
$SYNTAX$
DecToHexa(<cN>) -><cNr>
DecToHexa( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> NUMBER TO BE CONVERTED
$RETURNS$
@@ -164,7 +164,7 @@
$ONELINER$
Converts a Binary Value to Decimal
$SYNTAX$
BinToDec(<cN>) -><cNr>
BinToDec( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> NUMBER TO BE CONVERTED
$RETURNS$
@@ -187,7 +187,7 @@
$ONELINER$
Converts a Octal Value to Decimal
$SYNTAX$
OctalToDec(<cN>) -><cNr>
OctalToDec( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> NUMBER TO BE CONVERTED
$RETURNS$
@@ -210,7 +210,7 @@
$ONELINER$
Converts a Hexa Value to Decimal
$SYNTAX$
HexaToDec(<cN>) -><cNr>
HexaToDec( <cN> ) --> <cNr>
$ARGUMENTS$
<cN> NUMBER TO BE CONVERTED
$RETURNS$

247
contrib/hbmisc/doc/en/ht_doc.txt
View File

@@ -1,247 +0,0 @@
/* $DOC$
$NAME$
THtml()
$CATEGORY$
Harbour Tools
$ONELINER$
Html Class
$SYNTAX$
oHtml:=THtml():New(<cFile>) --> oHtm
$ARGUMENTS$
<cFile> Name of the Html file to create </par>
$RETURNS$
<oHtm> An instance of the THtml Class </par>
$DESCRIPTION$
THtml() is a class that creates an .html file of the same
name you pass to the constructor. </par>
The class methods are as follows: </par>
New(<cFile>) Create a new instance of the THtml class </par>
Close() Close the created file </par>
WriteTitle(<cTitle>) Write the file title </par>
WritePar(<cPar>) Writes a paragraph </par>
WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
WriteLink(<cLink>, <cName>) Write a link to another topic </par>
WriteText(<cText>) Write any text </par>
$EXAMPLES$
PROCEDURE Main()
LOCAL oHtm
oHtm := THtml():New( "www\harbour.html" )
oHtm:WriteTitle( "Harbour Reference Guide" )
oHtm:WritePar( "HARBOUR" )
oHtm:WriteLink( "OverView" )
oHtm:WriteLink( "License" )
oHtm:WriteLink( "http://www.gnu.org/copyleft/gpl" )
oHtm:WritePar( "See the Links Above" )
oHtm:Close()
RETURN
$STATUS$
R
$COMPLIANCE$
This is a new Harbour Tools class </par>
$PLATFORMS$
ALL </par>
$SEEALSO$
TCLASS()
$END$
*/
/* $DOC$
$NAME$
TOs2()
$CATEGORY$
Harbour Tools
$ONELINER$
OS/2 Documentation Class
$SYNTAX$
oNg:=TOs2():New(<cFile>) --> oOs2
$ARGUMENTS$
<cFile> Name of the IPF Source file to create </par>
$RETURNS$
<oOs2> An instance of the TOs2 Class </par>
$DESCRIPTION$
TOs2() is a class that creates the OS/2 IPF Source
of the same name you pass to the constructor. </par>
The class methods are as follows: </par>
New(<cFile>) Create a new instance of the TOs2 class </par>
Close() Close the created file </par>
WriteTitle(<cTopic>, <cTitle>) Write the file title </par>
WritePar(<cPar>) Write a paragraph </par>
WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
WriteLink(<cLink>) Write a link to another topic </par>
ScanLink(<clink>) Scan the aLinkRef array for a valid topic </par>
DosToOs2Text(<cText>) Convert a Dos string to a OS/2 String </par>
$EXAMPLES$
PROCEDURE Main()
LOCAL oNg
oNg := TOs2():New( "ngi\harbour.ngi" )
oNg:WriteTitle( "Harbour Reference Guide" )
oNg:WritePar( "HARBOUR" )
oNg:WriteLink( "OverView" )
oNg:WriteLink( "License" )
oNg:WritePar( "See the Links Above" )
oNg:Close()
RETURN
$STATUS$
R
$COMPLIANCE$
This is a new Harbour Tools class </par>
$PLATFORMS$
ALL </par>
$SEEALSO$
TNortonGuide()
$END$
*/
/* $DOC$
$NAME$
TNortonGuide()
$CATEGORY$
Harbour Tools
$ONELINER$
Norton Guide Class
$SYNTAX$
oNg:=TNortonGuide():New(<cFile>) --> oNg
$ARGUMENTS$
<cFile> Name of the Ng Source file to create </par>
$RETURNS$
<oNg> An instance of the TNortonGuide Class </par>
$DESCRIPTION$
TNortonGuide() is a class that creates the Norton Guide Source
Code of the same name you pass to the constructor. </par>
The class methods are as follows: </par>
New(<cFile>) Create an instance of the TNortonGuide class </par>
Close() Close the created file </par>
WriteTitle(<cTopic>, <cTitle>) Write the file title </par>
WritePar(<cPar>) Write a paragraph </par>
WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
WriteLink(<cLink>) Write a link to another topic </par>
$EXAMPLES$
PROCEDURE Main()
LOCAL oNg
oNg := TNortonGuide():New( "ngi\harbour.ngi" )
oNg:WriteTitle( "Harbour Reference Guide" )
oNg:WritePar( "HARBOUR" )
oNg:WriteLink( "OverView" )
oNg:WriteLink( "License" )
oNg:WritePar( "See the Links Above" )
oNg:Close()
RETURN
$STATUS$
R
$COMPLIANCE$
This is a new Harbour Tools class </par>
$PLATFORMS$
ALL </par>
$SEEALSO$
TTroff(), TRtf(), THtml(), TOs2()
$END$
*/
/* $DOC$
$NAME$
TRtf()
$CATEGORY$
Harbour Tools
$ONELINER$
Rtf Class
$SYNTAX$
oNg:=TRtf():New(<cFile>) --> oRtf
$ARGUMENTS$
<cFile> Name of the RTF file to create </par>
$RETURNS$
<oRtf> An instance of the TRtf Class </par>
$DESCRIPTION$
TRtf() is a class that creates the RTF Documentation Source
Code of the same name you pass to the constructor. </par>
The class methods are as follows: </par>
New(<cFile>) Create a new instance of the TRtf class </par>
Close() Close the create file </par>
WriteTitle(<cTopic>, <cTitle>) Write the file title </par>
WritePar(<cPar>) Write a paragraph </par>
WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
WriteLink(<cLink>) Write a link to another topic </par>
WriteHeader() Write the RTF header </par>
EndPar() Write the end paragraph delimiter </par>
$EXAMPLES$
PROCEDURE Main()
LOCAL oRtf
oRtf := TRtf():New( "rtf\harbour.rtf" )
oRtf:WriteHeader()
oRtf:WriteTitle( "Harbour Reference Guide" )
oRtf:WritePar( "HARBOUR" ):Endpar()
oRtf:WriteLink( "OverView" )
oRtf:WriteLink( "License" )
oRtf:WritePar( "See the Links Above" ):EndPar()
oRtf:Close()
RETURN
$STATUS$
R
$COMPLIANCE$
This is a new Harbour Tools class </par>
$PLATFORMS$
ALL </par>
$SEEALSO$
TNortonGuide()
$END$
*/
/* $DOC$
$NAME$
TTroff()
$CATEGORY$
Harbour Tools
$ONELINER$
Troff Class
$SYNTAX$
oTroff:=TTrof():New(<cFile>) --> oTrf
$ARGUMENTS$
<cFile> Name of the Troff file to create </par>
$RETURNS$
<oTrf> instance of the TTroff Class </par>
$DESCRIPTION$
TTroff() is a class that creates the TROFF Documentation Source
Code of the same name you pass to the constructor. </par>
The class methods are as follows: </par>
New(<cFile>) Create a new instance of the THtml class
Close() Close the created file </par>
WriteTitle(<cTopic>, <cTitle>) Write the file title </par>
WritePar(<cPar>) Write a paragraph </par>
WriteParBold(<cPar>) Same as WritePar(), but the text is bold </par>
WriteLink(<cLink>) Write a link to another topic </par>
WriteText() Writes text without formating </par>
$EXAMPLES$
PROCEDURE Main()
LOCAL oTroff
oTroff := TTroff():New( "tr\harbour.ngi" )
oTroff:WriteTitle( "Harbour Reference Guide" )
oTroff:WritePar( "HARBOUR" )
oTroff:WriteLink( "OverView" )
oTroff:WriteLink( "License" )
oTroff:WritePar( "See the Links Above" )
oTroff:Close()
RETURN
$STATUS$
R
$COMPLIANCE$
This is a new Harbour Tools class </par>
$PLATFORMS$
ALL </par>
$SEEALSO$
TNortonGuide()
$END$
*/