mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-24 20:40:40 +02:00
docs: clean up
git-svn-id: trunk@55175 -
This commit is contained in:
mattias
parent
a2cfbeee6c
commit
eb8a4f8cac
2
.gitattributes
vendored
2
.gitattributes
vendored
@ -5010,11 +5010,9 @@ docs/html/build_chm.bat svneol=native#text/x-msdos-program
|
|||||||
docs/html/build_chm.sh svneol=native#text/plain
|
docs/html/build_chm.sh svneol=native#text/plain
|
||||||
docs/html/build_html.bat svneol=native#text/x-msdos-program
|
docs/html/build_html.bat svneol=native#text/x-msdos-program
|
||||||
docs/html/build_html.sh svneol=native#text/plain
|
docs/html/build_html.sh svneol=native#text/plain
|
||||||
docs/html/build_lazutils_html.sh svneol=native#text/plain
|
|
||||||
docs/html/build_lcl_chm.sh svneol=native#text/plain
|
docs/html/build_lcl_chm.sh svneol=native#text/plain
|
||||||
docs/html/build_lcl_docs.lpi svneol=native#text/plain
|
docs/html/build_lcl_docs.lpi svneol=native#text/plain
|
||||||
docs/html/build_lcl_docs.lpr svneol=native#text/plain
|
docs/html/build_lcl_docs.lpr svneol=native#text/plain
|
||||||
docs/html/build_lcl_html.sh svneol=native#text/plain
|
|
||||||
docs/html/fpdoc.css svneol=native#text/css
|
docs/html/fpdoc.css svneol=native#text/css
|
||||||
docs/html/localfclfooter.xml svneol=native#text/plain
|
docs/html/localfclfooter.xml svneol=native#text/plain
|
||||||
docs/html/locallclfooter.xml svneol=native#text/plain
|
docs/html/locallclfooter.xml svneol=native#text/plain
|
||||||
|
|||||||
@ -1,127 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
#
|
|
||||||
# Author: Mattias Gaertner
|
|
||||||
#
|
|
||||||
# Creates the fpdoc HTML output for the Lazutils package
|
|
||||||
# Creates an chm file, if HTMLFMT is set to chm,
|
|
||||||
# otherwise it create html docs
|
|
||||||
#
|
|
||||||
# Usage: $0 <fpdoc-program-path> <footer-path> <fpcdocs-dir (http://svn.freepascal.org/svn/fpcdocs/trunk)>
|
|
||||||
# Example: $0 fpdoc ../locallclfooter.xml ../../../fpcdocs
|
|
||||||
|
|
||||||
#set -x
|
|
||||||
set -e
|
|
||||||
|
|
||||||
FPDoc=$1
|
|
||||||
if [ -z $FPDoc ]; then
|
|
||||||
FPDoc=fpdoc
|
|
||||||
fi
|
|
||||||
FPDocFooter=$2
|
|
||||||
FPCDocDir=$3
|
|
||||||
|
|
||||||
PackageName=lazutils
|
|
||||||
XMLSrcDir=../xml/lazutils/
|
|
||||||
PasSrcDir=../../components/lazutils/
|
|
||||||
InputFileList=inputfile.txt
|
|
||||||
|
|
||||||
# list with units in a preseeded order.
|
|
||||||
# missing units will be dropped from this list, other units added.
|
|
||||||
# units not in import order will mutilate links.
|
|
||||||
|
|
||||||
PreorderUnitList=( lazutilsstrconsts luresstrings lazutf8sysutils lazmethodlist avglvltree )
|
|
||||||
PreorderUnitList+=( lazutf8 lazutf16 masks fileutil lazutf8classes lconvencoding paswstring )
|
|
||||||
PreorderUnitList+=( lazlogger lazdbglog lazfileutils lazfilecache lazutils )
|
|
||||||
PreorderUnitList+=( laz2_xmlutils laz2_dom laz2_xmlread laz2_xmlwrite )
|
|
||||||
PreorderUnitList+=( laz_dom laz_xmlread laz_xmlwrite )
|
|
||||||
PreorderUnitList+=( laz_xmlcfg laz2_xmlcfg laz_xmlstreaming )
|
|
||||||
#------------------
|
|
||||||
|
|
||||||
inarray()
|
|
||||||
{ local tofind=$1 element;
|
|
||||||
shift; for element; do [[ $element = "$tofind" ]] && return; done; return 1;
|
|
||||||
}
|
|
||||||
# Usage: inarray "$value" "${array[@]}"
|
|
||||||
|
|
||||||
|
|
||||||
UnitListArr=()
|
|
||||||
|
|
||||||
# create output directory
|
|
||||||
mkdir -p $PackageName
|
|
||||||
|
|
||||||
# create unit list
|
|
||||||
cd $PasSrcDir
|
|
||||||
FindUnitList=(*.pas)
|
|
||||||
cd -
|
|
||||||
|
|
||||||
# test for preorder unit existance, add them to unitlist.
|
|
||||||
for preorder in ${PreorderUnitList[@]}; do
|
|
||||||
if [ -f $PasSrcDir/$preorder.pp ]
|
|
||||||
then
|
|
||||||
UnitListArr+=($preorder.pp)
|
|
||||||
fi
|
|
||||||
if [ -f $PasSrcDir/$preorder.pas ]
|
|
||||||
then
|
|
||||||
UnitListArr+=($preorder.pas)
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
#echo 1 ${UnitListArr[@]}
|
|
||||||
|
|
||||||
for foundunit in ${FindUnitList[@]}; do
|
|
||||||
if ! inarray "$foundunit" "${UnitListArr[@]}"
|
|
||||||
then
|
|
||||||
UnitListArr+=($foundunit)
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
UnitList=
|
|
||||||
for foundunit in ${UnitListArr[@]}; do
|
|
||||||
UnitList+="$foundunit "
|
|
||||||
done
|
|
||||||
|
|
||||||
# echo 2 $UnitList
|
|
||||||
|
|
||||||
# create description file list
|
|
||||||
DescrFiles=''
|
|
||||||
for unit in $UnitList; do
|
|
||||||
ShortFile=${unit%.pp}
|
|
||||||
ShortFile=${ShortFile%.pas}
|
|
||||||
DescrFiles="$DescrFiles --descr=../$XMLSrcDir$ShortFile.xml"
|
|
||||||
done
|
|
||||||
|
|
||||||
# create input file list
|
|
||||||
CurInputFileList=$PackageName/$InputFileList
|
|
||||||
rm -f $CurInputFileList
|
|
||||||
for unit in $UnitList; do
|
|
||||||
echo ../${PasSrcDir}$unit -Fi../${PasSrcDir}include >> $CurInputFileList
|
|
||||||
done
|
|
||||||
|
|
||||||
if [ -z "$HTMLFMT" ]; then
|
|
||||||
HTMLFMT=html
|
|
||||||
fi
|
|
||||||
|
|
||||||
FPDocParams="--content=lazutils.xct --package=lazutils --descr=../${XMLSrcDir}lazutils.xml --format=$HTMLFMT"
|
|
||||||
if [ "$HTMLFMT" == "chm" ]; then
|
|
||||||
FPDocParams="$FPDocParams --css-file=../fpdoc.css --auto-toc --auto-index --make-searchable --output=lazutils.chm"
|
|
||||||
fi
|
|
||||||
if [ -n "$FOOTERDATE" ]; then
|
|
||||||
FPDocParams="$FPDocParams --footer-date=$FOOTERDATE"
|
|
||||||
fi
|
|
||||||
if [ -n "$FPDocFooter" ]; then
|
|
||||||
FPDocParams="$FPDocParams --footer=$FPDocFooter"
|
|
||||||
fi
|
|
||||||
if [ -n "$FPCDocDir" ]; then
|
|
||||||
if [ "$HTMLFMT" == "chm" ]; then
|
|
||||||
FPDocParams="$FPDocParams --import=$FPCDocDir/rtl.xct,ms-its:rtl.chm::/ --import=$FPCDocDir/fcl.xct,ms-its:fcl.chm::/"
|
|
||||||
else
|
|
||||||
FPDocParams="$FPDocParams --import=$FPCDocDir/rtl.xct,../rtl/ --import=$FPCDocDir/fcl.xct,../fcl/"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
cd $PackageName
|
|
||||||
pwd
|
|
||||||
$FPDoc $DescrFiles --input=@$InputFileList $FPDocParams
|
|
||||||
cd -
|
|
||||||
|
|
||||||
# end.
|
|
||||||
|
|
||||||
@ -1,133 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
#
|
|
||||||
# Author: Mattias Gaertner
|
|
||||||
#
|
|
||||||
# Creates the fpdoc HTML output for the LCL
|
|
||||||
# Creates a chm file if HTMLFMT is set to chm,
|
|
||||||
# otherwise it creates html docs
|
|
||||||
#
|
|
||||||
#
|
|
||||||
|
|
||||||
#set -x
|
|
||||||
set -e
|
|
||||||
|
|
||||||
FPDoc=$1
|
|
||||||
if [ -z $FPDoc ]; then
|
|
||||||
FPDoc=fpdoc
|
|
||||||
fi
|
|
||||||
FPDocFooter=$2
|
|
||||||
FPCDocDir=$3
|
|
||||||
|
|
||||||
PackageName=lcl
|
|
||||||
XMLSrcDir=../xml/lcl/
|
|
||||||
PasSrcDir=../../lcl/
|
|
||||||
InputFileList=inputfile.txt
|
|
||||||
|
|
||||||
# list with units in a preseeded order.
|
|
||||||
# missing units will be dropped from this list, other units added.
|
|
||||||
# units not in import order will mutilate links.
|
|
||||||
|
|
||||||
PreorderUnitList=( lclbase fpcadds lclstrconsts masks fileutil utf8process lcltype lclproc tmschema lresources lclclasses )
|
|
||||||
PreorderUnitList+=( avglvltree graphmath graphtype lmessages interfacebase lclrescache graphics imglist themes actnlist clipbrd stdactns )
|
|
||||||
PreorderUnitList+=( graphics controls forms stdctrls extctrls buttons dialogs comctrls )
|
|
||||||
PreorderUnitList+=( lazhelpintf printers grids dbgrids menus )
|
|
||||||
|
|
||||||
#------------------
|
|
||||||
|
|
||||||
inarray()
|
|
||||||
{ local tofind=$1 element;
|
|
||||||
shift; for element; do [[ $element = "$tofind" ]] && return; done; return 1;
|
|
||||||
}
|
|
||||||
# Usage: inarray "$value" "${array[@]}"
|
|
||||||
|
|
||||||
|
|
||||||
UnitListArr=()
|
|
||||||
|
|
||||||
# create output directory
|
|
||||||
mkdir -p $PackageName
|
|
||||||
|
|
||||||
# Copy the css file to it
|
|
||||||
cp fpdoc.css $PackageName/
|
|
||||||
|
|
||||||
# create unit list
|
|
||||||
cd $PasSrcDir
|
|
||||||
FindUnitList=(*.pp *.pas)
|
|
||||||
cd -
|
|
||||||
|
|
||||||
# test for preorder unit existance, add them to unitlist.
|
|
||||||
for preorder in ${PreorderUnitList[@]}; do
|
|
||||||
if [ -f $PasSrcDir/$preorder.pp ]
|
|
||||||
then
|
|
||||||
UnitListArr+=($preorder.pp)
|
|
||||||
fi
|
|
||||||
if [ -f $PasSrcDir/$preorder.pas ]
|
|
||||||
then
|
|
||||||
UnitListArr+=($preorder.pas)
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
#echo 1 ${UnitListArr[@]}
|
|
||||||
|
|
||||||
for foundunit in ${FindUnitList[@]}; do
|
|
||||||
if ! inarray "$foundunit" "${UnitListArr[@]}"
|
|
||||||
then
|
|
||||||
UnitListArr+=($foundunit)
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
UnitList=
|
|
||||||
for foundunit in ${UnitListArr[@]}; do
|
|
||||||
UnitList+="$foundunit "
|
|
||||||
done
|
|
||||||
|
|
||||||
# echo 2 $UnitList
|
|
||||||
|
|
||||||
# create description file list
|
|
||||||
DescrFiles=''
|
|
||||||
for unit in $UnitList; do
|
|
||||||
ShortFile=${unit%.pp}
|
|
||||||
ShortFile=${ShortFile%.pas}
|
|
||||||
DescrFiles="$DescrFiles --descr=../$XMLSrcDir$ShortFile.xml"
|
|
||||||
done
|
|
||||||
|
|
||||||
# create input file list
|
|
||||||
CurInputFileList=$PackageName/$InputFileList
|
|
||||||
rm -f $CurInputFileList
|
|
||||||
for unit in $UnitList; do
|
|
||||||
echo ../${PasSrcDir}$unit -Fi../${PasSrcDir}include >> $CurInputFileList
|
|
||||||
done
|
|
||||||
|
|
||||||
if [ -z "$HTMLFMT" ]; then
|
|
||||||
HTMLFMT=html
|
|
||||||
fi
|
|
||||||
|
|
||||||
FPDocParams="--content=lcl.xct --package=lcl --descr=../${XMLSrcDir}lcl.xml --format=$HTMLFMT"
|
|
||||||
if [ "$HTMLFMT" == "chm" ]; then
|
|
||||||
FPDocParams="$FPDocParams --css-file=../fpdoc.css --auto-toc --auto-index --make-searchable --output=lcl.chm"
|
|
||||||
fi
|
|
||||||
if [ -n "$FOOTERDATE" ]; then
|
|
||||||
FPDocParams="$FPDocParams --footer-date=$FOOTERDATE"
|
|
||||||
fi
|
|
||||||
if [ -n "$FPDocFooter" ]; then
|
|
||||||
FPDocParams="$FPDocParams --footer=$FPDocFooter"
|
|
||||||
fi
|
|
||||||
if [ -n "$FPCDocDir" ]; then
|
|
||||||
if [ "$HTMLFMT" == "chm" ]; then
|
|
||||||
FPDocParams="$FPDocParams --import=$FPCDocDir/rtl.xct,ms-its:rtl.chm::/ --import=$FPCDocDir/fcl.xct,ms-its:fcl.chm::/"
|
|
||||||
if [ -f lazutils/lazutils.xct ]
|
|
||||||
then
|
|
||||||
FPDocParams="$FPDocParams --import=../lazutils/lazutils.xct,ms-its:lazutils.chm::/"
|
|
||||||
else
|
|
||||||
echo lazutils/lazutils.xct not found!
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
FPDocParams="$FPDocParams --import=$FPCDocDir/rtl.xct,../rtl/ --import=$FPCDocDir/fcl.xct,../fcl/"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
cd $PackageName
|
|
||||||
$FPDoc $DescrFiles --input=@$InputFileList $FPDocParams
|
|
||||||
cd -
|
|
||||||
|
|
||||||
# end.
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user