paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-18 16:39:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

DocMgr: added documentation

Browse Source 
git-svn-id: trunk@34710 -
This commit is contained in:
dodi 2012-01-11 13:48:51 +00:00
parent ebb666cb58
commit fd406b79ea
16 changed files with 3469 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.gitattributes vendored
View File

@ -3702,6 +3702,13 @@ examples/fontenum/mainunit.pas svneol=native#text/pascal
examples/fpdocmanager/FPDocManager.lpi svneol=native#text/plain examples/fpdocmanager/FPDocManager.lpi svneol=native#text/plain
examples/fpdocmanager/FPDocManager.lpr svneol=native#text/plain examples/fpdocmanager/FPDocManager.lpr svneol=native#text/plain
examples/fpdocmanager/README.txt svneol=native#text/plain examples/fpdocmanager/README.txt svneol=native#text/plain
examples/fpdocmanager/docs/fconfig.xml svneol=native#text/plain
examples/fpdocmanager/docs/flogview.xml svneol=native#text/plain
examples/fpdocmanager/docs/fmain.xml svneol=native#text/plain
examples/fpdocmanager/docs/fupdateview.xml svneol=native#text/plain
examples/fpdocmanager/docs/ulpk.xml svneol=native#text/plain
examples/fpdocmanager/docs/umakeskel.xml svneol=native#text/plain
examples/fpdocmanager/docs/umanager.xml svneol=native#text/plain
examples/fpdocmanager/fconfig.lfm svneol=native#text/plain examples/fpdocmanager/fconfig.lfm svneol=native#text/plain
examples/fpdocmanager/fconfig.pas svneol=native#text/pascal examples/fpdocmanager/fconfig.pas svneol=native#text/pascal
examples/fpdocmanager/flogview.lfm svneol=native#text/plain examples/fpdocmanager/flogview.lfm svneol=native#text/plain

10
examples/fpdocmanager/FPDocManager.lpi
View File

@ -43,7 +43,7 @@
<PackageName Value="LCL"/> <PackageName Value="LCL"/>
</Item3> </Item3>
</RequiredPackages> </RequiredPackages>
<Units Count="9"> <Units Count="8">
<Unit0> <Unit0>
<Filename Value="FPDocManager.lpr"/> <Filename Value="FPDocManager.lpr"/>
<IsPartOfProject Value="True"/> <IsPartOfProject Value="True"/>
@ -92,11 +92,6 @@
<IsPartOfProject Value="True"/> <IsPartOfProject Value="True"/>
<UnitName Value="uLpk"/> <UnitName Value="uLpk"/>
</Unit7> </Unit7>
<Unit8>
<Filename Value="$(FPCDir)\utils\fpdoc\dw_html.pp"/>
<IsPartOfProject Value="True"/>
<UnitName Value="dw_HTML"/>
</Unit8>
</Units> </Units>
</ProjectOptions> </ProjectOptions>
<CompilerOptions> <CompilerOptions>
@ -107,7 +102,6 @@
</Target> </Target>
<SearchPaths> <SearchPaths>
<IncludeFiles Value="$(ProjOutDir)"/> <IncludeFiles Value="$(ProjOutDir)"/>
<OtherUnitFiles Value="$(FPCDir)\utils\fpdoc"/>
<UnitOutputDirectory Value="lib\$(TargetCPU)-$(TargetOS)"/> <UnitOutputDirectory Value="lib\$(TargetCPU)-$(TargetOS)"/>
</SearchPaths> </SearchPaths>
<Linking> <Linking>
@ -121,7 +115,7 @@
<CompilerMessages> <CompilerMessages>
<UseMsgFile Value="True"/> <UseMsgFile Value="True"/>
</CompilerMessages> </CompilerMessages>
<CustomOptions Value="-dDoDi"/> <CustomOptions Value="-uDoDi"/>
<CompilerPath Value="$(CompPath)"/> <CompilerPath Value="$(CompPath)"/>
</Other> </Other>
</CompilerOptions> </CompilerOptions>

2
examples/fpdocmanager/FPDocManager.lpr
View File

@ -7,7 +7,7 @@ uses
cthreads, cthreads,
{$ENDIF}{$ENDIF} {$ENDIF}{$ENDIF}
Interfaces, // this includes the LCL widgetset Interfaces, // this includes the LCL widgetset
Forms, dw_HTML, umakeskel, fMain, fConfig, uManager, fLogView, Forms, umakeskel, fMain, fConfig, uManager, fLogView,
fUpdateView, ulpk; fUpdateView, ulpk;
{$R *.res} {$R *.res}

481
examples/fpdocmanager/docs/fconfig.xml Normal file
View File

@ -0,0 +1,481 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fpdocmanager">
<!--
====================================================================
fConfig
====================================================================
-->
<module name="fConfig">
<short></short>
<descr>
</descr>
<!-- class Visibility: default -->
<element name="TCfgWizard">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.buBack">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.buNext">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.buFclBat">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.buSelRoot">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.buDownload">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.buSelFpc">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.Button1">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.Button2">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.buCancel">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.buRtlBat">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.edFpcDir">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.edRtlBat">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.edRoot">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.edFclBat">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.Label1">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.dlgSelRoot">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.Label2">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.Label3">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.dlgOpen">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.Panel1">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.Steps">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.sb">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.SelRoot">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.SelFPDir">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TCfgWizard.MkRTL">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.buBackClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.buBackClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.buFclBatClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.buFclBatClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.buNextClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.buNextClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.buRtlBatClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.buRtlBatClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.buSelFpcClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.buSelFpcClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.buSelRootClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.buSelRootClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.edFpcDirChange">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.edFpcDirChange.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.edRootChange">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.edRootChange.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.edRtlBatChange">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.edRtlBatChange.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.FormShow">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.FormShow.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.MkRTLShow">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.MkRTLShow.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.SelFPDirShow">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.SelFPDirShow.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TCfgWizard.SelRootShow">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCfgWizard.SelRootShow.Sender">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TCfgWizard.NoRun">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="CfgWizard">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- fConfig -->
</package>
</fpdoc-descriptions>

69
examples/fpdocmanager/docs/flogview.xml Normal file
View File

@ -0,0 +1,69 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fpdocmanager">
<!--
====================================================================
fLogView
====================================================================
-->
<module name="fLogView">
<short></short>
<descr>
</descr>
<!-- class Visibility: default -->
<element name="TLogView">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TLogView.edLog">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: default -->
<element name="TLogView.FormClose">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLogView.FormClose.Sender">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TLogView.FormClose.CloseAction">
<short></short>
</element>
<!-- variable Visibility: default -->
<element name="LogView">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- fLogView -->
</package>
</fpdoc-descriptions>

693
examples/fpdocmanager/docs/fmain.xml Normal file
View File

@ -0,0 +1,693 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fpdocmanager">
<!--
====================================================================
fMain
====================================================================
-->
<module name="fMain">
<short></short>
<descr>
</descr>
<!-- class Visibility: default -->
<element name="TMain">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.buSkel">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.buUpdate">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.buRefresh">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.buShowLog">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.buTest">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.dlgSelLpk">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.edINI">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.swShowUpdate">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.edLog">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.lbPackages">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.edUnit">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.GroupBox1">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.lbUnits">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.MainMenu1">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.MenuItem1">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.mnImportLpk">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.mnPackage">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.mnConfig">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.MenuItem3">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.mnExit">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.dlgSelRoot">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.ViewINI">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.Units">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.swAll">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.swSingle">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.edXML">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.SynXMLSyn1">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.ViewXML">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TMain.ViewUnits">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.buRefreshClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.buRefreshClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.buTestClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.buTestClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.edLogChange">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.edLogChange.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.edXMLExit">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.edXMLExit.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.FormCloseQuery">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.FormCloseQuery.Sender">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TMain.FormCloseQuery.CanClose">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.FormCreate">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.FormCreate.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.FormResize">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.FormResize.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.lbPackagesClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.lbPackagesClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.lbUnitsClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.lbUnitsClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.mnConfigClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.mnConfigClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.mnExitClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.mnExitClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.mnImportLpkClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.mnImportLpkClick.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.swShowUpdateChange">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.swShowUpdateChange.Sender">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="TMain.swSingleClick">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.swSingleClick.Sender">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TMain.LogName">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TMain.LogFile">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: private -->
<element name="TMain.ProjectsChanged">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.ProjectsChanged.Sender">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TMain.LogToFile">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.LogToFile.Sender">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TMain.LogToFile.msg">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TMain.LogToMsgBox">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.LogToMsgBox.Sender">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TMain.LogToMsgBox.msg">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TMain.LogStart">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: private -->
<element name="TMain.LogDone">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: private -->
<element name="TMain.ShowUpdate">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: private -->
<element name="TMain.OnParseImport">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TMain.OnParseImport.Sender">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TMain.OnParseImport.ASource">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TMain.OnParseImport.ALink">
<short></short>
</element>
<!-- variable Visibility: public -->
<element name="TMain.CurPkg">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: public -->
<element name="TMain.CurUnit">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TMain.UpdateDocs">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="Main">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- fMain -->
</package>
</fpdoc-descriptions>

48
examples/fpdocmanager/docs/fupdateview.xml Normal file
View File

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fpdocmanager">
<!--
====================================================================
fUpdateView
====================================================================
-->
<module name="fUpdateView">
<short></short>
<descr>
</descr>
<!-- class Visibility: default -->
<element name="TUpdateView">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TUpdateView.edUpdate">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="UpdateView">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- fUpdateView -->
</package>
</fpdoc-descriptions>

30
examples/fpdocmanager/docs/ulpk.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="fpdocmanager">
<!--
====================================================================
uLpk
====================================================================
-->
<module name="uLpk">
<short/>
<descr/>
<!-- function Visibility: default -->
<element name="ImportLpk">
<short>Imports an .lpi or .lpk file, creates a documentation project.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="ImportLpk.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ImportLpk.AFile">
<short/>
</element>
</module>
<!-- uLpk -->
</package>
</fpdoc-descriptions>

1001
examples/fpdocmanager/docs/umakeskel.xml Normal file
View File

File diff suppressed because it is too large Load Diff

1021
examples/fpdocmanager/docs/umanager.xml Normal file
View File

File diff suppressed because it is too large Load Diff

22
examples/fpdocmanager/fmain.lfm
View File

@ -28,7 +28,7 @@ object Main: TMain
Height = 270 Height = 270
Top = 0 Top = 0
Width = 317 Width = 317
ActivePage = TabSheet2 ActivePage = ViewUnits
Align = alClient Align = alClient
TabIndex = 1 TabIndex = 1
TabOrder = 1 TabOrder = 1
@ -483,6 +483,7 @@ object Main: TMain
'' ''
) )
VisibleSpecialChars = [vscSpace, vscTabAtLast] VisibleSpecialChars = [vscSpace, vscTabAtLast]
ScrollBars = ssAutoBoth
BracketHighlightStyle = sbhsBoth BracketHighlightStyle = sbhsBoth
inline SynLeftGutterPartList1: TSynGutterPartList inline SynLeftGutterPartList1: TSynGutterPartList
object SynGutterMarks1: TSynGutterMarks object SynGutterMarks1: TSynGutterMarks
@ -519,7 +520,7 @@ object Main: TMain
end end
end end
end end
object TabSheet2: TTabSheet object ViewUnits: TTabSheet
Caption = 'Units' Caption = 'Units'
ClientHeight = 242 ClientHeight = 242
ClientWidth = 309 ClientWidth = 309
@ -635,6 +636,23 @@ object Main: TMain
end end
end end
end end
object ViewINI: TTabSheet
Caption = 'INI'
ClientHeight = 242
ClientWidth = 309
object edINI: TMemo
Left = 0
Height = 242
Top = 0
Width = 309
Align = alClient
Lines.Strings = (
'edINI'
)
ScrollBars = ssAutoBoth
TabOrder = 0
end
end
end end
object MainMenu1: TMainMenu object MainMenu1: TMainMenu
left = 10 left = 10

11
examples/fpdocmanager/fmain.pas
View File

@ -26,6 +26,7 @@ type
buShowLog: TButton; buShowLog: TButton;
buTest: TButton; buTest: TButton;
dlgSelLpk: TOpenDialog; dlgSelLpk: TOpenDialog;
edINI: TMemo;
swShowUpdate: TCheckBox; swShowUpdate: TCheckBox;
edLog: TEdit; edLog: TEdit;
lbPackages: TComboBox; lbPackages: TComboBox;
@ -40,13 +41,14 @@ type
MenuItem3: TMenuItem; MenuItem3: TMenuItem;
mnExit: TMenuItem; mnExit: TMenuItem;
dlgSelRoot: TSelectDirectoryDialog; dlgSelRoot: TSelectDirectoryDialog;
ViewINI: TTabSheet;
Units: TPageControl; Units: TPageControl;
swAll: TRadioButton; swAll: TRadioButton;
swSingle: TRadioButton; swSingle: TRadioButton;
edXML: TSynEdit; edXML: TSynEdit;
SynXMLSyn1: TSynXMLSyn; SynXMLSyn1: TSynXMLSyn;
ViewXML: TTabSheet; ViewXML: TTabSheet;
TabSheet2: TTabSheet; ViewUnits: TTabSheet;
procedure buRefreshClick(Sender: TObject); procedure buRefreshClick(Sender: TObject);
procedure buTestClick(Sender: TObject); procedure buTestClick(Sender: TObject);
procedure edLogChange(Sender: TObject); procedure edLogChange(Sender: TObject);
@ -83,9 +85,9 @@ var
implementation implementation
uses uses
fConfig, fLogView, fUpdateView, fConfig, fLogView, fUpdateView;
//dw_HTML, //more writers? //dw_HTML, //more writers?
uLpk; //uLpk;
{$R *.lfm} {$R *.lfm}
@ -288,6 +290,9 @@ begin
fn := pkg.ProjectFile; //initialized where? fn := pkg.ProjectFile; //initialized where?
if fn <> '' then if fn <> '' then
edXML.Lines.LoadFromFile(fn); edXML.Lines.LoadFromFile(fn);
fn := pkg.IniFileName;
if FileExists(fn) then
edINI.Lines.LoadFromFile(fn);
//load units... //load units...
lbUnits.Items.BeginUpdate; lbUnits.Items.BeginUpdate;
lbUnits.Clear; lbUnits.Clear;

4
examples/fpdocmanager/fpdocengine.lpk
View File

@ -3,7 +3,9 @@
<Package Version="4"> <Package Version="4">
<PathDelim Value="\"/> <PathDelim Value="\"/>
<Name Value="FPDocEngine"/> <Name Value="FPDocEngine"/>
<AddToProjectUsesSection Value="True"/>
<Author Value="DoDi"/> <Author Value="DoDi"/>
<AutoUpdate Value="Manually"/>
<CompilerOptions> <CompilerOptions>
<Version Value="11"/> <Version Value="11"/>
<PathDelim Value="\"/> <PathDelim Value="\"/>
@ -18,6 +20,7 @@
</Other> </Other>
</CompilerOptions> </CompilerOptions>
<Description Value="FPDoc tools as a package."/> <Description Value="FPDoc tools as a package."/>
<License Value="LGPL"/>
<Version Major="1"/> <Version Major="1"/>
<Files Count="18"> <Files Count="18">
<Item1> <Item1>
@ -93,6 +96,7 @@
<UnitName Value="sh_pas"/> <UnitName Value="sh_pas"/>
</Item18> </Item18>
</Files> </Files>
<LazDoc Paths="docs"/>
<RequiredPkgs Count="1"> <RequiredPkgs Count="1">
<Item1> <Item1>
<PackageName Value="FCL"/> <PackageName Value="FCL"/>

32
examples/fpdocmanager/ulpk.pp
View File

@ -25,7 +25,8 @@ function ImportLpk(const AFile: string): TDocPackage;
implementation implementation
//uses uses
umakeskel;
type type
eKey = (kvEof, kvName, kvIncl, kvOther, kvFilename, kvDocPaths, kvReq, kvTitle eKey = (kvEof, kvName, kvIncl, kvOther, kvFilename, kvDocPaths, kvReq, kvTitle
@ -43,11 +44,18 @@ var
lt, eq, q2: integer; lt, eq, q2: integer;
key: eKey; key: eKey;
function ImportCompiled(const LpkFile: string): boolean; function ImportCompiled(const LpkFile: string; APkg: TDocPackage): boolean;
var var
mfc: string; mfc: string;
f: TextFile; f: TextFile;
begin begin
(* Makefile.compiled is an XML file, containing
<Params Value=" ..." --> extract -Fi and other options.
-Fu is quite unusable, contains units/%(CPU_TARGET)-%(OS_TARGET)
other options seem omittable?
Try use <prj>.compiled in unit output dir?
*)
mfc := ExtractFilePath(LpkFile) + 'Makefile.compiled'; mfc := ExtractFilePath(LpkFile) + 'Makefile.compiled';
Result := FileExists(mfc); Result := FileExists(mfc);
if not Result then if not Result then
@ -57,9 +65,22 @@ begin
Reset(f); Reset(f);
try try
//parse //parse
ReadLn(f, ln); while not EOF(f) do begin
//todo... ReadLn(f, ln);
//ImportCommandline (CmdToPrj?) if Pos('<Params ', ln) < 1 then
continue;
eq := Pos('"', ln);
if eq < 1 then
continue;
ln := Copy(ln, eq+1, Length(ln) - eq);
while ln <> '' do begin
value := GetNextWord(ln);
if (Copy(value,1,2) = '-d') or (Copy(value,1,3) = '-Fi') then begin
APkg.CompOpts := value; //collects all options
end;
end;
//todo...
end;
finally finally
CloseFile(f); CloseFile(f);
end; end;
@ -141,6 +162,7 @@ begin
finally finally
CloseFile(f); CloseFile(f);
end; end;
ImportCompiled(AFile, pkg); //ignore result, is optional
end; end;
end. end.

5
examples/fpdocmanager/umakeskel.pas
View File

@ -656,7 +656,7 @@ end;
function TFPDocMaker.UnitSpec(AUnit: string): string; function TFPDocMaker.UnitSpec(AUnit: string): string;
var var
i: integer; i: integer;
s, w: string; w: string;
begin begin
for i := 0 to SelectedPackage.Inputs.Count - 1 do begin for i := 0 to SelectedPackage.Inputs.Count - 1 do begin
w := ExtractUnitName(FPackage.Inputs, i); w := ExtractUnitName(FPackage.Inputs, i);
@ -955,6 +955,7 @@ var
Cmd, Arg: String; Cmd, Arg: String;
begin begin
Cmd:=S; Cmd:=S;
Arg := ''; //make compiler happy
Result := ParseCommon(Cmd, Arg); Result := ParseCommon(Cmd, Arg);
if Result <> caInvalid then if Result <> caInvalid then
exit; exit;
@ -1094,11 +1095,11 @@ end;
function TFPDocMaker.ParseUpdateOption(const s: String): TCreatorAction; function TFPDocMaker.ParseUpdateOption(const s: String): TCreatorAction;
//procedure ParseOption(const s: String; Options: TEngineOptions);
var var
Cmd, Arg: String; Cmd, Arg: String;
begin begin
Cmd:=S; Cmd:=S;
Arg := ''; //make compiler happy
Result := ParseCommon(Cmd, Arg); Result := ParseCommon(Cmd, Arg);
if Result <> caInvalid then if Result <> caInvalid then
exit; exit;

111
examples/fpdocmanager/umanager.pas
View File

@ -34,6 +34,7 @@ type
*) *)
TDocPackage = class TDocPackage = class
private private
FCompOpts: string;
FDescrDir: string; FDescrDir: string;
FDescriptions: TStrings; FDescriptions: TStrings;
FIncludePath: string; FIncludePath: string;
@ -46,6 +47,7 @@ type
FRequires: TStrings; FRequires: TStrings;
FUnitPath: string; FUnitPath: string;
FUnits: TStrings; FUnits: TStrings;
procedure SetCompOpts(AValue: string);
procedure SetDescrDir(AValue: string); procedure SetDescrDir(AValue: string);
procedure SetDescriptions(AValue: TStrings); procedure SetDescriptions(AValue: TStrings);
procedure SetIncludePath(AValue: string); procedure SetIncludePath(AValue: string);
@ -61,6 +63,7 @@ type
protected protected
Config: TIniFile; Config: TIniFile;
procedure ReadConfig; procedure ReadConfig;
function IniFileName: string;
public public
constructor Create; constructor Create;
destructor Destroy; override; destructor Destroy; override;
@ -72,6 +75,7 @@ type
property ProjectFile: string read FProjectFile write SetProjectFile; //xml? property ProjectFile: string read FProjectFile write SetProjectFile; //xml?
//from LazPkg //from LazPkg
procedure AddUnit(const AFile: string); procedure AddUnit(const AFile: string);
property CompOpts: string read FCompOpts write SetCompOpts;
property LazPkg: string read FLazPkg write SetLazPkg; //LPK name? property LazPkg: string read FLazPkg write SetLazPkg; //LPK name?
property ProjectDir: string read FProjectDir write SetProjectDir; property ProjectDir: string read FProjectDir write SetProjectDir;
property DescrDir: string read FDescrDir write SetDescrDir; property DescrDir: string read FDescrDir write SetDescrDir;
@ -91,7 +95,6 @@ type
TFPDocHelper = class(TFPDocMaker) TFPDocHelper = class(TFPDocMaker)
private private
FProjectDir: string; FProjectDir: string;
procedure CleanXML(const FileName: string);
procedure SetProjectDir(AValue: string); procedure SetProjectDir(AValue: string);
public public
InputList, DescrList: TStringList; //still required? InputList, DescrList: TStringList; //still required?
@ -138,7 +141,7 @@ type
Procedure DoLog(Const Msg : String); Procedure DoLog(Const Msg : String);
public public
Config: TIniFile; //extend class? Config: TIniFile; //extend class?
constructor Create(AOwner: TComponent); constructor Create(AOwner: TComponent); override;
destructor Destroy; override; destructor Destroy; override;
procedure BeginUpdate; procedure BeginUpdate;
procedure EndUpdate; procedure EndUpdate;
@ -156,7 +159,7 @@ type
function Update(APkg: TDocPackage; const AUnit: string): boolean; function Update(APkg: TDocPackage; const AUnit: string): boolean;
public //published? public //published?
property FpcDocDir: string read FFPDocDir write SetFPDocDir; property FpcDocDir: string read FFPDocDir write SetFPDocDir;
property LazarusDir: string read FLazarusDir write SetLazarusDir; //property LazarusDir: string read FLazarusDir write SetLazarusDir;
property RootDir: string read FRootDir write SetRootDir; property RootDir: string read FRootDir write SetRootDir;
property Packages: TStrings read FPackages; property Packages: TStrings read FPackages;
property Package: TDocPackage read FPackage write SetPackage; property Package: TDocPackage read FPackage write SetPackage;
@ -185,6 +188,18 @@ begin
FDescrDir:=AValue; FDescrDir:=AValue;
end; end;
procedure TDocPackage.SetCompOpts(AValue: string);
begin
(* collect all compiler options
*)
if FCompOpts=AValue then Exit;
if AValue = '' then exit;
if FCompOpts = '' then
FCompOpts:=AValue
else
FCompOpts:= FCompOpts + ' ' + AValue;
end;
procedure TDocPackage.SetDescriptions(AValue: TStrings); procedure TDocPackage.SetDescriptions(AValue: TStrings);
(* Shall we allow for multiple descriptions? (general + OS specific!?) (* Shall we allow for multiple descriptions? (general + OS specific!?)
*) *)
@ -212,17 +227,20 @@ begin
Import; Import;
end; end;
(* Requires[] only contain package names.
Internal use: Get/Set CommaText
*)
procedure TDocPackage.SetRequires(AValue: TStrings); procedure TDocPackage.SetRequires(AValue: TStrings);
procedure Import; procedure Import;
var var
i, j: integer; i: integer;
s: string; s: string;
begin begin
FRequires.Clear; //assume full replace FRequires.Clear; //assume full replace
for i := 0 to AValue.Count - 1 do begin for i := 0 to AValue.Count - 1 do begin
s := AValue[i]; //<name.xct>,<prefix> s := AValue[i]; //<name.xct>,<prefix>
FRequires.Add(ExtractImportName(s) + '=' + s); FRequires.Add(ExtractImportName(s)); // + '=' + s);
end; end;
end; end;
@ -230,10 +248,12 @@ begin
if FRequires=AValue then Exit; if FRequires=AValue then Exit;
if AValue = nil then exit; if AValue = nil then exit;
if AValue.Count = 0 then exit; if AValue.Count = 0 then exit;
{
if Pos('=', AValue[0]) > 0 then if Pos('=', AValue[0]) > 0 then
FRequires.Assign(AValue) //clears previous content FRequires.Assign(AValue) //clears previous content
else else
Import; }
Import;
end; end;
procedure TDocPackage.SetUnits(AValue: TStrings); procedure TDocPackage.SetUnits(AValue: TStrings);
@ -361,21 +381,25 @@ begin
//todo: common options? OS options? //todo: common options? OS options?
for i := 0 to Units.Count - 1 do begin for i := 0 to Units.Count - 1 do begin
s := Units.ValueFromIndex[i]; s := Units.ValueFromIndex[i];
if CompOpts <> '' then
s := s + ' ' + CompOpts;
//add further options? //add further options?
pkg.Inputs.Add(s); pkg.Inputs.Add(s);
end; end;
//add Descriptions //add Descriptions - either explicit or implicit
if DescrDir <> '' then begin if (DescrDir <> '') and (Descriptions.Count = 0) then begin
//first check for existing directory //first check for existing directory
if not DirectoryExists(DescrDir) then begin if not DirectoryExists(DescrDir) then begin
MkDir(DescrDir); //exclude \? MkDir(DescrDir); //exclude \?
end else if Descriptions.Count = 0 then begin end else if Descriptions.Count = 0 then begin
APrj.ParseFPDocOption('--descr-dir=' + DescrDir); //adds all XML files APrj.ParseFPDocOption('--descr-dir=' + DescrDir); //adds all XML files
end; end;
end; end else begin
for i := 0 to Descriptions.Count - 1 do begin APrj.DescrDir := DescrDir; //needed by Update
s := Descriptions[i]; for i := 0 to Descriptions.Count - 1 do begin
pkg.Descriptions.Add(s); s := Descriptions[i];
pkg.Descriptions.Add(s);
end;
end; end;
//add Imports //add Imports
for i := 0 to Requires.Count - 1 do begin for i := 0 to Requires.Count - 1 do begin
@ -401,7 +425,6 @@ end;
*) *)
function TDocPackage.ImportProject(APrj: TFPDocHelper; APkg: TFPDocPackage; const AFile: string): boolean; function TDocPackage.ImportProject(APrj: TFPDocHelper; APkg: TFPDocPackage; const AFile: string): boolean;
var var
j: integer;
s: string; s: string;
begin begin
//check loaded //check loaded
@ -441,7 +464,7 @@ begin
if Loaded then if Loaded then
exit; exit;
if Config = nil then if Config = nil then
Config := TIniFile.Create(Manager.RootDir + Name + '.ini'); Config := TIniFile.Create(IniFileName);
//check config //check config
s := Config.ReadString(SecDoc, 'projectdir', ''); s := Config.ReadString(SecDoc, 'projectdir', '');
if s = '' then begin if s = '' then begin
@ -450,6 +473,7 @@ begin
end; end;
ProjectFile := Config.ReadString(SecDoc, 'projectfile', ''); ProjectFile := Config.ReadString(SecDoc, 'projectfile', '');
FInputDir := Config.ReadString(SecDoc, 'inputdir', ''); FInputDir := Config.ReadString(SecDoc, 'inputdir', '');
FCompOpts := Config.ReadString(SecDoc, 'options', '');
FDescrDir := Config.ReadString(SecDoc, 'descrdir', ''); FDescrDir := Config.ReadString(SecDoc, 'descrdir', '');
Requires.CommaText := Config.ReadString(SecDoc, 'requires', ''); Requires.CommaText := Config.ReadString(SecDoc, 'requires', '');
//units //units
@ -475,16 +499,15 @@ procedure TDocPackage.UpdateConfig;
end; end;
end; end;
var
i: integer;
begin begin
//create ini file, if not already created //create ini file, if not already created
if Config = nil then if Config = nil then
Config := TIniFile.Create(Manager.RootDir + Name + '.ini'); //in document RootDir Config := TIniFile.Create(IniFileName); //in document RootDir
//general information //general information
Config.WriteString(SecDoc, 'projectdir', ProjectDir); Config.WriteString(SecDoc, 'projectdir', ProjectDir);
Config.WriteString(SecDoc, 'projectfile', ProjectFile); Config.WriteString(SecDoc, 'projectfile', ProjectFile);
Config.WriteString(SecDoc, 'inputdir', InputDir); Config.WriteString(SecDoc, 'inputdir', InputDir);
Config.WriteString(SecDoc, 'options', CompOpts);
Config.WriteString(SecDoc, 'descrdir', DescrDir); Config.WriteString(SecDoc, 'descrdir', DescrDir);
Config.WriteString(SecDoc, 'requires', Requires.CommaText); Config.WriteString(SecDoc, 'requires', Requires.CommaText);
//units //units
@ -494,6 +517,11 @@ begin
Loaded := True; Loaded := True;
end; end;
function TDocPackage.IniFileName: string;
begin
Result := Manager.RootDir + Name + '.ini';
end;
procedure TDocPackage.AddUnit(const AFile: string); procedure TDocPackage.AddUnit(const AFile: string);
var var
s: string; s: string;
@ -606,7 +634,6 @@ function TFPDocManager.LoadConfig(const ADir: string; Force: boolean): boolean;
var var
s, pf, cf: string; s, pf, cf: string;
i: integer; i: integer;
pkg: TDocPackage;
begin begin
s := IncludeTrailingPathDelimiter(ADir); s := IncludeTrailingPathDelimiter(ADir);
cf := s + ConfigName; cf := s + ConfigName;
@ -652,6 +679,7 @@ begin
(* Protection against excessive saves requires a subclass of TIniFile, (* Protection against excessive saves requires a subclass of TIniFile,
which flushes the file only if Dirty. which flushes the file only if Dirty.
*) *)
Result := True; //for now
end; end;
(* Add a DocPackage to Packages and INI. (* Add a DocPackage to Packages and INI.
@ -784,8 +812,6 @@ begin
end; end;
function TFPDocManager.ImportLpk(const AFile: string): TDocPackage; function TFPDocManager.ImportLpk(const AFile: string): TDocPackage;
var
s: string;
begin begin
BeginUpdate; BeginUpdate;
//import the LPK file into? Here: TDocPackage, could be FPDocProject? //import the LPK file into? Here: TDocPackage, could be FPDocProject?
@ -793,12 +819,7 @@ begin
if Result = nil then if Result = nil then
DoLog('Import failed on ' + AFile) DoLog('Import failed on ' + AFile)
else begin else begin
//todo: ImportCompiled - where? Result.Loaded := True; //import and write config file
//RegisterPackage(Result);
Result.Loaded := True; //should write config file!?
//CreateProject(AFile, Result);
//FModified := True; //always?
//Changed;
end; end;
EndUpdate; EndUpdate;
end; end;
@ -855,6 +876,9 @@ function TFPDocManager.Update(APkg: TDocPackage; const AUnit: string): boolean;
begin begin
BeginTest(APkg.ProjectFile); BeginTest(APkg.ProjectFile);
try try
Result := APkg.CreateProject(Helper, ''); //only configure, don't create file
if not Result then
exit;
Result := Helper.Update(APkg, AUnit); Result := Helper.Update(APkg, AUnit);
finally finally
EndTest; EndTest;
@ -886,8 +910,6 @@ end;
(* Prepare MakeSkel on temporary FPDocPackage (* Prepare MakeSkel on temporary FPDocPackage
*) *)
function TFPDocHelper.BeginTest(APkg: TDocPackage): boolean; function TFPDocHelper.BeginTest(APkg: TDocPackage): boolean;
var
pf: string;
begin begin
if not assigned(APkg) then if not assigned(APkg) then
exit(False); exit(False);
@ -956,8 +978,6 @@ begin
end; end;
function TFPDocHelper.TestRun(APkg: TDocPackage; AUnit: string): boolean; function TFPDocHelper.TestRun(APkg: TDocPackage; AUnit: string): boolean;
var
pf, dir: string;
begin begin
(* more detailed error handling? (* more detailed error handling?
Must CD to the project file directory!? Must CD to the project file directory!?
@ -990,10 +1010,12 @@ function TFPDocHelper.Update(APkg: TDocPackage; const AUnit: string): boolean;
InputList.Clear; InputList.Clear;
InputList.Add(UnitSpec(AUnit)); InputList.Add(UnitSpec(AUnit));
DescrList.Clear; DescrList.Clear;
OutName := DescrDir + AUnit + '.xml'; OutName := AUnit + '.xml';
if DescrDir <> '' then
OutName := IncludeTrailingBackslash(DescrDir) + OutName;
Options.UpdateMode := FileExists(OutName); Options.UpdateMode := FileExists(OutName);
if Options.UpdateMode then begin if Options.UpdateMode then begin
DescrList.Add(APkg.DescrDir + AUnit + '.xml'); DescrList.Add(OutName);
OutName:=Manager.RootDir + 'upd.' + AUnit + '.xml'; OutName:=Manager.RootDir + 'upd.' + AUnit + '.xml';
DoLog('Update ' + OutName); DoLog('Update ' + OutName);
end else begin end else begin
@ -1026,31 +1048,6 @@ begin
EndTest; EndTest;
end; end;
(* Kill file if no "<element" found
*)
procedure TFPDocHelper.CleanXML(const FileName: string);
var
f: TextFile;
s: string;
begin
AssignFile(f, FileName);
Reset(f);
try
while not EOF(f) do begin
ReadLn(f, s);
if Pos('<element ', s) > 0 then
exit; //file not empty
end;
finally
CloseFile(f);
end;
//nothing found, delete the file
if DeleteFile(FileName) then
DoLog('File ' + FileName + ' has no elements. Deleted.')
else
DoLog('File ' + FileName + ' has no elements. Delete failed.');
end;
procedure TFPDocHelper.SetProjectDir(AValue: string); procedure TFPDocHelper.SetProjectDir(AValue: string);
begin begin
if FProjectDir=AValue then Exit; if FProjectDir=AValue then Exit;