free_pascal_code_documenter.pdf
(
251 KB
)
Pobierz
42579004 UNPDF
FPDoc:
FreePascalcodedocumenter:Referencemanual
ReferencemanualforFPDoc
Documentversion0.9
August20,2006
MichaëlVanCanneyt
Contents
1Introduction
4
1.1Aboutthisdocument
.................................. 4
1.2AboutFPD
OC
...................................... 4
1.3Gettingmoreinformation.
............................... 5
2CompilingandInstallingFPD
OC
6
2.1Compiling
........................................ 6
2.2Installation
....................................... 6
3FPD
OC
usage
8
3.1fpdoc
.......................................... 8
3.2FPD
OC
command-lineoptionsreference
........................ 9
3.2.1content
..................................... 9
3.2.2descr
...................................... 9
3.2.3 format
...................................... 10
3.2.4help
....................................... 10
3.2.5hide-protected
................................. 10
3.2.6html-search
................................... 10
3.2.7 import
...................................... 11
3.2.8 input
...................................... 11
3.2.9 lang
....................................... 11
3.2.10latex-highlight
................................. 12
3.2.11output
...................................... 12
3.2.12package
..................................... 12
3.2.13show-private
.................................. 12
3.2.14warn-no-node
.................................. 12
3.3makeskel
........................................ 12
3.3.1 introduction
................................... 12
3.4Makeskeloptionreference
............................... 13
3.4.1descr
...................................... 13
3.4.2 suse:descr
.................................... 13
1
CONTENTS
3.4.3disable-arguments
............................... 13
3.4.4disable-errors
.................................. 13
3.4.5disable-function-results
............................. 13
3.4.6disable-private
................................. 14
3.4.7disable-protected
................................ 14
3.4.8disable-seealso
................................. 14
3.4.9emitclassseparator
............................... 14
3.4.10help
....................................... 14
3.4.11input
...................................... 14
3.4.12lang
....................................... 14
3.4.13output
...................................... 14
3.4.14package
..................................... 15
3.4.15update
...................................... 15
4Thedescriptionfile
16
4.1Introduction
....................................... 16
4.2Elementnamesandcross-referencing
......................... 18
4.2.1Elementnameconventions
........................... 18
4.2.2Crossreferencing:the
link
tag
........................ 19
4.3Tagreference
...................................... 19
4.3.1Overview
.................................... 19
4.3.2b:formatbold
................................. 21
4.3.3caption:Specifytablecaption
......................... 21
4.3.4code:formataspascalcode
.......................... 21
4.3.5descr:Descriptions
.............................. 22
4.3.6dd:definitiondata.
............................... 22
4.3.7dl:definitionlist.
................................ 22
4.3.8dt:definitionterm.
............................... 23
4.3.9element:Identifierdocumentation
...................... 23
4.3.10errors:Errorsection.
............................. 23
4.3.11fpdoc-description:Globaltag
........................ 24
4.3.12i:Formatitalics
................................ 24
4.3.13li:listelement
................................. 24
4.3.14link:Cross-reference
............................. 24
4.3.15module:Unitreference
............................ 25
4.3.16ol:Numberedlist.
............................... 25
4.3.17p:Paragraph
.................................. 26
4.3.18package:Packagereference
.......................... 26
4.3.19pre:Inserttextas-is
.............................. 27
4.3.20remark:formatasremark
........................... 27
2
CONTENTS
4.3.21seealso:Cross-referencesection
........................ 27
4.3.22short:Shortdescription
............................ 28
4.3.23table:Tablestart
................................ 28
4.3.24td:Tablecell
.................................. 29
4.3.25th:Tableheader
................................ 29
4.3.26tr:tablerow
.................................. 30
4.3.27u:Formatunderlined
............................. 30
4.3.28ul:bulletedlist
................................. 30
4.3.29var:variable
.................................. 31
5Generatedoutputfiles.
32
5.1HTMLoutput
...................................... 32
5.2Latexoutput
....................................... 33
3
Chapter1
Introduction
1.1Aboutthisdocument
ThisisthereferencemanualforFPD
OC
,afreedocumentationtoolforPascalunits.Itdescribesthe
usageofFPD
OC
andhowtowritedocumentationwithit.
Itattemptstobecomplete,butthetoolisundercontinuousdevelopment,andsotheremaybesome
slightdifferencesbetweenthedocumentationandtheactualprogram.Incaseofdiscrepancy,the
sourcesofthetoolarethefinalreference.AREADMEorCHANGESfilemaybeprovided,andcan
alsogivesomehintsastothingswhichhavechanged.Incaseofdoubt,thesefilesorthesourcesare
authoritative.
1.2AboutFPD
OC
FPD
OC
isatoolthatcombinesaPascalunitfileandadescriptionfileinXMLformatandproduces
referencedocumentationfortheunit.Thereferencedocumentationcontainsdocumentationforall
oftheidentifiersfoundintheunit’sinterfacesection.Thedocumentationisfullycross-referenced,
makingiteasytonavigate.Itisalsopossibletorefertootherdocumentationsetswrittenwith
FPD
OC
,makingitpossibletomaintainlargerdocumentationsetsforlargeprojects.
Contrarytosomeotherdocumentationtechniques,FPD
OC
doesnotrequirethepresenceofformatted
commentsinthesourcecode.Ittakesasourcefileandadocumentationfile(inXMLformat)and
mergesthesetwotogethertoafulldocumentationofthesource.Thismeansthatthecodedoesn’t
getobfuscatedwithlargepiecesofcomment,makingithardtoreadandunderstand.
FPD
OC
ispackage-oriented,whichmeansthatitconsidersunitsaspartofapackage.Documentation
forallunitsinapackagecanbegeneratedinonerun.
Atthemomentofwriting,thedocumentationcanbegeneratedinthefollowingformats:
HTMLPlainHTML.Javascriptisusedtobeabletoshowasmallwindowwithclasspropertiesor
classmethods,butthegeneratedHTMLwillworkwithoutJavaScriptaswell.Stylesheetsare
usedtodothemarkup,sotheoutputcanbecustomised.
XHTMLAsHTML,butusingamorestrictsyntax.
LaTeXLaTeXfiles,whichcanbeusedwiththefpc.styfilewhichcomeswiththeFreePascaldoc-
umentation.Fromthisoutput,PDFdocumentscanbegenerated,andwiththeuseoflatex2rtf,
RTForWinhelpfiles.Textfilescanalsobegenerated.
4
Plik z chomika:
Koriolan_new
Inne pliki z tego folderu:
bazy danych.pdf
(1686 KB)
Delphi 7 -Second Edition(1).exe
(43140 KB)
Delphi 7 Lite Full v 7.3.2.4 [ENG](1).exe
(57900 KB)
Zaawansowane programowanie w Delphi.PDF
(1126 KB)
indy9.zip
(837 KB)
Inne foldery tego chomika:
Antyvir
Commander Menadżer Plików
FireWall's
Graficzne
MS Office
Zgłoś jeśli
naruszono regulamin