[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: since, status and specnote tags
From: |
Tom Tromey |
Subject: |
Re: since, status and specnote tags |
Date: |
12 Jan 2005 12:02:21 -0700 |
User-agent: |
Gnus/5.09 (Gnus v5.9.0) Emacs/21.3.50 |
>>>>> "Robert" == Robert Schuster <address@hidden> writes:
Robert> What should @specnote or @status describe?
I agree with Michael about the meaning of @specnote.
Sometimes we mention the class status in the header comments (perhaps
with @status, though I haven't looked for that). I usually find this
not very useful, since often the class is updated and the status is
not. I think we should just drop @status (and @version).
Robert> Regarding the @since tag: Should we strive to version every class and
Robert> method?
In my opinion, everything except those classes and methods that were
present in 1.0 should have an @since tag.
In 1.5 we could introduce an address@hidden' attribute and make this
information available to compilers and other tools. I'm not sure if
this is useful or not, I just thought I'd throw it out there.
Tom