CleanCode v1.2.07 AntDoc

Press that icon in order to update AntDoc GUI

sourceforgeBuild
Target perl.doc

perl.doc

  |
  +--perl.doc.checkIfRequired
  |
  +--perl.checkLicense
  |
  +--perl.checkApiPath
  |
  +--validation.data
    |
    +--validation.perl.data
      |
      +--validation.perl.data.check
      |
      +--validation.js2perl
        |
        +--validation.js.data
          |
          +--validation.js.data.check
          |
          +--init
        |
        +--cgi-bin.exe
          |
          +--cgi-bin.apps
            |
            +--cgi-bin.cgiAppBase
              |
              +--init
            |
            +--cgi-bin.page
              |
              +--init
            |
            +--cgi-bin.list
              |
              +--init
            |
            +--init
          |
          +--cgi-bin.check
          |
          +--init
        |
        +--init
      |
      +--init
    |
    +--init
  |
  +--init

create perl documentation

Generate Perl API Documentation for CleanCode Perl libraries using the CleanCode pod2htmltree tool.

Detail:
<target
	depends="init, validation.data, perl.doc.checkIfRequired, perl.checkLicense, perl.checkApiPath"
	description="create perl documentation"
	name="perl.doc"
	unless="perldocBuild.notRequired"
>

	<property
		name="perldoc.log"
		value="${perl}/lib/perldoc.log"
	/>

	<exec
		dir="${perl}"
		executable="perl"
		output="${perldoc.log}"
	>
		<-- First argument: the program to execute -->

		<arg value="${perlbin}/pod2htmltree.pl"/>
		<--  Title for top of overview -->

		<arg value="--doctitle=CleanCode Perl Libraries v${version} API"/>
		<--  Where to find .thtml (HTML template) files. -->

		<arg value="--templatePath=${perl}/template/perldoc"/>
		<--  Where to find perl .pm files. -->

		<arg value="--sourcePath=${perl}/lib"/>
		<--  Where to put perl .html files. -->

		<arg value="--targetPath=${mirror.api}/perl"/>
		<--  Pointer to java root -->

		<arg value="--javaAbsPath=${mirror.api}/java"/>

		<arg value="--javaPackages=com/cleancode"/>
		<--  Pointer to javaScript root -->

		<arg value="--jsAbsPath=${js}"/>

		<arg value="--jsPackages=cleancode"/>
		<--  header, footer, and headElement for all generated files -->

		<arg value="--header=<table class='titlebarTable' width='100%' cellspacing='1' border='0'><tr>\n <td class='titlebarLeftCell' width='100%'>CleanCode Perl Libraries</td>\n </tr>\n </table>\n "/>

		<arg value="--footer=<script type='text/javascript'>setTrack();</script>\n <script type='text/javascript' src='http://tcr.tynt.com/javascripts/Tracer.js?user=djcOTcytSr3QkAab7jrHtB&s=71'></script>\n <noscript><img src='/cgi-bin/axs/ax.pl?a02.gif' height='1' width='1' alt='' /></noscript>\n <table class='titlebarTable' width='100%' cellspacing='0' border='0'>\n <tr>\n <td class='titlebarLeftCell'>CleanCode Perl Libraries</td>\n <td class='titlebarRightCell' align='right'>Copyright &copy; 2001-${copyright} Michael Sorens - Revised ${revdate} <a href='http://sourceforge.net/projects/cleancode'><img src='http://sflogo.sourceforge.net/sflogo.php?group_id=101363&type=9' width='80' height='15' border='0' alt='Get CleanCode at SourceForge.net. Fast, secure and Free Open Source software downloads'/></a></td>\n </tr>\n </table>\n "/>

		<arg value="--headElement=<meta http-equiv='Content-type' content='text/html; charset=ISO-8859-1' />\n <script type='text/javascript' src='/js/MenuArchive.js'></script>\n <script type='text/javascript'>var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-10266590-1']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })();</script>\n "/>
		<--  Include the header on the top-level intro page also -->

		<arg value="--headertoc"/>
		<--  The style sheet file will be in the top .../api directory. -->

		<arg value="--css=perlwin32.css"/>
		<--  Write output to stderr or log file. -->

		<arg value="--nolog"/>
		<--  Suppress informational messages or not -->

		<arg value="--noverbose"/>
		<--  Force rebuild of all files or not -->
		<--  NB: A file is still built even if there are pod2html errors.
			Hence subsequent runs the file will be up-to-date (if not edited)
			and the errors will no longer be reported yet still be present! -->

		<arg value="--nobuildall"/>
		<--  Include (or not) generation time in the meta generator tag.
			Using it shows when it was built, but then in a directory compare
			files will always be different. -->

		<arg value="--nogenTime"/>
		<--  Allows putting a shaded box flush to top and side margins.
			But then you'll also need to add margins for text! -->
		<-- bodyAttributes=topmargin="0" marginheight="0"
			leftmargin="0" marginwidth="0"-->
		<--  Relative path for standalone programs;
			processed similar to package below -->

		<arg value="--tools=../bin"/>
		<--  Packages to process here -->

		<arg value="Array"/>

		<arg value="CGI"/>

		<arg value="CGI::Application"/>

		<arg value="CGI::PagePlugin"/>

		<arg value="CGI::PageValidator"/>

		<arg value="CGI::PageValidator::Plugin"/>

		<arg value="CGI::PageValidator::MainLib"/>

		<arg value="CGI::PageValidator::PluginLib"/>

		<arg value="Convert"/>

		<arg value="Data"/>

		<arg value="DBI"/>

		<arg value="File"/>

		<arg value="HTML"/>

		<arg value="Log"/>

		<arg value="Net"/>

		<arg value="Pod"/>

		<arg value="Proc"/>

		<arg value="Test"/>

		<arg value="Time"/>

		<arg value="XML"/>
	</exec>
	<-- pod2htmltree.pl creates *.old artifacts on subsequent runs -->

	<delete>
		<fileset
			dir="${mirror.api}/perl"
			includes="**/*.old"
		/>
	</delete>
	<-- pod creates *.tmp files to cleanup -->

	<delete>
		<fileset
			dir="${perl}"
			includes="pod2h*.tmp"
		/>
	</delete>
	<-- report errors -->

	<loadfile
		property="perl.doc.msgs"
		srcfile="${perldoc.log}"
	>
		<filterchain>
			<linecontainsregexp>
				<regexp pattern="cannot resolve|missing|at.*\.pm line"/>
			</linecontainsregexp>
		</filterchain>
	</loadfile>

	<if>
		<isset property="perl.doc.msgs"/>

		<then>
			<echo>${perl.doc.msgs}</echo>
		</then>
	</if>

	<echo>${perldoc.log} complete.</echo>
</target>


Edouard Mercier 2003.10.01 21:48:07 - AntDoc V0.8g - XSL Transformer Factory: org.apache.xalan.processor.TransformerFactoryImpl