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

Re: [PATCH] Fix Doxygen comments -- @since and @deprecated should be at the end

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2005-06-01 17:37:14 CEST

Marcel Gosselin wrote:
> Following http://svn.haxx.se/dev/archive-2005-05/1383.shtml I decided to
> go for an easy patch to the Doxygen documentation.
> Here it is, enabling brief comments to appear miraculously in the
> genrated doc.

Thank you very much, Marcel. Committed in r14910, with some additional tweaks
to make the "@since" and "@deprecated" messages more consistent with each
other, since this change is touching nearly all of them anyway.

Your patch was very good. There was just one mistake that I found:

> Index: subversion/include/svn_wc.h
> ===================================================================
[...]
> @@ -2266,11 +2302,13 @@
> svn_wc_traversal_info_t *ti,
> apr_pool_t *pool);
>
> -/** @deprecated Provided for backwards compatibility with the 1.2 API.
> - *
> +/**
> * Similar to svn_wc_get_switch_editor2(), but takes an
> * @c svn_wc_notify_func_t instead.
> - */
> + *
> + * @deprecated Provided for backwards compatibility with the 1.2 API.
> + *
> + /
> svn_error_t *svn_wc_get_switch_editor (svn_revnum_t *target_revision,

The comment-close got split over two lines there. I only noticed because when
I built and tested, my compiler warned: "/*" found inside a comment, a few
lines further on. That function was thereby commented out, but because it's
deprecated it is not used by our code so there was no compilation error.

(The "@deprecated ... 1.2" there also happens to be wrong - it should be 1.1 -
but that's not your fault. I'll fix that separately.)

Thanks again.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed Jun 1 17:45:06 2005

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