Skip to content

Commit

Permalink
The JCL help is not intended to provide documentation for API wrappers.
Browse files Browse the repository at this point in the history
Update help version numbers to JCL 2.3.
  • Loading branch information
outchy committed Sep 20, 2010
1 parent 203b533 commit d4c1dc8
Show file tree
Hide file tree
Showing 16 changed files with 99 additions and 68 deletions.
64 changes: 32 additions & 32 deletions help/JCLHelp.dox
Original file line number Diff line number Diff line change
Expand Up @@ -28361,7 +28361,7 @@ ControlPointSize=6
GraphBorder=0
LayoutDirection=1
LevelSpacing=30
MaxNodeWidth=200
MaxNodeWidth=350
MinNodeHeight=15
MinNodeWidth=30
NodesAdjustWidthToGrid=0
Expand All @@ -28383,8 +28383,8 @@ Style=0
BackgroundColor=16777215
BorderColor=0
GradientBaseColor=10070188
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=1
Style=0
StyleOptions=7
Expand All @@ -28394,7 +28394,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand All @@ -28410,8 +28410,8 @@ Top=2
BackgroundColor=13434829
BorderColor=0
GradientBaseColor=11197867
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=1
Style=0
StyleOptions=7
Expand All @@ -28421,7 +28421,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand All @@ -28437,8 +28437,8 @@ Top=2
BackgroundColor=13434829
BorderColor=0
GradientBaseColor=11197867
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=1
Style=0
StyleOptions=7
Expand All @@ -28448,7 +28448,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand All @@ -28464,8 +28464,8 @@ Top=2
BackgroundColor=16764313
BorderColor=0
GradientBaseColor=14527351
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=1
Style=0
StyleOptions=7
Expand All @@ -28475,7 +28475,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand All @@ -28491,8 +28491,8 @@ Top=2
BackgroundColor=131071
BorderColor=0
GradientBaseColor=56797
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=0
Style=3
StyleOptions=7
Expand All @@ -28502,7 +28502,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand All @@ -28518,8 +28518,8 @@ Top=2
BackgroundColor=131071
BorderColor=0
GradientBaseColor=56797
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=0
Style=3
StyleOptions=7
Expand All @@ -28529,7 +28529,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand All @@ -28545,8 +28545,8 @@ Top=2
BackgroundColor=16777215
BorderColor=0
GradientBaseColor=10070188
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=1
Style=0
StyleOptions=7
Expand All @@ -28556,7 +28556,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand All @@ -28572,8 +28572,8 @@ Top=2
BackgroundColor=52479
BorderColor=0
GradientBaseColor=43741
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=1
Style=2
StyleOptions=7
Expand All @@ -28583,7 +28583,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand All @@ -28599,8 +28599,8 @@ Top=2
BackgroundColor=3394407
BorderColor=0
GradientBaseColor=1157445
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=1
Style=0
StyleOptions=7
Expand All @@ -28610,7 +28610,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand All @@ -28626,8 +28626,8 @@ Top=2
BackgroundColor=16777215
BorderColor=0
GradientBaseColor=10070188
HighlightColor=-2147483635
HighlightFontColor=-2147483634
HighlightColor=-16777203
HighlightFontColor=-16777202
Show=1
Style=0
StyleOptions=7
Expand All @@ -28637,7 +28637,7 @@ TextAlignment=0
Charset=1
Color=0
Height=-9
Name=Tahoma
Name=Segoe UI
Orientation=0
Pitch=0
Size=7
Expand Down Expand Up @@ -136632,7 +136632,7 @@ Title=JEDI Code Library
TypeDefStructsAsStructs=1
VersionBuild=0
VersionMajor=2
VersionMinor=2
VersionMinor=3
VersionRelease=0

[Generic Sources]
Expand Down
15 changes: 5 additions & 10 deletions help/NTFS.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -755,16 +755,11 @@ See also:
NtfsGetReparsePoint
Donator:
Marcel van Brakel
@@_REPARSE_GUID_DATA_BUFFER.ReparseTag
Reparse tag. This member uniquely identifies the structure of the reparse data.
@@_REPARSE_GUID_DATA_BUFFER.ReparseDataLength
Size, in bytes, of the data in the GenericReparseBuffer member.
@@_REPARSE_GUID_DATA_BUFFER.Reserved
Reserved.
@@_REPARSE_GUID_DATA_BUFFER.ReparseGuid
GUID which uniquely identifies the kind of reparse tag.
@@_REPARSE_GUID_DATA_BUFFER.GenericReparseBuffer
User defined data for the reparse point.
@@TReparseGuidDataBuffer
<GROUP FilesandIO.FileSystems.NTFS>
<COMBINE _REPARSE_GUID_DATA_BUFFER>
Expand Down
23 changes: 6 additions & 17 deletions help/Win32.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -1179,20 +1179,9 @@ See also:
SHDllGetVersion
Donator:
Marcel van Brakel
@@_DLLVERSIONINFO.cbSize
Set to the size of this record. Initialize is done by SHDllGetVersion.
@@_DLLVERSIONINFO.dwMajorVersion
Major version of the DLL
@@_DLLVERSIONINFO.dwMinorVersion
Minor version of the DLL
@@_DLLVERSIONINFO.dwBuildNumber
Build number of the DLL
@@_DLLVERSIONINFO.dwPlatformId
Identifies the platform for which this DLL was built. Can be
DLLVER_PLATFORM_WINDOWS or DLLVER_PLATFORM_NT which indicate
generic Windows and Windows NT respectively.
@@DLLVERSIONINFO
<COMBINE _DLLVERSIONINFO>
@@TDllVersionInfo
<COMBINE _DLLVERSIONINFO>
--------------------------------------------------------------------------------






4 changes: 4 additions & 0 deletions jcl/source/common/bzip2.pas
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ interface
{$ENDIF UNITVERSIONING}
JclBase; // PByte, PCardinal for Delphi 5 and C++Builder 5...

//DOM-IGNORE-BEGIN

{
/*-------------------------------------------------------------*/
/*--- Public header file for the library. ---*/
Expand Down Expand Up @@ -303,6 +305,8 @@ function BZ2_bzerror(b: BZFILE; errnum: PInteger): PChar;
var
bz2_internal_error_event: procedure(errcode: Integer) of object = nil;

//DOM-IGNORE-END

function LoadBZip2: Boolean;
function IsBZip2Loaded: Boolean;
procedure UnloadBZip2;
Expand Down
4 changes: 4 additions & 0 deletions jcl/source/common/pcre.pas
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ interface
{$ENDIF UNITVERSIONING}
JclBase;

//DOM-IGNORE-BEGIN

(*************************************************
* Perl-Compatible Regular Expressions *
*************************************************)
Expand Down Expand Up @@ -579,6 +581,8 @@ function pcre_version: PAnsiChar; {$IFDEF PCRE_EXPORT_CDECL} cdecl; {$ENDIF PCRE

{$ENDIF PCRE_LINKONREQUEST}

//DOM-IGNORE-END

function IsPCRELoaded: Boolean;
function LoadPCRE: Boolean;
procedure UnloadPCRE;
Expand Down
4 changes: 4 additions & 0 deletions jcl/source/common/zlibh.pas
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ interface
{$ENDIF UNITVERSIONING}
JclBase;

//DOM-IGNORE-BEGIN

{$IFNDEF FPC}
type
{$IFDEF UNIX}
Expand Down Expand Up @@ -2018,6 +2020,8 @@ function get_crc_table():PuLongf;
DEF_MEM_LEVEL = 8;
{$EXTERNALSYM DEF_MEM_LEVEL}

//DOM-IGNORE-END

function IsZLibLoaded: Boolean;
function LoadZLib: Boolean;
procedure UnloadZLib;
Expand Down
7 changes: 7 additions & 0 deletions jcl/source/prototypes/Hardlinks.pas
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,9 @@ interface
{$DEFINE RTDL // Use runtime dynamic linking }
{$DEFINE PREFERAPI // Prefer the "real" Windows API on systems on which it exists
// If this is defined STDCALL is automatically needed and defined! }

//DOM-IGNORE-BEGIN

{$ENDIF JCL}

(*
Expand Down Expand Up @@ -228,6 +231,10 @@ function CreateHardLinkA(szLinkName, szLinkTarget: PAnsiChar; lpSecurityAttribut
bRtdlFunctionsLoaded: Boolean = False; // To show wether the RTDL functions had been loaded
{$ENDIF RTDL}

{$IFDEF JCL}
//DOM-IGNORE-END
{$ENDIF JCL}

{$IFDEF UNITVERSIONING}
const
UnitVersioning: TUnitVersionInfo = (
Expand Down
4 changes: 4 additions & 0 deletions jcl/source/prototypes/JclWin32.pas
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ EJclWin32Error = class(EJclError)
end;
{$ENDIF MSWINDOWS}

//DOM-IGNORE-BEGIN

{$I win32api\WinDef.int}
{$I win32api\WinNT.int}
{$I win32api\WinBase.int}
Expand Down Expand Up @@ -137,6 +139,8 @@ EJclWin32Error = class(EJclError)
{$I win32api\TlHelp32.int}
{$I win32api\Winternl.int}

//DOM-IGNORE-END

{$IFDEF MSWINDOWS}

const
Expand Down
5 changes: 5 additions & 0 deletions jcl/source/windows/Hardlinks.pas
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ interface
{$I jcl.inc}


//DOM-IGNORE-BEGIN


(*
All possible combinations of the above DEFINEs have been tested and work fine.
Expand Down Expand Up @@ -90,6 +93,8 @@ interface
hNtDll: THandle = 0; // For runtime dynamic linking
bRtdlFunctionsLoaded: Boolean = False; // To show wether the RTDL functions had been loaded

//DOM-IGNORE-END

{$IFDEF UNITVERSIONING}
const
UnitVersioning: TUnitVersionInfo = (
Expand Down
Loading

0 comments on commit d4c1dc8

Please sign in to comment.