You could use the standard one provided by doxygen. i.e. @deprecated
This has the advantage that it will be documented consistently and you can
also provide a description.
For more see:
http://www.stack.nl/~dimitri/doxygen/commands.html#cmddeprecated
Regards
Chris
----- Original Message -----
From: "D.J. Heap" <dj@shadyvale.net>
To: <kfogel@collab.net>
Cc: <dev@subversion.tigris.org>
Sent: Monday, March 08, 2004 6:36 PM
Subject: Re: The new svn_wc_adm_*_depth functions.
> kfogel@collab.net wrote:
> > Is it our intention that these new functions
> >
> > svn_wc_adm_open_depth
> > svn_wc_adm_probe_try_depth
> > svn_wc_adm_probe_open_depth
> >
> > supersede their non-depth predecessors, and that (eventually) all
> > callers of the predecessors be converted to use the depth versions? I
> > would think so, but just want to make sure here first.
>
>
> I believe so, based on past discussions and the need they address.
>
>
> >
> > If so, it's time to mark the predecessors
> >
> > svn_wc_adm_open
> > svn_wc_adm_probe_try
> > svn_wc_adm_probe_open
> >
> > as 'deprecated'. This should be pretty simple: just make a special
> > 'deprecated' marker that's easy to grep for, and open a single new
> > issue in the 2.0 milestone:
> >
> > "Remove deprecated 1.x interfaces."
> >
> > That issue will give instructions to grep for the special marker. It
> > doesn't really matter whether we convert all the predecessors now, or
> > just make a note in the deprecated function's doc string that it needs
> > to be done before removing the function. (I'd prefer to do it now, if
> > it's not a big task, though, to avoid having bad examples in our
> > code.)
> >
> > I can take care of all this; I just want to make sure it's what we
> > intend.
> >
> > -Karl
>
>
> I can do this and submit a patch tonight or tomorrow if it's not
> time-critical, which I wouldn't think it would be. Is there a standard
> 'deprecated' marker already? I seem to recall a similar discussion, but
> I can't find it and don't see anything in HACKING.
>
> DJ
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
> For additional commands, e-mail: dev-help@subversion.tigris.org
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Mon Mar 8 22:06:38 2004