Return-Path: Delivered-To: apmail-jakarta-ant-dev-archive@apache.org Received: (qmail 98260 invoked from network); 18 Jun 2002 19:36:43 -0000 Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131) by daedalus.apache.org with SMTP; 18 Jun 2002 19:36:43 -0000 Received: (qmail 14037 invoked by uid 97); 18 Jun 2002 19:36:36 -0000 Delivered-To: qmlist-jakarta-archive-ant-dev@jakarta.apache.org Received: (qmail 13933 invoked by uid 97); 18 Jun 2002 19:36:35 -0000 Mailing-List: contact ant-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Ant Developers List" Reply-To: "Ant Developers List" Delivered-To: mailing list ant-dev@jakarta.apache.org Received: (qmail 13842 invoked by uid 98); 18 Jun 2002 19:36:35 -0000 X-Antivirus: nagoya (v4198 created Apr 24 2002) From: "Ara Abrahamian" To: "'Ant Developers List'" Subject: RE: Javadoc cleanup for task reference generation Date: Wed, 19 Jun 2002 00:05:31 +0430 Message-ID: <02c301c216ff$5cb0fe10$9232d9d5@ara> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Priority: 3 (Normal) X-MSMail-Priority: Normal X-Mailer: Microsoft Outlook, Build 10.0.2616 Importance: Normal In-Reply-To: <00e201c21663$54b66c50$6401a8c0@darden.virginia.edu> X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2600.0000 X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N Just a suggestion: You can use jrefactory's task to enforce this kind of coding/javadocing conventions. The difference between checkstyle and pretty is that checkstyle only checks the code but pretty actually makes it prettier :-) It can automatically put "Sets the {0} attribute of ..." for setters and so on. It can automatically format the code according to a coding convention file you set up. We're using it in XDoclet with great success. You can't find a single line of code which is code convention incompatible although it's done by different guys. It's active (like xdoclet, you put it in your build), and smart enough to skip cvs-unmodified files and files which are not newer than the compiled ones. PS: Of course it can't strip away "Sets the" prefix from your setters now that they are there :-) Ara. > -----Original Message----- > From: Erik Hatcher [mailto:jakarta-ant@ehatchersolutions.com] > Sent: Tuesday, June 18, 2002 5:29 AM > To: ant-dev > Subject: Javadoc cleanup for task reference generation > > Steve and I will soon be committing a fair bit of Javadoc-only changes to > the 1.5 branch to get the comments friendly for the proposal/xdocs project > as we work on generating a complete task reference for our book. I'm > assuming that no one will object to Javadoc changes, but if so please > speak > up. > > One style question: what is the preferred Javadoc comment style for > setters? > Lots of our comments say "Sets the [attribute name]". We already know its > a > setter, so is it ok to drop the "Sets the" part? > > Our HTML task reference documentation does not have the "Sets the" segue > and > the goal is to get the xdocs project solid enough to drop our HTML > documentation and use generation straight from the source code. I'm > planning > on getting the comments from the HTML files and pasting those over into > Javadoc method comments. Sound ok? > > I'm 95% of the way to having the output of xdocs be what we need, after > getting Javadoc comments cleaned up - even to the point where it uses > IntrospectionHelper internally to ensure its matching Ant's rules exactly. > > Erik > > > > -- > To unsubscribe, e-mail: > For additional commands, e-mail: -- To unsubscribe, e-mail: For additional commands, e-mail: