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

Re: [PATCH] Use @note and @par doxygen flags to emphasize the Note and Important sections

From: Marcel Gosselin <marcel.gosselin_at_polymtl.ca>
Date: 2006-09-01 04:38:17 CEST

Commited in r21328

Karl Fogel a écrit :
> Marcel Gosselin <marcel.gosselin@polymtl.ca> writes:
>
>> Karl Fogel a écrit :
>>
>>> Marcel Gosselin <marcel.gosselin@polymtl.ca> writes:
>>>
>>>
>>>> [[[
>>>> Emphasize correctly the Note and Important sections in doxygen comments
>>>> by using @note and @par doxygen flags
>>>>
>>>> * subversion/include/svn_wc.h,
>>>> subversion/include/svn_client.h
>>>> Doc fix
>>>>
>>>> ]]]
>>>>
>>> Also http://subversion.tigris.org/hacking.html#obvious-fix I think...
>>>
>>>
>> I didn`t think I had the right to commit files outside the
>> subversion/po directory
>>
>
> That's why we documented the "obvious fix" rule :-).
>
> -Karl
>
>
>>>> Marcel Gosselin
>>>> Index: subversion/include/svn_client.h
>>>> ===================================================================
>>>> --- subversion/include/svn_client.h (révision 21319)
>>>> +++ subversion/include/svn_client.h (copie de travail)
>>>> @@ -930,7 +930,8 @@
>>>> * If @a no_ignore is @c FALSE, don't add files or directories that match
>>>> * ignore patterns.
>>>> *
>>>> - * Important: this is a *scheduling* operation. No changes will
>>>> + * @par Important:
>>>> + * This is a *scheduling* operation. No changes will
>>>> * happen to the repository until a commit occurs. This scheduling
>>>> * can be removed with svn_client_revert().
>>>> *
>>>> @@ -1310,7 +1311,8 @@
>>>> *
>>>> * Use @a pool for any temporary allocation.
>>>> *
>>>> - * IMPORTANT: A special case for the revision range HEAD:1, which was present
>>>> + * @par Important:
>>>> + * A special case for the revision range HEAD:1, which was present
>>>> * in svn_client_log(), has been removed from svn_client_log2(). Instead, it
>>>> * is expected that callers will specify the range HEAD:0, to
>>>> avoid a * SVN_ERR_FS_NO_SUCH_REVISION error when invoked against
>>>> an empty repository
>>>> @@ -2566,7 +2568,7 @@
>>>> * more than one changelist.) If @a changelist is NULL, then
>>>> * deassociate any existing changelist from @a path.
>>>> *
>>>> - * Note: this metadata is purely a client-side "bookkeeping"
>>>> + * @note This metadata is purely a client-side "bookkeeping"
>>>> * convenience, and is entirely managed by the working copy.
>>>> *
>>>> * @since New in 1.5.
>>>> Index: subversion/include/svn_wc.h
>>>> ===================================================================
>>>> --- subversion/include/svn_wc.h (révision 21319)
>>>> +++ subversion/include/svn_wc.h (copie de travail)
>>>> @@ -3579,7 +3579,7 @@
>>>> * overwrite any existing value of the attribute. If @a changelist is
>>>> * NULL, then remove any 'changelist' attribute in @a path's entry.
>>>> *
>>>> - * Note: this metadata is purely a client-side "bookkeeping"
>>>> + * @note This metadata is purely a client-side "bookkeeping"
>>>> * convenience, and is entirely managed by the working copy.
>>>> *
>>>> * @since New in 1.5.
>>>> ---------------------------------------------------------------------
>>>> 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
>>
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Fri Sep 1 04:39:17 2006

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