[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Deprecated functions should say what replaces them [was: An unexpected effect of new 'deprecated' tags.]

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: Thu, 28 Aug 2008 17:06:30 +0100

Stefan KŁng wrote:
> One thing that bugged me about the deprecated functions for some time
> now is the doxygen comment. All deprecated functions only have a text
> like "\deprecated: provided for backward compatibility with the 1.x
> API". But it doesn't say which function to use instead.
>
> For most functions, that's not a big problem: only look for a function
> with the same name but a higher number at the end (e.g.,
> svn_client_merge3 instead of svn_client_merge2). But there are some
> functions which don't have that:
>
> svn_client_ls3 is deprecated, but there is no svn_client_ls4
> svn_client_get_* (auth provider functions) also have no 'higher number
> function'.
>
> For svn_client_ls3, the function to use would be svn_client_list2, and
> for the auth provider functions it would be the svn_auth_get_* functions.
>
> A user who doesn't follow the commits has to search the whole docs to
> find the new function to use.
>
> So I suggest to extend those doxygen comments like this:
> "\deprecated: provided for backward compatibility with the 1.x API. Use
> svn_client_list() instead."
>
> This would make it immediately clear which function superseeds the
> deprecated one.

+1. Can you send a patch? I think this is only necessary for the
functions where it is not just a higher number.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe_at_subversion.tigris.org
For additional commands, e-mail: dev-help_at_subversion.tigris.org
Received on 2008-08-28 18:06:48 CEST

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.