subversion-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From julianf...@apache.org
Subject svn commit: r1133449 - in /subversion/trunk: doc/doxygen.conf subversion/include/mod_dav_svn.h
Date Wed, 08 Jun 2011 16:00:30 GMT
Author: julianfoad
Date: Wed Jun  8 16:00:29 2011
New Revision: 1133449

URL: http://svn.apache.org/viewvc?rev=1133449&view=rev
Log:
Improve Doxygen output from mod_dav_svn.h.

* doc/doxygen.conf
  (PREDEFINED): Pre-define 'AP_MODULE_DECLARE()' so that Doxygen doesn't
    think it is a function itself.

* subversion/include/mod_dav_svn.h
  (dav_svn_split_uri, dav_svn_get_repos_path): Convert to Doxygen mark-up.

Modified:
    subversion/trunk/doc/doxygen.conf
    subversion/trunk/subversion/include/mod_dav_svn.h

Modified: subversion/trunk/doc/doxygen.conf
URL: http://svn.apache.org/viewvc/subversion/trunk/doc/doxygen.conf?rev=1133449&r1=1133448&r2=1133449&view=diff
==============================================================================
--- subversion/trunk/doc/doxygen.conf (original)
+++ subversion/trunk/doc/doxygen.conf Wed Jun  8 16:00:29 2011
@@ -1262,6 +1262,7 @@ INCLUDE_FILE_PATTERNS  =
 PREDEFINED             = DOXYGEN \
                          DOXYGEN_SHOULD_SKIP_THIS \
                          __attribute__(x)= \
+                         AP_MODULE_DECLARE(x)=x \
                          "SVN_ERROR_START=typedef enum svn_errno_t {                    
     SVN_WARNING = APR_OS_START_USERERR + 1, " \
                          "SVN_ERRDEF(num,offset,str)=/** str */ num = offset, " \
                          "SVN_ERROR_END=SVN_ERR_LAST } svn_errno_t; "

Modified: subversion/trunk/subversion/include/mod_dav_svn.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/mod_dav_svn.h?rev=1133449&r1=1133448&r2=1133449&view=diff
==============================================================================
--- subversion/trunk/subversion/include/mod_dav_svn.h (original)
+++ subversion/trunk/subversion/include/mod_dav_svn.h Wed Jun  8 16:00:29 2011
@@ -38,24 +38,24 @@ extern "C" {
 
 
 /**
-   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:
+   Given an apache request @a r, a @a uri, and a @a root_path to the svn
+   location block, process @a uri and return many things, allocated in
+   @a r->pool:
 
-   * CLEANED_URI:     The uri with duplicate and trailing slashes removed.
+   - @a cleaned_uri:    The uri with duplicate and trailing slashes removed.
 
-   * TRAILING_SLASH:  Whether the uri had a trailing slash on it.
+   - @a trailing_slash: Whether the uri had a trailing slash on it.
 
    Three special substrings of the uri are returned for convenience:
 
-   * REPOS_BASENAME:  The single path component that is the directory
+   - @a repos_basename: The single path component that is the directory
                       which contains the repository.  (Don't confuse
                       this with the "repository name" as optionally
                       defined via the SVNReposName directive!)
 
-   * RELATIVE_PATH:   The remaining imaginary path components.
+   - @a relative_path:  The remaining imaginary path components.
 
-   * REPOS_PATH:      The actual path within the repository filesystem, or
+   - @a repos_path:     The actual path within the repository filesystem, or
                       NULL if no part of the uri refers to a path in
                       the repository (e.g. "!svn/vcc/default" or
                       "!svn/bln/25").
@@ -65,15 +65,15 @@ extern "C" {
 
        /svn/repos/proj1/!svn/blah/13//A/B/alpha
 
-   In the SVNPath case, this function would receive a ROOT_PATH of
+   In the SVNPath case, this function would receive a @a root_path of
    '/svn/repos/proj1', and in the SVNParentPath case would receive a
-   ROOT_PATH of '/svn/repos'.  But either way, we would get back:
+   @a root_path of '/svn/repos'.  But either way, we would get back:
 
-     * CLEANED_URI:    /svn/repos/proj1/!svn/blah/13/A/B/alpha
-     * REPOS_BASENAME: proj1
-     * RELATIVE_PATH:  /!svn/blah/13/A/B/alpha
-     * REPOS_PATH:     A/B/alpha
-     * TRAILING_SLASH: FALSE
+     - @a cleaned_uri:    /svn/repos/proj1/!svn/blah/13/A/B/alpha
+     - @a repos_basename: proj1
+     - @a relative_path:  /!svn/blah/13/A/B/alpha
+     - @a repos_path:     A/B/alpha
+     - @a trailing_slash: FALSE
 */
 AP_MODULE_DECLARE(dav_error *) dav_svn_split_uri(request_rec *r,
                                                  const char *uri,
@@ -86,8 +86,8 @@ AP_MODULE_DECLARE(dav_error *) dav_svn_s
 
 
 /**
- * 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 @a r and a @a root_path to the svn location
+ * block, set @a *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);



Mime
View raw message