apr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stas Bekman <s...@stason.org>
Subject Re: timestamping when features are added?
Date Thu, 27 May 2004 23:10:26 GMT
Paul Querna wrote:
> On Thu, 2004-05-27 at 14:13 -0700, Stas Bekman wrote:
> 
>>As a postmortem to the sha1 support added after 2.0.49 was released. Should 
>>the apr docs carry a timestamp/version number of when a certain feature was 
>>added? Like a new tag @since in the doxygen docs? Otherwise how do you know 
>>what is the minimal version you have to require in your app, when you use a 
>>certain API/feature?
>>
> 
> 
> It is in the ChangeLog... or the CVS History.  Thats How I have looked
> up stuff before.  
> 
> Not an optimal solution, a better solution would be to make actual APR
> Releases that go with the HTTPd version being released, instead of
> releasing HTTPd with an APR snapshot.

What about having a new doxygen token:

@since: apr x.x.x and/or apache 2.x.xx

whichever is appropriate. digging through CVS and ChangeLogs is not the most 
efficient way to do that. It doesn't have to be done at once, but at least 
start adding those tags when changing the existing API or introducing the new 
ones.

That's what we are using for mod_perl 2.0 API:
http://perl.apache.org/docs/2.0/api/index.html
Though I think we have only about 25% properly documented so far (Mostly APR:: 
manpages)

-- 
__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com

Mime
View raw message