[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

RE: [Fwd: Q on keyword substitution]

From: jsWalter
Subject: RE: [Fwd: Q on keyword substitution]
Date: Fri, 7 Jan 2005 10:39:43 -0600 (CST)
User-agent: SquirrelMail/1.5.1 [CVS]

> Thomas Marsh wrote:
>> looking at an example of java code in the apache struts cvs repository, I
>> see
>> /**
>> ~ * Custom FormBeanConfig to demonstrate usage.
>> ~ *
>> ~ * @version $Revision: 1.2 $ $Date: 2004/03/14 06:23:50 $
>> ~ */
>> Is this not the kind of documentation you want?
> I suspect not. This will work for '@version', which I gather is similar
> in concept to the $REvision$ keyword - i.e. it gets updated whenever the
> file is checked out (I'm not familiar with phpDocumentor, I'm just
> guessing).

@version is just a label. It will display anything you want there.

If you marry that with $Version: $ then you hae an automatic version label
that updates all by itself.

   @version $Version: $

> Walter wants to use the @since keyword, which I gather indicates when a
> specific feature was added. This is *not* something you want updated each
> time you check out the file.


Right on the money!


reply via email to

[Prev in Thread] Current Thread [Next in Thread]