From: g0dil Date: Fri, 21 Aug 2009 14:10:19 +0000 (+0000) Subject: Remove obsolete SENFSCons documentation X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=81bca7eaa075738ba2f2b7c36efaced331677836;p=senf.git Remove obsolete SENFSCons documentation git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1318 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/site_scons/SENFSCons.py b/site_scons/SENFSCons.py index ba49af5..6c4bdb3 100644 --- a/site_scons/SENFSCons.py +++ b/site_scons/SENFSCons.py @@ -47,7 +47,8 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []): 'generate_tagfile': 'doc/${MODULE}.tag' }, MODULE = module ) env.Append(ALL_TAGFILES = tagfile[0].abspath) - env.Depends(tagfile, env.File('#/doclib/doxygen.sh')) + env.Depends(tagfile, [ env.File('#/doclib/doxygen.sh'), + env.File('#/doclib/tag-munge.xsl') ]) # Rule to generate HTML documentation doc = env.Doxygen(doxyfile, @@ -60,7 +61,8 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []): 'output_dir' : 'doc', 'html_dir' : 'html', 'html' : 'YES' } ) - env.Depends(doc, env.File('#/doclib/doxygen.sh')) + env.Depends(doc, [ env.File('#/doclib/doxygen.sh'), + env.File('#/doclib/html-munge.xsl') ]) # Copy the extra_sources (the images) into the documentation directory # (need to exclude the 'clean' case otherwise there are multiple ways to clean the copies) diff --git a/site_scons/site_tools/CombinedObject.py b/site_scons/site_tools/CombinedObject.py index eaf3ce1..9926452 100644 --- a/site_scons/site_tools/CombinedObject.py +++ b/site_scons/site_tools/CombinedObject.py @@ -1,4 +1,3 @@ - def generate(env): builder = env.Builder( diff --git a/site_scons/site_tools/CopyToDir.py b/site_scons/site_tools/CopyToDir.py index c55d1de..b688ca0 100644 --- a/site_scons/site_tools/CopyToDir.py +++ b/site_scons/site_tools/CopyToDir.py @@ -1,11 +1,3 @@ -## \file -# \brief CopyToDir builder - -## \package senfscons.CopyToDir -# \brief Copy source file(s) to a given directory -# -# \ingroup builder - import os.path import SCons.Builder, SCons.Defaults diff --git a/site_scons/site_tools/Dia2Png.py b/site_scons/site_tools/Dia2Png.py index a8000be..4ef55c6 100644 --- a/site_scons/site_tools/Dia2Png.py +++ b/site_scons/site_tools/Dia2Png.py @@ -1,23 +1,3 @@ -## \file -# \brief Dia2Png builder - -## \package senfscons.Dia2Png -# \brief Build a PNG file from a DIA file -# -# This builder will convert a given DIA file into a PNG image. The -# size of the target file is specified by giving a preferred DPI value -# and a maximum width. The Builder will automatically fetch the -# correct aspect ratio from the dia file. -# -# \par Construction Envrionment Variables: -# -# -# -# -#
\c DIACOMdia command, defaults to \c dia
\c DIA2PNGDPIresolution of converted image, defaults to 115
\c DIA2PNGMAXWIDTHmaximum image width, defaults to 800
-# -# \ingroup builder - import os import SCons.Builder, SCons.Action diff --git a/site_scons/site_tools/Doxygen.py b/site_scons/site_tools/Doxygen.py index 2b4530b..44a105f 100644 --- a/site_scons/site_tools/Doxygen.py +++ b/site_scons/site_tools/Doxygen.py @@ -17,53 +17,11 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -# The Modifications are Copyright (C) 2006,2007 +# The Modifications are Copyright (C) 2006,2007,2008,2009 # Fraunhofer Institute for Open Communication Systems (FOKUS) # Competence Center NETwork research (NET), St. Augustin, GERMANY # Stefan Bund -## \file -# \brief Doxygen builder - -## \package senfscons.Doxygen -# \brief Doxygen Documentation Builder -# -# This builder will invoke \c doxygen to build software -# documentation. The doxygen builder only takes the name of the -# doxyfile as it's source file. The builder parses that doxygen -# configuration file. -# -# The builder will automatically find all sources on which the -# documentation depends. This includes -# \li the source code files (as selected by the \c RECURSIVE, \c -# FILE_PATTERNS, \c INPUT and \c EXCLUDE_PATTERNS doxygen -# directives -# \li the \c HTML_HEADER and \c HTML_FOOTER -# \li all referenced \c TAGFILES -# \li the \c INPUT_FILTER -# \li all included doxyfiles (via \c @INCLUDE) -# -# The builder will emit a list of targets built by doxygen. This -# depends on the types of documentation built. -# -# The builder will also generate additional commands to resolve -# cross-references to other module documentations. This is based on -# the \c TAGFILES used. Tagfiles built in the same project in other -# modules are automatically found and the links will be resolved -# correctly. To resolve links from external tagfiles, you may specify -# tagfilename_DOXY_URL as a construction environment -# variable to specify the path to resolve references from the given -# tagfile to. tagfilename is the uppercased basename of the -# tagfile used. -# -# \par Construction Envrionment Variables: -# -# -# -#
\c DOXYGENdoxygen command, defaults to \c doxygen
tag_DOXY_URLexternal tagfile resolve URL
-# -# \ingroup builder - # I (g0dil@berlios.de) have been fighting 4 problems in this # implementation: # - A Directory target will *not* call any source scanners @@ -75,11 +33,10 @@ # - Theres a bug in SCons which will produce an error message for # directory targets if dir.sources is not set explicitly # - the first argument to env.Clean() must be the command line target, -# with which the scons was invoked. This does not help to add -# aditional files or directories to be cleaned if you don't know -# that target (it's not possible to say 'if you clean this file, -# also clean that one' hich is, what I had expected env.Clean to -# do). +# with which scons was invoked. This does not help to add aditional +# files or directories to be cleaned if you don't know that target +# (it's not possible to say 'if you clean this file, also clean that +# one' which is, what I had expected env.Clean to do). # # Together, these problems have produced several difficulties. I have # solved them by @@ -87,7 +44,7 @@ # cause source scanners to be invoked # - Adding the documentation directory as a target (so it will be # cleaned up which env.Clean doesn't help me to do), but *only* if -# scons is called to with the -c option +# scons is called with the -c option # - Setting dir.sources to the known source-list to silence the error # message whenever a directory is added as a target # diff --git a/site_scons/site_tools/PkgDraw.py b/site_scons/site_tools/PkgDraw.py index 5cd0989..4192706 100644 --- a/site_scons/site_tools/PkgDraw.py +++ b/site_scons/site_tools/PkgDraw.py @@ -1,21 +1,3 @@ -## \file -# \brief PkgDraw builder - -## \package senfscons.PkgDraw -# \brief Generate network packet diagram -# -# This builder will call pkgdraw to scan a header file and create network package diagrams -# from SENF_PARSER macro calls. -# -# \par Construction Envrionment Variables: -# -# -# -#
\c PKGDRAWCOMpkgdraw command, defaults to \c #/doclib/pkgdraw
\c PKGDRAWPACKETSlist packet types to include in -# the diagram, defaults to empty (include all packets)
-# -# \ingroup builder - import os import SCons.Builder, SCons.Action