X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=doclib%2FSConscript;h=97d0fc68881779407568ce66df7117b0e8ce45ef;hb=b559d8e50f059a49d0ac98aba08b4480a3da5b22;hp=85654a964ab0fc6ebbe9c419318a649a33dca2d7;hpb=601d1f509f5bb24df167a4dd5a20da67a0af9af8;p=senf.git diff --git a/doclib/SConscript b/doclib/SConscript index 85654a9..97d0fc6 100644 --- a/doclib/SConscript +++ b/doclib/SConscript @@ -41,7 +41,7 @@ # If needed, the doxy-header.html and/or doxy-footer.html file will be # regenerated. The header and/or footer are generated from templates # using a simple python based templating system called yaptu which is -# included in doclib/. +# included in site_scons/lib/. # # # 3. Calling doxygen @@ -52,7 +52,8 @@ # # * Building prerequisites (e.g. images) # -# * The processing done by the Doxygen builder and doclib/doxygen.sh +# * The processing done by the Doxygen builder and +# site_scon/lib/doxygen.sh # # # 3.1. Building prerequisites @@ -66,7 +67,7 @@ # The Doxygen builder will call the doxygen command to build the # documentation. # -# The doxygen command is configured as 'doclib/doxygen.sh' which +# The doxygen command is configured as 'site_scon/lib/doxygen.sh' which # does some additional processing in addition to calling doxygen # proper # @@ -81,25 +82,30 @@ # # * a generated tag file is post-processed using an XSLT template # -# (see doclib/doxygen.sh for more information). The Doxygen +# (see site_scon/lib/doxygen.sh for more information). The Doxygen # configuration is set up such, that # -# * doxygen calls 'doclib/filter.pl' on each source file. This filter -# will strip excess whitespace from the beginning of lines in +# * doxygen calls 'site_scons/lib/filter.pl' on each source file. This +# filter will strip excess whitespace from the beginning of lines in # '\code' and '
' blocks. Additionally it will expand all tabs, # tab width is 8 spaces (there should be no tabs in the source but # ...) -# -# * doxygen calls 'doclib/dot' to generate the 'dot' images. # -# * 'doclib/dot' calls 'doclib/dot-munge.pl' on the .dot -# files. dot-munge.pl changes the font and font-size and adds +# * 'site_scons/lib/filter.pl' calls 'site_scons/lib/makeDiaImageMap.py' +# whenever finding a '\diaimage' command. This will create an image +# map (in an encoded form which will be fixed by html-munge.xsl +# later) +# +# * doxygen calls 'site_scons/lib/dot' to generate the 'dot' images. +# +# * 'site_scons/lib/dot' calls 'site_scons/lib/dot-munge.pl' on the +# .dot files. dot-munge.pl changes the font and font-size and adds # line-breaks to long labels # -# * 'doclib/dot' calls the real dot binary. If the resulting image is -# more than 800 pixels wide, dot is called again, this time using -# the oposite rank direction (top-bottom vs. left-right). The image -# with the smaller width is selected and returned. +# * 'site_scons/lib/dot' calls the real dot binary. If the resulting +# image is more than 800 pixels wide, dot is called again, this time +# using the oposite rank direction (top-bottom vs. left-right). The +# image with the smaller width is selected and returned. # # # 4. Fixing broken links @@ -232,7 +238,8 @@ FOOTER = """