XML document additions
authorAndrew Skiba <andrews@mono-cvs.ximian.com>
Mon, 27 Nov 2006 13:49:52 +0000 (13:49 -0000)
committerAndrew Skiba <andrews@mono-cvs.ximian.com>
Mon, 27 Nov 2006 13:49:52 +0000 (13:49 -0000)
svn path=/trunk/mcs/; revision=68512

mcs/class/System.Web/Test/mainsoft/NunitWeb/NunitWeb/BaseRequest.cs
mcs/class/System.Web/Test/mainsoft/NunitWeb/NunitWeb/IForeignData.cs
mcs/class/System.Web/Test/mainsoft/NunitWeb/NunitWeb/PostableRequest.cs

index 89e6a4019288486ed4795a0b67c11e8392e20eb8..b0bc2d0118d8ccfb902376b76ac55d81c1b63a05 100644 (file)
@@ -79,11 +79,28 @@ namespace MonoTests.SystemWeb.Framework
                        return br;
                }\r
 \r
+               /// <summary>\r
+               /// Create a new <see cref="WebRequest"/>.\r
+               /// </summary>\r
+               /// <remarks>\r
+               /// This method is used when the test web application is not hosted, but deployed. Possible\r
+               /// uses: test web application is remoted, Grasshopper setup with web application running\r
+               /// on Tomcat.\r
+               /// </remarks>\r
+               /// <param name="baseUri">URI to send request to.</param>\r
+               /// <param name="headers">Collection of headers to add to request</param>\r
+               /// <returns>A new <see cref="HttpWebRequest"/>.</returns>\r
                public virtual WebRequest CreateWebRequest (Uri baseUri, NameValueCollection headers)\r
                {\r
                        return CreateHttpWebRequest (baseUri, headers);\r
                }\r
 \r
+               /// <summary>\r
+               /// Create a new <see cref="HttpWorkerRequest"/> by using <see cref="WebRequest.Create"/>.\r
+               /// </summary>\r
+               /// <param name="baseUri">URI to pass to <see cref="WebRequest.Create"/></param>\r
+               /// <param name="headers">Headers to add to the created <see cref="HttpWorkerRequest"/></param>\r
+               /// <returns>A new <see cref="HttpWorkerRequest"/></returns>\r
                protected virtual HttpWebRequest CreateHttpWebRequest (Uri baseUri, NameValueCollection headers)\r
                {\r
                        string reqUrl = Url;\r
@@ -122,7 +139,8 @@ namespace MonoTests.SystemWeb.Framework
 
                /// <summary>
                /// Extracts the response from the completed <see cref="System.Web.HttpWorkerRequest"/>
-               /// and returns a new <see cref="Response"/> instance.
+               /// and returns a new <see cref="Response"/> instance. This method works with HttpWorkerRequest
+               /// created with <see cref="CreateWorkerRequest"/>.
                /// </summary>
                /// <param name="request">this must be the same request that was returned by
                /// CreateWorkerRequest</param>
@@ -142,6 +160,13 @@ namespace MonoTests.SystemWeb.Framework
                        return r;
                }\r
 \r
+               /// <summary>\r
+               /// This method is used to extract response of the request created by <see cref="CreateWebRequest"/>.\r
+               /// </summary>\r
+               /// <remarks>\r
+               /// </remarks>\r
+               /// <param name="response"></param>\r
+               /// <returns></returns>\r
                public virtual Response ExtractResponse (WebResponse response)\r
                {\r
                        Response r = new Response ();\r
index e1b9db665f9840d3b02398b416508b6b80e11b10..94e0c263db49a278e5c0dd53390c472fde366ec9 100644 (file)
@@ -5,9 +5,11 @@ namespace MonoTests.SystemWeb.Framework {
        /// <summary>\r
        /// This interface is used to add foreign data to the implementing class\r
        /// instances (similar to Python common practice) or AOP field injection.\r
+       /// </summary>\r
+       /// <remarks>\r
        /// This is achieved by convention that every class <b>using</b> this interface\r
        /// passes it's own type to the indexer property.\r
-       /// </summary>\r
+       /// </remarks>\r
        /// <example>\r
        /// class IForeignDataUsingClass\r
        /// {\r
index 848368b524b97941e8d4074dd3483aa014eff74e..ac9e5792c22490fff97a28ff44206d27829de893 100644 (file)
@@ -83,7 +83,16 @@ namespace MonoTests.SystemWeb.Framework
                                wr, UserAgent, EntityBody, ContentType);\r
                }\r
 \r
-               public override WebRequest CreateWebRequest(Uri baseUri, NameValueCollection headers) {\r
+               /// <summary>\r
+               /// Override the base <see cref="CreateWebRequest"/> and add POST method functionality\r
+               /// when necessary.\r
+               /// </summary>\r
+               /// <param name="baseUri">URI to send request to.</param>\r
+               /// <param name="headers">Headers added to the request.</param>\r
+               /// <returns>A new <see cref="WebRequest"/></returns>\r
+               public override WebRequest CreateWebRequest(Uri baseUri, NameValueCollection headers)\r
+               {\r
+                       //FIXME: may be it's better to override CreateHttpWebRequest?\r
                        HttpWebRequest hwr = base.CreateHttpWebRequest (baseUri, headers);\r
                        if (EntityBody == null || !IsPost)\r
                                return hwr;\r