Erik Hatcher wrote:
Doug - I've added it as project ID ant-xdocs to that wiki page. As for technologies - I'm not sure if Velocity and XDoclet are the best technologies to use right now. Let's solicit input from others here on their architecture ideas.


+1 to XDoclet; the only alternative would be Java1.5 annotations and we do not want to go there. If it has one problem, its footprint is atrocious: You have to set the ANT_OPTS env variable up to get enough memory. Now, if Xdoclet forked...

0 to velocity.

One thing I do want is automated generation of task docs for third party projects. I actually use the existing sandbox to do this, but it isnt ideal...I have to <ant> into the sandbox, do some fixup before and after. That is painful, and only works when the Ant CVS tree is checked out...

  <!-- this target does the extra xdocs initialisation -->
  <target name="init-xdocs" depends="init">
    <property name="build.antdocs.dir" location="${build.dir}/xdocs"/>
    <property name="gen.dir" location="${build.antdocs.dir}/gen"/>
    <property name="gen.dir" location="${build.antdocs.dir}/gen"/>
    <property name="build.docs.dir" location="${build.antdocs.dir}/docs"/>
<property name="build.xdocs.dir" location="${build.antdocs.dir}/xdocs"/>
    <property name="xdocs.dir" location="${env.ANT_HOME}/proposal/xdocs" />
    <property name="src.package" value="org/smartfrog/tools/ant/" />
    <path id="xdoclet.extra.classpath">
      <path refid="smartfrog.classpath"/>
      <pathelement location="${smartfrog.tasks.jar}"/>
    </path>
    <property name="xdoclet.extra.classpath.asprop"
      refid="xdoclet.extra.classpath"/>
  </target>

<!-- probe for xdocs, which is only in CVS, not redist packages -->
<target name="probe-xdocs" depends="init-xdocs" >
  <available property="xdocs.found" file="${xdocs.dir}/build.xml"/>
</target>

<target name="want-xdocs" depends="probe-xdocs">
  <fail unless="xdocs.found">
We need the proposal/xdocs source tree from Ant in ${env.ANT_HOME}/proposal/xdocs
   </fail>
</target>


<target name="xdocs" depends="want-xdocs,package"
  description="Run xdoclet over the ant tasks to create doc pages"
  if="xdocs.found">
  <echo>
    running xdocs with classpath=${xdoclet.extra.classpath.asprop}
  </echo>

<ant inheritAll="${ant.inheritAll}" inheritRefs="${ant.inheritRefs}" dir="${xdocs.dir}"
      target="gen-and-prepare-for-docs">
    <property name="src.dir" location="${src.package}"/>
    <property name="src.root" location="src"/>
    <property name="xdoclet.extra.classpath"
      value="${xdoclet.extra.classpath.asprop}"/>
    <property name="gen.dir" location="${gen.dir}"/>
    <property name="xdocs.dir" location="${build.xdocs.dir}"/>
    <property name="build.docs.dir" location="${build.docs.dir}"/>
  </ant>
</target>

<target name="dvsl" depends="xdocs"
  description="use velocity to generate the docs">
<ant inheritAll="${ant.inheritAll}" inheritRefs="${ant.inheritRefs}" dir="${xdocs.dir}/dvsl">
    <property name="src.dir" location="src/org/smartfrog/tools/ant/"/>
    <property name="build.dir" location="${build.antdocs.dir}"/>
    <property name="taskdocs.src" location="${gen.dir}"/>
    <property name="xdocs.dir" location="${build.xdocs.dir}"/>
    <property name="docs.dest" location="${build.docs.dir}"/>
  </ant>
</target>

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to