You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by hw...@apache.org on 2010/03/25 21:52:58 UTC
svn commit: r927592 - in /subversion/trunk/subversion/include: mod_dav_svn.h
svn_diff.h svn_io.h svn_wc.h
Author: hwright
Date: Thu Mar 25 20:52:58 2010
New Revision: 927592
URL: http://svn.apache.org/viewvc?rev=927592&view=rev
Log:
Fix a few doxygen errors in our header files.
* subversion/include/svn_diff.h
subversion/include/svn_io.h
subversion/include/mod_dav_svn.h
subversion/include/svn_wc.h:
Make sure functions get doc'd, and fix an error or two.
Modified:
subversion/trunk/subversion/include/mod_dav_svn.h
subversion/trunk/subversion/include/svn_diff.h
subversion/trunk/subversion/include/svn_io.h
subversion/trunk/subversion/include/svn_wc.h
Modified: subversion/trunk/subversion/include/mod_dav_svn.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/mod_dav_svn.h?rev=927592&r1=927591&r2=927592&view=diff
==============================================================================
--- subversion/trunk/subversion/include/mod_dav_svn.h (original)
+++ subversion/trunk/subversion/include/mod_dav_svn.h Thu Mar 25 20:52:58 2010
@@ -37,7 +37,8 @@ extern "C" {
#endif /* __cplusplus */
-/* Given an apache request R, a URI, and a ROOT_PATH to the svn
+/**
+ Given an apache request R, a URI, and a ROOT_PATH to the svn
location block, process URI and return many things, allocated in
r->pool:
@@ -82,9 +83,9 @@ AP_MODULE_DECLARE(dav_error *) dav_svn_s
const char **repos_path);
-/* Given an apache request R and a ROOT_PATH to the svn location
- block sets *REPOS_PATH to the path of the repository on disk.
-*/
+/**
+ * Given an apache request R and a ROOT_PATH to the svn location
+ * block sets *REPOS_PATH to the path of the repository on disk. */
AP_MODULE_DECLARE(dav_error *) dav_svn_get_repos_path(request_rec *r,
const char *root_path,
const char **repos_path);
Modified: subversion/trunk/subversion/include/svn_diff.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_diff.h?rev=927592&r1=927591&r2=927592&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_diff.h (original)
+++ subversion/trunk/subversion/include/svn_diff.h Thu Mar 25 20:52:58 2010
@@ -770,15 +770,17 @@ svn_diff_mem_string_output_merge(svn_str
/* Diff parsing. If you want to apply a patch to a working copy
* rather than parse it, see svn_client_patch(). */
-/* A single hunk inside a patch
+/**
+ * A single hunk inside a patch
*
* @since New in 1.7. */
typedef struct svn_hunk_t {
- /* The hunk's unidiff text as it appeared in the patch file,
- * without range information. */
+ /** The hunk's unidiff text as it appeared in the patch file,
+ * without range information. */
svn_stream_t *diff_text;
- /* The original and modified texts in the hunk range.
+ /**
+ * The original and modified texts in the hunk range.
* Derived from the diff text.
*
* For example, consider a hunk such as:
@@ -813,42 +815,47 @@ typedef struct svn_hunk_t {
svn_stream_t *original_text;
svn_stream_t *modified_text;
- /* Hunk ranges as they appeared in the patch file.
+ /**
+ * Hunk ranges as they appeared in the patch file.
* All numbers are lines, not bytes. */
svn_linenum_t original_start;
svn_linenum_t original_length;
svn_linenum_t modified_start;
svn_linenum_t modified_length;
- /* Number of lines starting with ' ' before first '+' or '-'. */
+ /** Number of lines starting with ' ' before first '+' or '-'. */
svn_linenum_t leading_context;
- /* Number of lines starting with ' ' after last '+' or '-'. */
+ /** Number of lines starting with ' ' after last '+' or '-'. */
svn_linenum_t trailing_context;
} svn_hunk_t;
-/* Data type to manage parsing of patches.
+/**
+ * Data type to manage parsing of patches.
*
* @since New in 1.7. */
typedef struct svn_patch_t {
- /* Path to the patch file. */
+ /** Path to the patch file. */
const char *path;
- /* The patch file itself. */
+ /** The patch file itself. */
apr_file_t *patch_file;
- /* The old and new file names as retrieved from the patch file.
+ /**
+ * The old and new file names as retrieved from the patch file.
* These paths are UTF-8 encoded and canonicalized, but otherwise
* left unchanged from how they appeared in the patch file. */
const char *old_filename;
const char *new_filename;
- /* An array containing an svn_hunk_t object for each hunk parsed
+ /**
+ * An array containing an svn_hunk_t object for each hunk parsed
* from the patch. */
apr_array_header_t *hunks;
} svn_patch_t;
-/* Return the next @a *patch in @a patch_file.
+/**
+ * Return the next @a *patch in @a patch_file.
* If no patch can be found, set @a *patch to NULL.
* If @a reverse is TRUE, invert the patch while parsing it.
* Allocate results in @a result_pool.
@@ -862,7 +869,8 @@ svn_diff_parse_next_patch(svn_patch_t **
apr_pool_t *result_pool,
apr_pool_t *scratch_pool);
-/* Dispose of @a patch, closing any streams used by it.
+/**
+ * Dispose of @a patch, closing any streams used by it.
*
* @since New in 1.7.
*/
Modified: subversion/trunk/subversion/include/svn_io.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_io.h?rev=927592&r1=927591&r2=927592&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Thu Mar 25 20:52:58 2010
@@ -702,7 +702,7 @@ typedef svn_error_t *(*svn_close_fn_t)(v
*/
typedef svn_error_t *(*svn_io_reset_fn_t)(void *baton);
-/* An opaque type which represents a mark on a stream.
+/** An opaque type which represents a mark on a stream.
*
* @see svn_stream_mark().
* @since New in 1.7.
@@ -1091,7 +1091,7 @@ svn_stream_mark(svn_stream_t *stream,
svn_stream_mark_t **mark,
apr_pool_t *pool);
-/* Seek to a @a mark in a generic @a stream.
+/** Seek to a @a mark in a generic @a stream.
* This function returns the #SVN_ERR_STREAM_SEEK_NOT_SUPPORTED error
* if the stream doesn't implement seeking.
*
Modified: subversion/trunk/subversion/include/svn_wc.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_wc.h?rev=927592&r1=927591&r2=927592&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_wc.h (original)
+++ subversion/trunk/subversion/include/svn_wc.h Thu Mar 25 20:52:58 2010
@@ -3183,7 +3183,7 @@ svn_wc_get_ancestry2(const char **url,
apr_pool_t *result_pool,
apr_pool_t *scratch_pool);
-/* Similar to svn_wc_get_ancestry2(), but using an adm_access baton / relative
+/** Similar to svn_wc_get_ancestry2(), but using an adm_access baton / relative
* path parameter pair.
*
* @deprecated Provided for backward compatibility with the 1.6 API.
@@ -4126,7 +4126,7 @@ svn_wc_copy3(svn_wc_context_t *wc_ctx,
void *notify_baton,
apr_pool_t *scratch_pool);
-/* Similar to svn_wc_copy3(), but takes access batons and a relative path
+/** Similar to svn_wc_copy3(), but takes access batons and a relative path
* and a basename instead of absolute paths and a working copy context.
*
* @since New in 1.2.
@@ -4449,7 +4449,7 @@ svn_wc_add_repos_file4(svn_wc_context_t
void *notify_baton,
apr_pool_t *scratch_pool);
-/* Similar to svn_wc_add_repos_file4, but uses access batons and a
+/** Similar to svn_wc_add_repos_file4, but uses access batons and a
* relative path instead of a working copy context and absolute path.
*
* @since New in 1.6.
@@ -6402,7 +6402,7 @@ svn_wc_merge_prop_diffs(svn_wc_notify_st
* the copy/move source (even if the copy-/move-here replaces a locally
* deleted file).
*
- * If @local_abspath refers to an unversioned or non-existing path, return
+ * If @a local_abspath refers to an unversioned or non-existing path, return
* @c SVN_ERR_WC_PATH_NOT_FOUND. Use @a wc_ctx to access the working copy.
* @a contents may not be @c NULL (unlike @a *contents).
*