Return-Path: 
 <dev-return-81912-apmail-ant-dev-archive=ant.apache.org@ant.apache.org>
Delivered-To: apmail-ant-dev-archive@www.apache.org
Received: (qmail 92162 invoked from network); 19 Dec 2007 09:52:00 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2)
  by minotaur.apache.org with SMTP; 19 Dec 2007 09:52:00 -0000
Received: (qmail 97533 invoked by uid 500); 19 Dec 2007 09:51:49 -0000
Delivered-To: apmail-ant-dev-archive@ant.apache.org
Received: (qmail 97490 invoked by uid 500); 19 Dec 2007 09:51:49 -0000
Mailing-List: contact dev-help@ant.apache.org; run by ezmlm
Precedence: bulk
List-Unsubscribe: <mailto:dev-unsubscribe@ant.apache.org>
List-Help: <mailto:dev-help@ant.apache.org>
List-Post: <mailto:dev@ant.apache.org>
List-Id: "Ant Developers List" <dev.ant.apache.org>
Reply-To: "Ant Developers List" <dev@ant.apache.org>
Delivered-To: mailing list dev@ant.apache.org
Received: (qmail 97479 invoked by uid 99); 19 Dec 2007 09:51:48 -0000
Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230)
    by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 19 Dec 2007 01:51:48 -0800
X-ASF-Spam-Status: No, hits=-0.0 required=10.0
	tests=SPF_PASS
X-Spam-Check-By: apache.org
Received-SPF: pass (nike.apache.org: local policy)
Received: from [193.109.238.66] (HELO dnsinet.rzf-nrw.de) (193.109.238.66)
    by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 19 Dec 2007 09:51:37 +0000
Received: from z011100.bk.fin.local (z011100.bk.fin.local [172.18.101.140])
	by dnsinet.rzf-nrw.de (8.14.0/8.14.0) with ESMTP id lBJ9pRF0023221
	for <dev@ant.apache.org>; Wed, 19 Dec 2007 10:51:27 +0100
Received: from z011034.bk.fin.local ([130.11.7.34]) by z011100.bk.fin.local
 with Microsoft SMTPSVC(6.0.3790.1830);
	 Wed, 19 Dec 2007 10:51:27 +0100
Content-class: urn:content-classes:message
MIME-Version: 1.0
Content-Type: text/plain;
	charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
X-MimeOLE: Produced By Microsoft Exchange V6.5
Subject: AW: Ant Documentation
Date: Wed, 19 Dec 2007 10:51:27 +0100
Message-ID: <EF39D77A486C234B9D9933091CE6D21E020F88B3@z011034.bk.fin.local>
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
Thread-Topic: Ant Documentation
Thread-Index: AchBvp6dIVHSW9oxQ3mwVFcwpYHZlAAZBaYg
References: <47674C5D.5040207@umd.edu>
 <ab8e556c0712172035v722c9b73va23bd75a0e052d81@mail.gmail.com>
 <47683DCB.6060303@umd.edu>
From: <Jan.Materne@rzf.fin-nrw.de>
To: <dev@ant.apache.org>
X-OriginalArrivalTime: 19 Dec 2007 09:51:27.0995 (UTC)
 FILETIME=[B9964CB0:01C84224]
X-Virus-Checked: Checked by ClamAV on apache.org

> Well, I found the following project on SourceForge, which uses Java's
> Doclet API such that running JavaDoc outputs data to XML=20
> instead of HTML:
>=20
> http://jeldoclet.sourceforge.net/
>=20
> If the output is XML, then (theoretically) it could be=20
> transformed into
> DocBook format.  Does this fulfill the desired effect?


The target is a user manual.=20
We could get lots of information from the javadocs, but not all. I see
different possible
sources for information for the manual:
* javasources (javadoc+source):=20
  - description of the task
  - description of the attributes and nested elements
* testcases (maybe little bit annotated)
  - examples
* merge files
  - description of the task


The 'problem' could be, that there could be a different meaning in
"description".
The Ant user needs other information than the user of the Ant API and
JavaDoc is designed for
describing the API.



/**
 * This task is documented.
 * @ant.task=3D"CoreTask"
 */
public MyTask extends Task {
  ...
  /**
   * Sets the name of ...
   * @ant.requiredGroup=3D"setName,addName"
   */
  public void setName(String name) {...}
  public void addName(Name name) {...}
}

<project name=3D"antunit">
    <target name=3D"testA">
        ...
        <manual-start>
        Dies example does nothing meaningful.
        </manual-start>
        <mytask name=3D"a"/>
        <manual-end/>
    </target>
</project>

* description of the task: javadoc of the task
* where to place the manual page: @ant.task
* list of attributes: analyze set*(*) methods (also inhereted ones like
setTaskname)
* description of attributes: javadoc of the setter
* is-required: @ant.required=3D"true|false"
* is-required: @ant.requiredgroup
  =3D=3D> "this is required unless you provide a nested <name>"
  @ant.requiredgroup=3D"setName,addName"=20
  - remove the current method name --> addName
  - add* is nested for element, set* is an attribute


Just thoughts ...



Jan

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