Author: cmpilato
Date: Thu Mar 21 19:57:43 2013
New Revision: 1459497
URL: http://svn.apache.org/r1459497
Log:
* subversion/include/svn_props.h
More docstring edits, mostly formatting or minor wording changes.
Modified:
subversion/trunk/subversion/include/svn_props.h
Modified: subversion/trunk/subversion/include/svn_props.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_props.h?rev=1459497&r1=1459496&r2=1459497&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_props.h (original)
+++ subversion/trunk/subversion/include/svn_props.h Thu Mar 21 19:57:43 2013
@@ -91,12 +91,15 @@ svn_prop_array_dup(const apr_array_heade
*/
typedef struct svn_prop_inherited_item_t
{
- /** The absolute working copy path, relative filesystem path, or URL from
- * which the properties in @a prop_hash are inherited. */
+ /** The absolute working copy path, relative filesystem path, or URL
+ * from which the properties in @a prop_hash are inherited. (For
+ * details about which path specification format is in use for a
+ * particular instance of this structure, consult the documentation
+ * for the API which produced it.) */
const char *path_or_url;
- /** A hash of (const char *) inherited property names, and (svn_string_t *)
- * property values. */
+ /** A hash of (<tt>const char *</tt>) inherited property names, and
+ * (<tt>svn_string_t *</tt>) property values. */
apr_hash_t *prop_hash;
} svn_prop_inherited_item_t;
@@ -169,7 +172,7 @@ typedef enum svn_prop_kind
/** Return the property kind of a property named @a prop_name.
*
- * @since New in 1.8
+ * @since New in 1.8.
*/
svn_prop_kind_t
svn_property_kind2(const char *prop_name);
@@ -208,58 +211,58 @@ svn_prop_has_svn_prop(const apr_hash_t *
/** Return @c TRUE iff @a prop_name is a Subversion property whose
* value is interpreted as a boolean.
*
- * @since New in 1.5
+ * @since New in 1.5.
*/
svn_boolean_t
svn_prop_is_boolean(const char *prop_name);
/** Return @c TRUE iff @a prop_name is in the "svn:" name space and is a
- * known revision property. For example, svn:log or svn:date.
+ * known revision property ("svn:log" or "svn:date", e.g.).
*
- * This will return FALSE for any property name that is not known by this
+ * This will return @c FALSE for any property name that is not known by this
* version of the library, even though the name may be known to other (for
* example, later) Subversion software.
*
- * @since New in 1.8
+ * @since New in 1.8.
*/
svn_boolean_t
svn_prop_is_known_svn_rev_prop(const char *prop_name);
/** Return @c TRUE iff @a prop_name is in the "svn:" name space and is a
- * known versioned property that is allowed on a file and/or on a directory.
- * For example, svn:eol-style or svn:ignore or svn:mergeinfo.
+ * known versioned property that is allowed on a file and/or on a
+ * directory ("svn:eol-style", "svn:ignore", or "svn:mergeinfo", e.g.).
*
- * This will return FALSE for any property name that is not known by this
- * version of the library, even though the name may be known to other (for
- * example, later) Subversion software.
+ * This will return @c FALSE for any property name that is not known
+ * by this version of the library, even though the name may be known
+ * to other (for example, later) Subversion software.
*
- * @since New in 1.8
+ * @since New in 1.8.
*/
svn_boolean_t
svn_prop_is_known_svn_node_prop(const char *prop_name);
-/** Return @c TRUE iff @a prop_name is in the "svn:" name space and is a
- * known versioned property that is allowed on a file. For example,
- * svn:eol-style or svn:mergeinfo.
+/** Return @c TRUE iff @a prop_name is in the "svn:" name space and is
+ * a known versioned property that is allowed on a file
+ * ("svn:eol-style" or "svn:mergeinfo", e.g.).
+ *
+ * This will return @c FALSE for any property name that is not known
+ * by this version of the library, even though the name may be known
+ * to other (for example, later) Subversion software.
*
- * This will return FALSE for any property name that is not known by this
- * version of the library, even though the name may be known to other (for
- * example, later) Subversion software.
- *
- * @since New in 1.8
+ * @since New in 1.8.
*/
svn_boolean_t
svn_prop_is_known_svn_file_prop(const char *prop_name);
-/** Return @c TRUE iff @a prop_name represents the name of a Subversion
- * known versioned property that is allowed on a directory. For example,
- * svn:ignore or svn:mergeinfo.
- *
- * This will return FALSE for any property name that is not known by this
- * version of the library, even though the name may be known to other (for
- * example, later) Subversion software.
+/** Return @c TRUE iff @a prop_name is in the "svn:" name space and is
+ * a known versioned property that is allowed on a directory
+ * ("svn:ignore" or "svn:mergeinfo", e.g.).
+ *
+ * This will return @c FALSE for any property name that is not known
+ * by this version of the library, even though the name may be known
+ * to other (for example, later) Subversion software.
*
- * @since New in 1.8
+ * @since New in 1.8.
*/
svn_boolean_t
svn_prop_is_known_svn_dir_prop(const char *prop_name);
@@ -486,9 +489,10 @@ svn_prop_name_is_valid(const char *prop_
/** @} */ /* Meta-data properties */
/**
- * This is a list of all user-vixible and -settable versioned node properties.
+ * This is a list of all user-visible and -settable versioned node
+ * properties.
*
- * @since New in 1.8
+ * @since New in 1.8.
*/
#define SVN_PROP_NODE_ALL_PROPS SVN_PROP_MIME_TYPE, \
SVN_PROP_IGNORE, \
