db-ojb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Armin Waibel <arm...@apache.org>
Subject Re: cvs commit: db-ojb .cvsignore build.xml build.properties
Date Mon, 14 Jun 2004 07:38:50 GMT
Hi Tom,

in build.xml old version you can run two different javadoc targets:
- api
generate selective classes
- javadoc
generate javadoc for all classes of OJB

Now it's not possible to generate javadoc for all OJB classes. Don't we 
need a 'javadoc-all' target or something similar?

regards,
Armin



tomdz@apache.org wrote:
> tomdz       2004/06/12 11:11:58
> 
>   Modified:    .        .cvsignore build.xml build.properties
>   Log:
>   Removed old documentation targets and made old 'forrest' target the new 'doc' target
>   Forrest now builds in a subfolder of 'target' and generated documentation is then copied
to the top-level folder 'doc'
>   
>   Revision  Changes    Path
>   1.4       +1 -0      db-ojb/.cvsignore
>   
>   Index: .cvsignore
>   ===================================================================
>   RCS file: /home/cvs/db-ojb/.cvsignore,v
>   retrieving revision 1.3
>   retrieving revision 1.4
>   diff -u -r1.3 -r1.4
>   --- .cvsignore	13 Dec 2003 12:11:27 -0000	1.3
>   +++ .cvsignore	12 Jun 2004 18:11:58 -0000	1.4
>   @@ -1,5 +1,6 @@
>    build
>    dist
>   +doc
>    target
>    *~
>    *.log
>   
>   
>   
>   1.128     +55 -71    db-ojb/build.xml
>   
>   Index: build.xml
>   ===================================================================
>   RCS file: /home/cvs/db-ojb/build.xml,v
>   retrieving revision 1.127
>   retrieving revision 1.128
>   diff -u -r1.127 -r1.128
>   --- build.xml	18 May 2004 18:23:09 -0000	1.127
>   +++ build.xml	12 Jun 2004 18:11:58 -0000	1.128
>   @@ -151,6 +151,8 @@
>            <mkdir dir="${build.desttest}"/>
>            <mkdir dir="${build.desttools}"/>
>    		<mkdir dir="${build.destjca}"/>
>   +        <mkdir dir="${build.doc}"/>
>   +        <mkdir dir="${build.javadoc}"/>
>            <mkdir dir="${dist}"/>
>            <copy todir="${build.src}">
>                <fileset dir="${src.java}"/>
>   @@ -607,40 +609,42 @@
>        <!-- ================================================================== -->
>        <!-- Build the documentation                                            -->
>        <!-- ================================================================== -->
>   -    <target name="doc" depends="prepare, javadoc, api, htmldoc"
>   -            description="Builds the complete documentation.">
>   -    </target>
>   -
>   -
>   -    <!-- ================================================================== -->
>   -    <!-- Forrest documentation/website generation                           -->
>   -    <!-- ================================================================== -->
>   -    <target name="forrest" depends="api" description="prepare forrest" >
>   -        <property name="src.static.files" value="${src.test}/org/apache/ojb"/>
>   -        <property name="temp.forrest.dir" value="forrest/src/documentation/content"/>
>   -
>   -        <echo message="*** Prepare Forrest..."/>
>   -        <delete>
>   -            <fileset dir="${temp.forrest.dir}" includes="**/*.txt"/>
>   -        </delete>
>   -        <delete dir="${temp.forrest.dir}/api"/>
>   -
>   -        <copy todir="${temp.forrest.dir}/api">
>   -            <fileset dir="${build.dir}/doc/api"/>
>   -        </copy>
>   -        <!--
>   -        forrest expects all static documents in content directory. these files will
>   -        be copied to the forrest build directory. After running Forret we can remove
them
>   -        -->
>   -        <copy file="${src.static.files}/repository.dtd" tofile="${temp.forrest.dir}/repository.dtd.txt"
/>
>   -        <copy file="${src.static.files}/repository.xml" tofile="${temp.forrest.dir}/repository.xml.txt"
/>
>   -        <copy file="${src.static.files}/repository_database.xml" tofile="${temp.forrest.dir}/repository_database.xml.txt"
/>
>   -        <copy file="${src.static.files}/repository_internal.xml" tofile="${temp.forrest.dir}/repository_internal.xml.txt"
/>
>   -        <copy file="${src.static.files}/repository_junit.xml" tofile="${temp.forrest.dir}/repository_junit.xml.txt"
/>
>   -        <copy file="${src.static.files}/repository_user.xml" tofile="${temp.forrest.dir}/repository_user.xml.txt"
/>
>   -        <copy file="${src.static.files}/tutorials/PBExample.java" tofile="${temp.forrest.dir}/PBExamples.txt"
/>
>   -	    <copy file="${src.static.files}/OJB.properties" tofile="${temp.forrest.dir}/OJB.properties.txt"
/>
>   -	    <copy file="release-notes.txt" tofile="${temp.forrest.dir}/release-notes.txt"
/>
>   +    <target name="doc" depends="prepare,javadoc"
>   +            description="Builds the complete documentation using Forrest">
>   +        <echo message="*** Preparing generation of documentation ..."/>
>   +
>   +        <delete dir="${build.doc}" failonerror="false"/>
>   +        <mkdir dir="${build.doc}"/>
>   +
>   +        <!-- Copy all forrest src stuff to a temporary directoy -->
>   +        <copy todir="${build.doc}">
>   +            <fileset dir="${src.doc}"/>
>   +        </copy>
>   +
>   +        <!-- Copy generated javadoc into the forrest structure in the temporary
directoy -->
>   +        <copy todir="${forrest.javadoc.destdir}">
>   +            <fileset dir="${build.javadoc}"/>
>   +        </copy>
>   +
>   +        <!-- Copy auxiliary documentation src files to the temporary directory
-->
>   +        <copy file="${forrest.staticfiles.srcdir}/repository.dtd"
>   +              tofile="${forrest.staticfiles.destdir}/repository.dtd.txt" />
>   +        <copy file="${forrest.staticfiles.srcdir}/repository.xml"
>   +              tofile="${forrest.staticfiles.destdir}/repository.xml.txt" />
>   +        <copy file="${forrest.staticfiles.srcdir}/repository_database.xml"
>   +              tofile="${forrest.staticfiles.destdir}/repository_database.xml.txt"
/>
>   +        <copy file="${forrest.staticfiles.srcdir}/repository_internal.xml"
>   +              tofile="${forrest.staticfiles.destdir}/repository_internal.xml.txt"
/>
>   +        <copy file="${forrest.staticfiles.srcdir}/repository_junit.xml"
>   +              tofile="${forrest.staticfiles.destdir}/repository_junit.xml.txt" />
>   +        <copy file="${forrest.staticfiles.srcdir}/repository_user.xml"
>   +              tofile="${forrest.staticfiles.destdir}/repository_user.xml.txt" />
>   +        <copy file="${forrest.staticfiles.srcdir}/tutorials/PBExample.java"
>   +              tofile="${forrest.staticfiles.destdir}/PBExamples.txt" />
>   +	    <copy file="${forrest.staticfiles.srcdir}/OJB.properties"
>   +	          tofile="${forrest.staticfiles.destdir}/OJB.properties.txt" />
>   +	    <copy file="release-notes.txt"
>   +	          tofile="${forrest.staticfiles.destdir}/release-notes.txt" />
>    
>            <!-- Currently we have to run the forrest command because there is no ant
>                 target to use. This means that we have to deal with batch files/scripts
>   @@ -672,71 +676,51 @@
>            <antcall target="forrest-on-win-with-cmd"/>
>            <antcall target="forrest-on-win-with-command"/>
>            <antcall target="forrest-on-unix"/>
>   +
>   +        <!-- Finally we can copy the generated documentation to its designated
place -->
>   +        <mkdir dir="${doc}"/>
>   +        <copy todir="${doc}">
>   +            <fileset dir="${forrest.output.dir}"/>
>   +        </copy>
>        </target>
>    
>        <target name="forrest-on-win-with-cmd" if="windows.with.cmd">
>   -        <exec dir="forrest" executable="cmd">
>   +        <exec dir="${build.doc}" executable="cmd">
>                <arg line="/c forrest.bat"/>
>            </exec>
>        </target>
>        <target name="forrest-on-win-with-command" if="windows.with.command">
>   -        <exec dir="forrest" executable="command">
>   +        <exec dir="${build.doc}" executable="command">
>                <arg line="/c forrest.bat"/>
>            </exec>
>        </target>
>        <target name="forrest-on-unix" if="not.windows">
>   -        <exec dir="forrest" executable="forrest"/>
>   -    </target>
>   -            
>   -    <!-- ================================================================== -->
>   -    <!-- Build the html-documentation                                       -->
>   -    <!-- ================================================================== -->
>   -    <target name="htmldoc" depends="prepare, xslt"
>   -            description="Builds the HTML user and system documentation">
>   -    </target>
>   -
>   -    <!-- ================================================================== -->
>   -    <!-- Build the full JavaDocs                                            -->
>   -    <!-- ================================================================== -->
>   -    <target name="javadoc" depends="prepare" description="Builds the full JavaDocs.">
>   -        <mkdir dir="${build.dir}/doc/javadoc"/>
>   -        <javadoc sourcepath="${build.src}:${build.srctest}:${build.srctools}"
>   -                 destdir="${build.dir}/doc/javadoc"
>   -                 doctitle="${icon}${br}${name} ${version} JavaDoc "
>   -                 windowtitle="${name} ${version} JavaDoc"
>   -                 bottom="${copyright}${br}Version: ${version}, ${versiondate}"
>   -                 package="true"
>   -                 author="true"
>   -                 version="true"
>   -                 noindex="true"
>   -                 packagenames="${allpackagenames}"/>
>   -        <copy todir="${build.dir}/doc/javadoc">
>   -            <fileset dir="${build.src}" includes="**/*.gif"/>
>   -        </copy>
>   +        <exec dir="${build.doc}" executable="forrest"/>
>        </target>
>    
>        <!-- ================================================================== -->
>        <!-- Build the API JavaDocs                                             -->
>        <!-- ================================================================== -->
>   -    <target name="api" depends="prepare" description="Builds the API javadocs.">
>   -        <mkdir dir="${build.dir}/doc/api"/>
>   -        <javadoc sourcepath="${build.src}"
>   +    <target name="javadoc" depends="prepare" description="Builds the API javadocs.">
>   +        <mkdir dir="${build.javadoc}"/>
>   +        <javadoc sourcepath="${build.src}:${build.srctools}"
>            		 classpathref="compilation-classpath"
>   -                 destdir="${build.dir}/doc/api"
>   +                 destdir="${build.javadoc}"
>                     doctitle="${icon}${br}${name} ${version} API documentation"
>                     windowtitle="${name} ${version} API documentation"
>                     bottom="${copyright}${br}Version: ${version}, ${versiondate}"
>                     public="true"
>                     author="true"
>   +                 version="true"
>                     packagenames="${apipackagenames}"
>            />
>   -        <copy todir="${build.dir}/doc/api">
>   +        <copy todir="${build.javadoc}">
>                <fileset dir="${build.src}" includes="**/*.gif"/>
>            </copy>
>        </target>
>    
>        <!-- ================================================================== -->
>   -    <!-- Build the docs, API and full JavaDocs, doc archives                -->
>   +    <!-- Build the docs and doc archives                                    -->
>        <!-- ================================================================== -->
>        <target name="docs" depends="doc"
>                description="Builds the complete documentation archive.">
>   
>   
>   
>   1.57      +12 -3     db-ojb/build.properties
>   
>   Index: build.properties
>   ===================================================================
>   RCS file: /home/cvs/db-ojb/build.properties,v
>   retrieving revision 1.56
>   retrieving revision 1.57
>   diff -u -r1.56 -r1.57
>   --- build.properties	6 Jun 2004 19:43:22 -0000	1.56
>   +++ build.properties	12 Jun 2004 18:11:58 -0000	1.57
>   @@ -81,6 +81,7 @@
>    src.test=${src.dir}/test
>    src.tools=${src.dir}/tools
>    src.jca=${src.dir}/jca
>   +src.doc=forrest
>    ojb=${source}/ojb
>    etc=${source}/etc
>    test=${build.dir}/test
>   @@ -100,6 +101,8 @@
>    build.desttools = ${build.dir}/classestools
>    build.destjca = ${build.dir}/classesjca
>    build.test = ${build.dir}/test
>   +build.doc=${build.dir}/doc
>   +build.javadoc=${build.dir}/javadoc
>    junit.dir = ${build.dir}/test/ojb
>    junit.fork=true
>    
>   @@ -117,9 +120,15 @@
>    deprecation=true
>    
>    #
>   -# Javadoc properties
>   +# Documentation properties
>    #
>   -# api package names
>   +
>   +forrest.javadoc.destdir=${build.doc}/src/documentation/content/api
>   +forrest.staticfiles.srcdir=${src.test}/org/apache/ojb
>   +forrest.staticfiles.destdir=${build.doc}/src/documentation/content
>   +forrest.output.dir=${build.doc}/build/site
>   +
>   +# api package names for javadoc generation
>    apipackagenames=org.apache.ojb.broker,\
>    org.apache.ojb.broker.accesslayer,\
>    org.apache.ojb.broker.accesslayer.conversions,\
>   
>   
>   
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
> For additional commands, e-mail: ojb-dev-help@db.apache.org
> 
> 
> 

---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org


Mime
View raw message