Author: julianfoad
Date: Thu Dec 6 22:48:32 2012
New Revision: 1418121
URL: http://svn.apache.org/viewvc?rev=1418121&view=rev
Log:
* subversion/include/svn_wc.h
(svn_wc_conflict_version_t): Tweak the documentation.
(svn_wc_conflict_version_create2): Correct the parameter names
in the doc string, following r1354470, and document the valid values.
Modified:
subversion/trunk/subversion/include/svn_wc.h
Modified: subversion/trunk/subversion/include/svn_wc.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_wc.h?rev=1418121&r1=1418120&r2=1418121&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_wc.h (original)
+++ subversion/trunk/subversion/include/svn_wc.h Thu Dec 6 22:48:32 2012
@@ -1662,10 +1662,10 @@ typedef struct svn_wc_conflict_version_t
const char *path_in_repos;
/** @} */
- /** Info about this node */
- svn_node_kind_t node_kind; /* note that 'none' is a legitimate value */
+ /** The node kind. Can be any kind, even 'none' or 'unknown'. */
+ svn_node_kind_t node_kind;
- /** UUID of the repository
+ /** UUID of the repository. Can be NULL meaning unknown.
* @since New in 1.8. */
const char *repos_uuid;
@@ -1680,11 +1680,15 @@ typedef struct svn_wc_conflict_version_t
* Allocate an #svn_wc_conflict_version_t structure in @a pool,
* initialize to contain a conflict origin, and return it.
*
- * Set the @c repos_url field of the created struct to @a repos_url, the
- * @c path_in_repos field to @a path_in_repos, the @c peg_rev field to
- * @a peg_rev and the @c node_kind to @c node_kind. Make only shallow
+ * Set the @c repos_url field of the created struct to @a repos_root_url,
+ * the @c path_in_repos field to @a repos_relpath, the @c peg_rev field to
+ * @a revision and the @c node_kind to @a kind. Make only shallow
* copies of the pointer arguments.
*
+ * @a repos_root_url, @a repos_relpath and @a revision must be valid,
+ * non-null values. @a repos_uuid should be a valid UUID, but can be
+ * NULL if unknown. @a kind can be any kind, even 'none' or 'unknown'.
+ *
* @since New in 1.8.
*/
svn_wc_conflict_version_t *
