Skip to content

Commit

Permalink
basic documentation for JCL packages/files/classes/interfaces/records…
Browse files Browse the repository at this point in the history
…/types/variables/constants.
  • Loading branch information
outchy committed Jun 16, 2011
1 parent a77b1f2 commit 568a4aa
Show file tree
Hide file tree
Showing 5 changed files with 118 additions and 54 deletions.
60 changes: 60 additions & 0 deletions help/Common.dtx
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@

@@!!SYMREF
Summary
The list of packages in the JCL.
Description
The JCL is split into several packages, each one dedicated to
some feature family.

@@!!CLASSES
Summary
The list of classes in the JCL.
Description
This list contains all the classes declared in the JCL. Each
class member is then documented in its own page.

@@!!INTERFACES
Summary
The list of interfaces in the JCL.
Description
This list contains all the interfaces declared in the JCL.
Each interface member is then documented in its own page.

@@!!FUNCTIONS
Summary
The list of functions in the JCL.
Description
This list contains all the functions declared in the JCL.

@@!!RECORDS
Summary
The list of records and enumerations in the JCL.
Description
This list contains all the records and enumerations declared
in the JCL.

@@!!TYPES
Summary
The list of types in the JCL.
Description
This list contains all the types declared in the JCL.

@@!!VARIABLES
Summary
The list of global variables in the JCL.
Description
This list contains all the global variables declared in the
JCL.

@@!!CONSTANTS
Summary
The list of constants in the JCL.
Description
This list contains all the constants declared in the JCL.

@@!!FILES
Summary
The list of files in the JCL.
Description
This list contains all the files declared in the JCL. Each
file member is then documented in its own page.
87 changes: 44 additions & 43 deletions jcl/packages/help/Jcl.dox
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
; This is a Doc-O-Matic version 6.5.1.1382 project file.
; This is a Doc-O-Matic version 6.5.1.1382 project file.
; This file is maintained by Doc-O-Matic, do not edit manually.

[*Control*]
Expand Down Expand Up @@ -30,7 +30,7 @@ File0=..\..\..\help\VCL.doxdb
File1=..\..\..\help\JEDI.doxdb

[Source Files]
Count=152
Count=153
File0=..\..\source\include\crossplatform.inc
File1=..\..\source\include\jcl.inc
File2=..\..\source\include\jclc6.inc
Expand Down Expand Up @@ -142,47 +142,48 @@ File107=..\..\..\help\8087.dtx
File108=..\..\..\help\AppInst.dtx
File109=..\..\..\help\Base.dtx
File110=..\..\..\help\Com.dtx
File111=..\..\..\help\Complex.dtx
File112=..\..\..\help\Counter.dtx
File113=..\..\..\help\DateTime.dtx
File114=..\..\..\help\Debug.dtx
File115=..\..\..\help\ExprEval.dtx
File116=..\..\..\help\FileUtils.dtx
File117=..\..\..\help\Hardlinks.dtx
File118=..\..\..\help\IncludedFiles.dtx
File119=..\..\..\help\IniFiles.dtx
File120=..\..\..\help\Jcl.dtx
File121=..\..\..\help\LANMan.dtx
File122=..\..\..\help\Locales.dtx
File123=..\..\..\help\Logic.dtx
File124=..\..\..\help\Mapi.dtx
File125=..\..\..\help\Math.dtx
File126=..\..\..\help\Midi.dtx
File127=..\..\..\help\Mime.dtx
File128=..\..\..\help\Miscel.dtx
File129=..\..\..\help\Multimedia.dtx
File130=..\..\..\help\Notify.dtx
File131=..\..\..\help\NTFS.dtx
File132=..\..\..\help\pcre.dtx
File133=..\..\..\help\PE.dtx
File134=..\..\..\help\Registry.dtx
File135=..\..\..\help\RTTI.dtx
File136=..\..\..\help\Schedule.dtx
File137=..\..\..\help\Security.dtx
File138=..\..\..\help\Shell.dtx
File139=..\..\..\help\Statistics.dtx
File140=..\..\..\help\Streams.dtx
File141=..\..\..\help\StrHashMap.dtx
File142=..\..\..\help\Strings.dtx
File143=..\..\..\help\SvcCtrl.dtx
File144=..\..\..\help\Synch.dtx
File145=..\..\..\help\SysInfo.dtx
File146=..\..\..\help\SysUtils.dtx
File147=..\..\..\help\Unicode.dtx
File148=..\..\..\help\UnitConv.dtx
File149=..\..\..\help\WideStrings.dtx
File150=..\..\..\help\Win32.dtx
File151=..\..\source\windows\JclCppException.pas
File111=..\..\..\help\Common.dtx
File112=..\..\..\help\Complex.dtx
File113=..\..\..\help\Counter.dtx
File114=..\..\..\help\DateTime.dtx
File115=..\..\..\help\Debug.dtx
File116=..\..\..\help\ExprEval.dtx
File117=..\..\..\help\FileUtils.dtx
File118=..\..\..\help\Hardlinks.dtx
File119=..\..\..\help\IncludedFiles.dtx
File120=..\..\..\help\IniFiles.dtx
File121=..\..\..\help\Jcl.dtx
File122=..\..\..\help\LANMan.dtx
File123=..\..\..\help\Locales.dtx
File124=..\..\..\help\Logic.dtx
File125=..\..\..\help\Mapi.dtx
File126=..\..\..\help\Math.dtx
File127=..\..\..\help\Midi.dtx
File128=..\..\..\help\Mime.dtx
File129=..\..\..\help\Miscel.dtx
File130=..\..\..\help\Multimedia.dtx
File131=..\..\..\help\Notify.dtx
File132=..\..\..\help\NTFS.dtx
File133=..\..\..\help\pcre.dtx
File134=..\..\..\help\PE.dtx
File135=..\..\..\help\Registry.dtx
File136=..\..\..\help\RTTI.dtx
File137=..\..\..\help\Schedule.dtx
File138=..\..\..\help\Security.dtx
File139=..\..\..\help\Shell.dtx
File140=..\..\..\help\Statistics.dtx
File141=..\..\..\help\Streams.dtx
File142=..\..\..\help\StrHashMap.dtx
File143=..\..\..\help\Strings.dtx
File144=..\..\..\help\SvcCtrl.dtx
File145=..\..\..\help\Synch.dtx
File146=..\..\..\help\SysInfo.dtx
File147=..\..\..\help\SysUtils.dtx
File148=..\..\..\help\Unicode.dtx
File149=..\..\..\help\UnitConv.dtx
File150=..\..\..\help\WideStrings.dtx
File151=..\..\..\help\Win32.dtx
File152=..\..\source\windows\JclCppException.pas

[General]
Copyright=Copyright (C) 1999, 2011 Project JEDI
Expand Down
9 changes: 5 additions & 4 deletions jcl/packages/help/JclContainers.dox
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ File1=..\..\..\help\JEDI.doxdb
File2=Jcl.doxdb

[Source Files]
Count=17
Count=18
File0=..\..\source\common\JclAbstractContainers.pas
File1=..\..\source\common\JclAlgorithms.pas
File2=..\..\source\common\JclArrayLists.pas
Expand All @@ -46,9 +46,10 @@ File10=..\..\source\common\JclSortedMaps.pas
File11=..\..\source\common\JclStacks.pas
File12=..\..\source\common\JclTrees.pas
File13=..\..\source\common\JclVectors.pas
File14=..\..\..\help\ContainerCopies.dtx
File15=..\..\..\help\Containers.dtx
File16=..\..\..\help\JclContainers.dtx
File14=..\..\..\help\Common.dtx
File15=..\..\..\help\ContainerCopies.dtx
File16=..\..\..\help\Containers.dtx
File17=..\..\..\help\JclContainers.dtx

[General]
Copyright=Copyright (C) 1999, 2011 Project JEDI
Expand Down
5 changes: 3 additions & 2 deletions jcl/packages/help/JclDeveloperTools.dox
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ File2=Jcl.doxdb
File3=JclContainers.doxdb

[Source Files]
Count=30
Count=31
File0=..\..\source\common\JclCompilerUtils.pas
File1=..\..\source\common\JclDevToolsResources.pas
File2=..\..\source\common\JclIDEUtils.pas
Expand Down Expand Up @@ -62,7 +62,8 @@ File25=..\..\source\common\JclPreProcessorVectorsTemplates.pas
File26=..\..\source\common\JclUsesUtils.pas
File27=..\..\source\windows\JclHelpUtils.pas
File28=..\..\source\windows\MSHelpServices_TLB.pas
File29=..\..\..\help\JclDeveloperTools.dtx
File29=..\..\..\help\Common.dtx
File30=..\..\..\help\JclDeveloperTools.dtx

[General]
Copyright=Copyright (C) 1999, 2011 Project JEDI
Expand Down
11 changes: 6 additions & 5 deletions jcl/packages/help/JclVcl.dox
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ File1=..\..\..\help\JEDI.doxdb
File2=Jcl.doxdb

[Source Files]
Count=16
Count=17
File0=..\..\source\vcl\JclPrint.pas
File1=..\..\source\vcl\JclGraphUtils.pas
File2=..\..\source\vcl\JclGraphics.pas
Expand All @@ -44,10 +44,11 @@ File8=..\..\source\vcl\JclVersionCtrlCVSImpl.pas
File9=..\..\source\vcl\JclVersionCtrlGITImpl.pas
File10=..\..\source\vcl\JclVersionCtrlSVNImpl.pas
File11=..\..\..\help\Bitmap32.dtx
File12=..\..\..\help\Font.dtx
File13=..\..\..\help\Graphics.dtx
File14=..\..\..\help\JclVcl.dtx
File15=..\..\..\help\Regions.dtx
File12=..\..\..\help\Common.dtx
File13=..\..\..\help\Font.dtx
File14=..\..\..\help\Graphics.dtx
File15=..\..\..\help\JclVcl.dtx
File16=..\..\..\help\Regions.dtx

[General]
Copyright=Copyright (C) 1999, 2011 Project JEDI
Expand Down

0 comments on commit 568a4aa

Please sign in to comment.