> -----Original Message-----
> From: Ara Abrahamian [mailto:[EMAIL PROTECTED]]
> Subject: RE: [Xdoclet-devel] "@feature-change" tag suggestion
> 
> 
> > With such a system, one might make a tag of:
> > 
> >  * @feature-change: The xyz tag now needs to be configured with ...
> 
> Would you please elaborate more? XDoclet generates this tag into the
> generated class? We should make sure it's not an overuse of @tags.

Oh, sorry.  This would be a tag just like @todo with similar output results
(the pretty web pages, mebbe different colors for mental notation on a
crowded screen), but with a semantic result more like "here's what I have
changed, here is critical information that is relevant to make things work".
For instance, I change something in the code that requires an extra parameter
or it silently breaks.  (Yes, I know it's not supposed to silently break, but
that's the way code gets written sometimes.)  @feature-change just makes a
popcorn trail of changes so people using code that doesn't have "up to the
minute" documentation can still get things going.

And just like @todo tags, these are temporary tags.

You could make a @todo tag that blabla needs to be documented, but...

Implementation of this would be simply duplicating whatever was necessary
from the todo tag into the feature-change.  That is, if it was interesting at
all.

The suggestion just comes of frustration getting everything going.  Make no
mistake that I am *very* appreciative of how cool of a tool you guys have
created, but sometimes solving stupid newbie problems can really make the
tool more usable.  And like all developers, once I'm no longer a stupid
newbie, I'm a skilled operator that doesn't remember what it was like to need
these features, so I could never put them in to help someone if I wanted to,
since I could never know the need any longer..

$0.02, FWIW...

-b

_______________________________________________________________

Don't miss the 2002 Sprint PCS Application Developer's Conference
August 25-28 in Las Vegas - 
http://devcon.sprintpcs.com/adp/index.cfm?source=osdntextlink

_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel

Reply via email to