You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by ju...@apache.org on 2011/10/12 15:57:25 UTC
svn commit: r1182373 - /subversion/trunk/subversion/include/svn_types.h
Author: julianfoad
Date: Wed Oct 12 13:57:25 2011
New Revision: 1182373
URL: http://svn.apache.org/viewvc?rev=1182373&view=rev
Log:
* subversion/include/svn_types.h
Adjust white space to make consistent breaks between functional sections.
Modified:
subversion/trunk/subversion/include/svn_types.h
Modified: subversion/trunk/subversion/include/svn_types.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_types.h?rev=1182373&r1=1182372&r2=1182373&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_types.h (original)
+++ subversion/trunk/subversion/include/svn_types.h Wed Oct 12 13:57:25 2011
@@ -147,9 +147,13 @@ typedef struct svn_error_t
} svn_error_t;
+
+
/* See svn_version.h.
Defined here to avoid including svn_version.h from all public headers. */
typedef struct svn_version_t svn_version_t;
+
+
/** @defgroup APR_ARRAY_compat_macros APR Array Compatibility Helper Macros
* These macros are provided by APR itself from version 1.3.
@@ -168,6 +172,8 @@ typedef struct svn_version_t svn_version
#endif
/** @} */
+
+
/** @defgroup apr_hash_utilities APR Hash Table Helpers
* These functions enable the caller to dereference an APR hash table index
@@ -189,6 +195,10 @@ svn__apr_hash_index_klen(const apr_hash_
void *
svn__apr_hash_index_val(const apr_hash_index_t *hi);
+/** @} */
+
+
+
/** On Windows, APR_STATUS_IS_ENOTDIR includes several kinds of
* invalid-pathname error but not ERROR_INVALID_NAME, so we include it.
* We also include ERROR_DIRECTORY as that was not included in apr versions
@@ -203,6 +213,8 @@ svn__apr_hash_index_val(const apr_hash_i
#endif
/** @} */
+
+
/** A node kind.
*
@@ -283,6 +295,7 @@ svn__kind_from_node_kind(svn_node_kind_t
svn_boolean_t is_symlink);
+
/** Generic three-state property to represent an unknown value for values
* that are just like booleans. The values have been set deliberately to
* make tristates disjoint from #svn_boolean_t.
@@ -316,6 +329,7 @@ svn_tristate_t
svn_tristate__from_word(const char * word);
+
/** About Special Files in Subversion
*
* Subversion denotes files that cannot be portably created or
@@ -353,6 +367,8 @@ svn_tristate__from_word(const char * wor
* routines from 1.
*/
+
+
/** A revision number. */
typedef long int svn_revnum_t;
@@ -399,6 +415,7 @@ svn_revnum_parse(svn_revnum_t *rev,
#define SVN_REVNUM_T_FMT "ld"
+
/** The size of a file in the Subversion FS. */
typedef apr_int64_t svn_filesize_t;
@@ -416,6 +433,7 @@ typedef apr_int64_t svn_filesize_t;
#endif
+
/** An enum to indicate whether recursion is needed. */
enum svn_recurse_kind
{
@@ -473,7 +491,6 @@ typedef enum svn_depth_t
} svn_depth_t;
-
/** Return a constant string expressing @a depth as an English word,
* e.g., "infinity", "immediates", etc. The string is not localized,
* as it may be used for client<->server communications.
@@ -483,7 +500,6 @@ typedef enum svn_depth_t
const char *
svn_depth_to_word(svn_depth_t depth);
-
/** Return the appropriate depth for @a depth_str. @a word is as
* returned from svn_depth_to_word(). If @a depth_str does not
* represent a recognized depth, return #svn_depth_unknown.
@@ -493,7 +509,6 @@ svn_depth_to_word(svn_depth_t depth);
svn_depth_t
svn_depth_from_word(const char *word);
-
/* Return #svn_depth_infinity if boolean @a recurse is TRUE, else
* return #svn_depth_files.
*
@@ -505,7 +520,6 @@ svn_depth_from_word(const char *word);
#define SVN_DEPTH_INFINITY_OR_FILES(recurse) \
((recurse) ? svn_depth_infinity : svn_depth_files)
-
/* Return #svn_depth_infinity if boolean @a recurse is TRUE, else
* return #svn_depth_immediates.
*
@@ -517,7 +531,6 @@ svn_depth_from_word(const char *word);
#define SVN_DEPTH_INFINITY_OR_IMMEDIATES(recurse) \
((recurse) ? svn_depth_infinity : svn_depth_immediates)
-
/* Return #svn_depth_infinity if boolean @a recurse is TRUE, else
* return #svn_depth_empty.
*
@@ -529,7 +542,6 @@ svn_depth_from_word(const char *word);
#define SVN_DEPTH_INFINITY_OR_EMPTY(recurse) \
((recurse) ? svn_depth_infinity : svn_depth_empty)
-
/* Return a recursion boolean based on @a depth.
*
* Although much code has been converted to use depth, some code still
@@ -542,6 +554,7 @@ svn_depth_from_word(const char *word);
? TRUE : FALSE)
+
/**
* It is sometimes convenient to indicate which parts of an #svn_dirent_t
* object you are actually interested in, so that calculating and sending
@@ -599,7 +612,6 @@ typedef struct svn_dirent_t
/* IMPORTANT: If you extend this struct, check svn_dirent_dup(). */
} svn_dirent_t;
-
/** Return a deep copy of @a dirent, allocated in @a pool.
*
* @since New in 1.4.
@@ -608,8 +620,8 @@ svn_dirent_t *
svn_dirent_dup(const svn_dirent_t *dirent,
apr_pool_t *pool);
-
+
/** Keyword substitution.
*
* All the keywords Subversion recognizes.
@@ -686,6 +698,7 @@ svn_dirent_dup(const svn_dirent_t *diren
/** @} */
+
/** All information about a commit.
*
@@ -714,7 +727,6 @@ typedef struct svn_commit_info_t
} svn_commit_info_t;
-
/**
* Allocate an object of type #svn_commit_info_t in @a pool and
* return it.
@@ -732,7 +744,6 @@ typedef struct svn_commit_info_t
svn_commit_info_t *
svn_create_commit_info(apr_pool_t *pool);
-
/**
* Return a deep copy @a src_commit_info allocated in @a pool.
*
@@ -742,6 +753,7 @@ svn_commit_info_t *
svn_commit_info_dup(const svn_commit_info_t *src_commit_info,
apr_pool_t *pool);
+
/**
* A structure to represent a path that changed for a log entry.
@@ -820,7 +832,6 @@ typedef struct svn_log_changed_path_t
} svn_log_changed_path_t;
-
/**
* Return a deep copy of @a changed_path, allocated in @a pool.
*
@@ -970,7 +981,6 @@ svn_log_entry_dup(const svn_log_entry_t
*
* @since New in 1.5.
*/
-
typedef svn_error_t *(*svn_log_entry_receiver_t)(
void *baton,
svn_log_entry_t *log_entry,
@@ -991,6 +1001,7 @@ typedef svn_error_t *(*svn_log_message_r
const char *message,
apr_pool_t *pool);
+
/** Callback function type for commits.
*
@@ -1016,6 +1027,7 @@ typedef svn_error_t *(*svn_commit_callba
const char *author,
void *baton);
+
/** A buffer size that may be used when processing a stream of data.
*
@@ -1068,7 +1080,6 @@ svn_error_t *
svn_mime_type_validate(const char *mime_type,
apr_pool_t *pool);
-
/** Return FALSE iff @a mime_type is a textual type.
*
* All mime types that start with "text/" are textual, plus some special
@@ -1139,6 +1150,8 @@ svn_lock_create(apr_pool_t *pool);
svn_lock_t *
svn_lock_dup(const svn_lock_t *lock, apr_pool_t *pool);
+
+
/**
* Return a formatted Universal Unique IDentifier (UUID) string.
*
@@ -1147,6 +1160,8 @@ svn_lock_dup(const svn_lock_t *lock, apr
const char *
svn_uuid_generate(apr_pool_t *pool);
+
+
/**
* Mergeinfo representing a merge of a range of revisions.
*
@@ -1212,7 +1227,6 @@ typedef struct svn_location_segment_t
} svn_location_segment_t;
-
/**
* A callback invoked by generators of #svn_location_segment_t
* objects, used to report information about a versioned object's
@@ -1224,7 +1238,6 @@ typedef svn_error_t *(*svn_location_segm
void *baton,
apr_pool_t *pool);
-
/**
* Return a deep copy of @a segment, allocated in @a pool.
*
@@ -1236,6 +1249,8 @@ svn_location_segment_dup(const svn_locat
/** @} */
+
+
/** A line number, such as in a file or a stream.
*
* @since New in 1.7.
@@ -1249,6 +1264,7 @@ typedef unsigned long svn_linenum_t;
#define SVN_LINENUM_MAX_VALUE ULONG_MAX
+
#ifdef __cplusplus
}
#endif /* __cplusplus */