ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jan.Mate...@rzf.fin-nrw.de
Subject AW: cvs commit: ant/src/main/org/apache/tools/ant/taskdefs Checks um.java
Date Thu, 06 Jan 2005 11:36:20 GMT
Indeed, you can see directly from the code that "a File" is needed.
But you dont know where that should point to. And without comment checkstyle
will remind us until someone has the time to lock (and understand) the
source
for documentation.

Mmh - on the other hand. Simple setters (for tasks) are documented in the
manual.

Jan

> -----Urspr√ľngliche Nachricht-----
> Von: Martijn Kruithof [mailto:jm@kruithof.xs4all.nl]
> Gesendet am: Donnerstag, 6. Januar 2005 12:30
> An: Ant Developers List
> Betreff: Re: cvs commit: ant/src/main/org/apache/tools/ant/taskdefs
> Checksum.java
> 
> I understand the importance of improving the style, but shouldn't we 
> prefer no comments (warnings stay to indicate they are missing)
> over this kind of comments:
> Kind Regards, Martijn
> 
> >  +     * @param file a <code>File</code> value
> >  +     * @param algorithm a <code>String</code> value
> >  +     * @param provider a <code>String</code> value
> >  +     * @param fileext a <code>String</code> value
> >  +     * @param property a <code>String</code> value
> >  +     * @param totalproperty a <code>String</code> value
> >  +     * @param verifyProperty a <code>String</code> value
> >  +     * @param forceOverwrite a <code>boolean</code> value
> >  +     * @param size an <code>int</code> value
> >  +     * @param e an <code>enumerated</code> value
> >  +     * @param p a <code>String</code> value
> >  +     * @throws BuildException on error
> >  +     * @throws BuildException on error
> >  +         * @return a <code>MessageFormat</code> object.
> >  +         * @return an array of values.
> >  
> >
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
> For additional commands, e-mail: dev-help@ant.apache.org
> 

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message