From 110d8a67490538f1b5ea48fd4d81459db4b9e7e6 Mon Sep 17 00:00:00 2001 From: Viktor Szakats Date: Sun, 24 Mar 2013 23:47:36 +0100 Subject: [PATCH] doc cleanups --- ChangeLog.txt | 5 + contrib/hbmisc/doc/en/ht_conv.txt | 20 +-- contrib/hbmisc/doc/en/ht_doc.txt | 247 ------------------------------ 3 files changed, 15 insertions(+), 257 deletions(-) delete mode 100644 contrib/hbmisc/doc/en/ht_doc.txt diff --git a/ChangeLog.txt b/ChangeLog.txt index a0e51e28f6..a5b3e3ae04 100644 --- a/ChangeLog.txt +++ b/ChangeLog.txt @@ -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 diff --git a/contrib/hbmisc/doc/en/ht_conv.txt b/contrib/hbmisc/doc/en/ht_conv.txt index c499b41599..f32a0d9ec9 100644 --- a/contrib/hbmisc/doc/en/ht_conv.txt +++ b/contrib/hbmisc/doc/en/ht_conv.txt @@ -7,7 +7,7 @@ $ONELINER$ Check if the value is a Binary Number $SYNTAX$ - IsBin() -> + IsBin( ) --> $ARGUMENTS$ STRING TO BE CHECKED $RETURNS$ @@ -29,7 +29,7 @@ $ONELINER$ Check if the value is a Octal Number $SYNTAX$ - IsOctal() -> + IsOctal( ) --> $ARGUMENTS$ STRING TO BE CHECKED $RETURNS$ @@ -51,7 +51,7 @@ $ONELINER$ Check if the value is a Decimal Number $SYNTAX$ - IsDec() -> + IsDec( ) --> $ARGUMENTS$ STRING TO BE CHECKED $RETURNS$ @@ -73,7 +73,7 @@ $ONELINER$ Check if the value is a Hexal Number $SYNTAX$ - IsHexa() -> + IsHexa( ) --> $ARGUMENTS$ STRING TO BE CHECKED $RETURNS$ @@ -95,7 +95,7 @@ $ONELINER$ Converts a Decimal Value to Binary $SYNTAX$ - DecToBin() -> + DecToBin( ) --> $ARGUMENTS$ NUMBER TO BE CONVERTED $RETURNS$ @@ -118,7 +118,7 @@ $ONELINER$ Converts a Decimal Value to Octal $SYNTAX$ - DecToOctal() -> + DecToOctal( ) --> $ARGUMENTS$ NUMBER TO BE CONVERTED $RETURNS$ @@ -141,7 +141,7 @@ $ONELINER$ Converts a Decimal Value to Hexa $SYNTAX$ - DecToHexa() -> + DecToHexa( ) --> $ARGUMENTS$ NUMBER TO BE CONVERTED $RETURNS$ @@ -164,7 +164,7 @@ $ONELINER$ Converts a Binary Value to Decimal $SYNTAX$ - BinToDec() -> + BinToDec( ) --> $ARGUMENTS$ NUMBER TO BE CONVERTED $RETURNS$ @@ -187,7 +187,7 @@ $ONELINER$ Converts a Octal Value to Decimal $SYNTAX$ - OctalToDec() -> + OctalToDec( ) --> $ARGUMENTS$ NUMBER TO BE CONVERTED $RETURNS$ @@ -210,7 +210,7 @@ $ONELINER$ Converts a Hexa Value to Decimal $SYNTAX$ - HexaToDec() -> + HexaToDec( ) --> $ARGUMENTS$ NUMBER TO BE CONVERTED $RETURNS$ diff --git a/contrib/hbmisc/doc/en/ht_doc.txt b/contrib/hbmisc/doc/en/ht_doc.txt deleted file mode 100644 index a228ecc132..0000000000 --- a/contrib/hbmisc/doc/en/ht_doc.txt +++ /dev/null @@ -1,247 +0,0 @@ - -/* $DOC$ - $NAME$ - THtml() - $CATEGORY$ - Harbour Tools - $ONELINER$ - Html Class - $SYNTAX$ - oHtml:=THtml():New() --> oHtm - $ARGUMENTS$ - Name of the Html file to create - $RETURNS$ - An instance of the THtml Class - $DESCRIPTION$ - THtml() is a class that creates an .html file of the same - name you pass to the constructor. - The class methods are as follows: - New() Create a new instance of the THtml class - Close() Close the created file - WriteTitle() Write the file title - WritePar() Writes a paragraph - WriteParBold() Same as WritePar(), but the text is bold - WriteLink(, ) Write a link to another topic - WriteText() Write any text - $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 - $PLATFORMS$ - ALL - $SEEALSO$ - TCLASS() - $END$ - */ - -/* $DOC$ - $NAME$ - TOs2() - $CATEGORY$ - Harbour Tools - $ONELINER$ - OS/2 Documentation Class - $SYNTAX$ - oNg:=TOs2():New() --> oOs2 - $ARGUMENTS$ - Name of the IPF Source file to create - $RETURNS$ - An instance of the TOs2 Class - $DESCRIPTION$ - TOs2() is a class that creates the OS/2 IPF Source - of the same name you pass to the constructor. - The class methods are as follows: - New() Create a new instance of the TOs2 class - Close() Close the created file - WriteTitle(, ) Write the file title - WritePar() Write a paragraph - WriteParBold() Same as WritePar(), but the text is bold - WriteLink() Write a link to another topic - ScanLink() Scan the aLinkRef array for a valid topic - DosToOs2Text() Convert a Dos string to a OS/2 String - $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 - $PLATFORMS$ - ALL - $SEEALSO$ - TNortonGuide() - $END$ - */ - -/* $DOC$ - $NAME$ - TNortonGuide() - $CATEGORY$ - Harbour Tools - $ONELINER$ - Norton Guide Class - $SYNTAX$ - oNg:=TNortonGuide():New() --> oNg - $ARGUMENTS$ - Name of the Ng Source file to create - $RETURNS$ - An instance of the TNortonGuide Class - $DESCRIPTION$ - TNortonGuide() is a class that creates the Norton Guide Source - Code of the same name you pass to the constructor. - The class methods are as follows: - New() Create an instance of the TNortonGuide class - Close() Close the created file - WriteTitle(, ) Write the file title - WritePar() Write a paragraph - WriteParBold() Same as WritePar(), but the text is bold - WriteLink() Write a link to another topic - $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 - $PLATFORMS$ - ALL - $SEEALSO$ - TTroff(), TRtf(), THtml(), TOs2() - $END$ - */ - -/* $DOC$ - $NAME$ - TRtf() - $CATEGORY$ - Harbour Tools - $ONELINER$ - Rtf Class - $SYNTAX$ - oNg:=TRtf():New() --> oRtf - $ARGUMENTS$ - Name of the RTF file to create - $RETURNS$ - An instance of the TRtf Class - $DESCRIPTION$ - TRtf() is a class that creates the RTF Documentation Source - Code of the same name you pass to the constructor. - The class methods are as follows: - New() Create a new instance of the TRtf class - Close() Close the create file - WriteTitle(, ) Write the file title - WritePar() Write a paragraph - WriteParBold() Same as WritePar(), but the text is bold - WriteLink() Write a link to another topic - WriteHeader() Write the RTF header - EndPar() Write the end paragraph delimiter - $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 - $PLATFORMS$ - ALL - $SEEALSO$ - TNortonGuide() - $END$ - */ - -/* $DOC$ - $NAME$ - TTroff() - $CATEGORY$ - Harbour Tools - $ONELINER$ - Troff Class - $SYNTAX$ - oTroff:=TTrof():New() --> oTrf - $ARGUMENTS$ - Name of the Troff file to create - $RETURNS$ - instance of the TTroff Class - $DESCRIPTION$ - TTroff() is a class that creates the TROFF Documentation Source - Code of the same name you pass to the constructor. - The class methods are as follows: - New() Create a new instance of the THtml class - Close() Close the created file - WriteTitle(, ) Write the file title - WritePar() Write a paragraph - WriteParBold() Same as WritePar(), but the text is bold - WriteLink() Write a link to another topic - WriteText() Writes text without formating - $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 - $PLATFORMS$ - ALL - $SEEALSO$ - TNortonGuide() - $END$ - */