[PATCH] API documentation fixes and clean-up

[Julian Foad <ju...@btopenworld.com>]

For review:

[[[
Various fixes to API documentation, partly as a follow-up to recent renaming
of 'force' parameters.

* subversion/include/svn_client.h
   (svn_client_diff, svn_client_diff_peg, svn_client_propset):
     Correct the name of a referenced parameter.
   (svn_client_export2): Add a missing description.

* subversion/include/svn_fs.h
   Create a Doxygen group for Access Context documentation.
   (svn_fs_begin_txn2, svn_fs_commit_txn): Use "@note" to tidy up ugly notes.

* subversion/include/svn_repos.h
   (svn_repos_fs_get_locks): Fix typos.

* subversion/include/svn_wc.h
   (svn_wc_adm_open_anchor): Fix mis-use of "@a".
   (svn_wc_notify_t): Be strict: say the user "must" not "should"
     allocate the structure in an extensible way.  Insert a comma.
   (svn_wc_status_set_repos_locks): Fix typos.
   (svn_wc_prop_set): Correct the name of a referenced parameter.
]]]

- Julian

Re: [PATCH] API documentation fixes and clean-up

[Julian Foad <ju...@btopenworld.com>]

Julian Foad wrote:
> For review:
> 
> [[[
> Various fixes to API documentation, partly as a follow-up to recent renaming
> of 'force' parameters.

I have now committed most of this.  The only part I haven't is:

> * subversion/include/svn_wc.h
>   (svn_wc_notify_t): Be strict: say the user "must" not "should"
>     allocate the structure in an extensible way.

I realised that there are different interpretations whichever word we use, that 
the intention is clear enough, and that there are other places where the same 
pattern occurs.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org