svn commit: r925256 - /subversion/trunk/subversion/mod_dav_svn/dav_svn.h

[ju...@apache.org]

Author: julianfoad
Date: Fri Mar 19 15:08:03 2010
New Revision: 925256

URL: http://svn.apache.org/viewvc?rev=925256&view=rev
Log:
Clarify (to some extent) some mod_dav_svn doc strings.

* subversion/mod_dav_svn/dav_svn.h
  (dav_svn__get_special_uri, dav_svn__get_repo_name, dav_svn__get_xslt_uri,
   dav_svn__get_master_uri, dav_svn__get_activities_db, dav_svn__get_root_dir):
    Document where the return values come from and more precisely what they
    mean.  Add questions about the encoding.

Modified:
    subversion/trunk/subversion/mod_dav_svn/dav_svn.h

Modified: subversion/trunk/subversion/mod_dav_svn/dav_svn.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/mod_dav_svn/dav_svn.h?rev=925256&r1=925255&r2=925256&view=diff
==============================================================================
--- subversion/trunk/subversion/mod_dav_svn/dav_svn.h (original)
+++ subversion/trunk/subversion/mod_dav_svn/dav_svn.h Fri Mar 19 15:08:03 2010
@@ -337,23 +337,34 @@ svn_boolean_t dav_svn__get_list_parentpa
    the root_dir when the resource structure is built.
 */
 
-/* Return the special URI to be used for this resource. */
+/* Return the repo-root-relative URI of the special namespace to be used for
+ * this resource.
+ * Comes from the <SVNSpecialURI> directive. */
+/* ### Is this assumed to be URI-encoded? */
 const char *dav_svn__get_special_uri(request_rec *r);
 
-/* Return a descriptive name for the repository */
+/* Return a descriptive name for the repository.
+ * Comes from the <SVNReposName> directive. */
 const char *dav_svn__get_repo_name(request_rec *r);
 
-/* Return the URI of an XSL transform stylesheet */
+/* Return the server-relative URI of an XSL transform stylesheet.
+   Comes from the <SVNIndexXSLT> directive. */
+/* ### Is this assumed to be URI-encoded? */
 const char *dav_svn__get_xslt_uri(request_rec *r);
 
-/* Return the master URI (for mirroring) */
-const char * dav_svn__get_master_uri(request_rec *r);
-
-/* Return the activities db */
-const char * dav_svn__get_activities_db(request_rec *r);
-
-/* Return the root directory in canonicalized form */
-const char * dav_svn__get_root_dir(request_rec *r);
+/* Return the full URL of the master repository (for mirroring).
+   Comes from the <SVNMasterURI> directive. */
+/* ### Is this assumed to be URI-encoded? */
+const char *dav_svn__get_master_uri(request_rec *r);
+
+/* Return the disk path to the activities db.
+   Comes from the <SVNActivitiesDB> directive. */
+const char *dav_svn__get_activities_db(request_rec *r);
+
+/* Return the server-relative URI of the repository root.
+   Comes from the <Location> directive. */
+/* ### Is this assumed to be URI-encoded? */
+const char *dav_svn__get_root_dir(request_rec *r);
 
 
 /** For HTTP protocol v2, these are the new URIs and URI stubs