Daniel Shahaf wrote:
>> @@ -6811,6 +6815,7 @@ svn_client_shelves_list(apr_hash_t **she
>> *
>> * @since New in 1.11.
>> */
>> +SVN_EXPERIMENTAL
>
> The doxygen docs should indicate that the function is experimental.
> (I only found this reading Bert's patch from today.)
Thanks for finding these issues.
I added "@warning EXPERIMENTAL" in each Doxygen string.
> The @since is wrong. I'm not sure whether it should be corrected or
> removed (a case could be made that experimental functions shouldn't
> have @since tags until they're declared stable).
I changed them to 1.10.
>> svn_error_t *
>> svn_client_shelves_any(svn_boolean_t *any_shelved,
>> const char *local_abspath,
>> @@ -6824,6 +6829,7 @@ svn_client_shelves_any(svn_boolean_t *an
>> * @a overwrite_existing: If a file at @a patch_abspath exists, overwrite it.
>> * @a paths, @a depth, @a changelists: The selection of local paths to diff.
>> */
>> +SVN_EXPERIMENTAL
>> svn_error_t *
>> svn_client_shelf_write_patch(const char *name,
>> const char *message,
>> @@ -6841,6 +6847,7 @@ svn_client_shelf_write_patch(const char
>> * @a reverse: Apply the patch in reverse.
>> * @a dry_run: Don't really apply the changes, just notify what would be done.
>
> Missing @since.
I added it here and in two more functions.
> Also, this doesn't render correctly in doxygen: it's rendered as
> a single paragraph. Either blank lines should be added to make each
> "@a foo: lorem ipsum" line a paragraph, or @param should be used (we
> already use it in a few places).
I added blank lines, as at least one of the paragraphs declares multiple
parameters which I don't know how to do with @param.
Committed r1816440.
Thanks.
- Julian
Received on 2017-11-27 13:15:17 CET