svn commit: r412287 - /webservices/axis2/trunk/c/util/include/axis2_uri.h

[da...@apache.org]

Author: damitha
Date: Tue Jun  6 21:20:59 2006
New Revision: 412287

URL: http://svn.apache.org/viewvc?rev=412287&view=rev
Log:
added documentation to parse_relative method

Modified:
    webservices/axis2/trunk/c/util/include/axis2_uri.h

Modified: webservices/axis2/trunk/c/util/include/axis2_uri.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/util/include/axis2_uri.h?rev=412287&r1=412286&r2=412287&view=diff
==============================================================================
--- webservices/axis2/trunk/c/util/include/axis2_uri.h (original)
+++ webservices/axis2/trunk/c/util/include/axis2_uri.h Tue Jun  6 21:20:59 2006
@@ -174,13 +174,25 @@
         const axis2_env_t *env, 
         const axis2_char_t *hostinfo);
 
-/* Resolve relative to a base.  This means host/etc, and (crucially) path */
+/** Resolve relative to a base.  This means host/etc, and (crucially) path */
 AXIS2_EXTERN axis2_uri_t *AXIS2_CALL 
 axis2_uri_resolve_relative(
         const axis2_env_t *env,
         const axis2_uri_t* base,
         axis2_uri_t* uptr);
 
+/**
+ * Return a URI created from a context URI and a relative URI.
+ * If a valid URI cannot be created the only other possibility
+ * this method will consider is that an absolute file path has
+ * been passed in as the relative URI argument, and it will try
+ * to create a 'file' URI from it.
+ *
+ * @param context_uri the document base URI
+ * @param uri a file URI relative to the context_uri or an
+ * absolute file path
+ * @return the URIcreated from context_uri and uri
+ */
 AXIS2_EXTERN axis2_uri_t *AXIS2_CALL 
 axis2_uri_parse_relative(
         const axis2_env_t *env,



---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org