Skip to content
This repository was archived by the owner on Jul 9, 2023. It is now read-only.

Commit 375cd7f

Browse files
committed
2 parents 4b4972f + 70d90cc commit 375cd7f

19 files changed

+54
-29
lines changed

Titanium.Web.Proxy/Http/ConnectRequest.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace Titanium.Web.Proxy.Http
44
{
5+
/// <summary>
6+
/// The tcp tunnel Connect request.
7+
/// </summary>
58
public class ConnectRequest : Request
69
{
710
public ConnectRequest()

Titanium.Web.Proxy/Http/ConnectResponse.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
namespace Titanium.Web.Proxy.Http
66
{
7+
/// <summary>
8+
/// The tcp tunnel connect response object.
9+
/// </summary>
710
public class ConnectResponse : Response
811
{
912
public ServerHelloInfo ServerHelloInfo { get; set; }

Titanium.Web.Proxy/Http/HeaderCollection.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
namespace Titanium.Web.Proxy.Http
1010
{
11+
/// <summary>
12+
/// The http header collection.
13+
/// </summary>
1114
[TypeConverter(typeof(ExpandableObjectConverter))]
1215
public class HeaderCollection : IEnumerable<HttpHeader>
1316
{

Titanium.Web.Proxy/Http/KnownHeaders.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
namespace Titanium.Web.Proxy.Http
22
{
3+
/// <summary>
4+
/// Well known http headers.
5+
/// </summary>
36
public static class KnownHeaders
47
{
58
// Both

Titanium.Web.Proxy/Http/RequestResponseBase.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010

1111
namespace Titanium.Web.Proxy.Http
1212
{
13+
/// <summary>
14+
/// Abstract base class for similar objects shared by both request and response objects.
15+
/// </summary>
1316
public abstract class RequestResponseBase
1417
{
1518
/// <summary>

Titanium.Web.Proxy/Http/Responses/GenericResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
namespace Titanium.Web.Proxy.Http.Responses
55
{
66
/// <summary>
7-
/// Anything other than a 200 or 302 response
7+
/// Anything other than a 200 or 302 http response.
88
/// </summary>
99
public class GenericResponse : Response
1010
{

Titanium.Web.Proxy/Http/Responses/OkResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace Titanium.Web.Proxy.Http.Responses
44
{
55
/// <summary>
6-
/// 200 Ok response
6+
/// The http 200 Ok response.
77
/// </summary>
88
public sealed class OkResponse : Response
99
{

Titanium.Web.Proxy/Http/Responses/RedirectResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace Titanium.Web.Proxy.Http.Responses
44
{
55
/// <summary>
6-
/// Redirect response
6+
/// The http redirect response.
77
/// </summary>
88
public sealed class RedirectResponse : Response
99
{

docs/api/Titanium.Web.Proxy.Http.ConnectRequest.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@
8383

8484
<h1 id="Titanium_Web_Proxy_Http_ConnectRequest" data-uid="Titanium.Web.Proxy.Http.ConnectRequest" class="text-break">Class ConnectRequest
8585
</h1>
86-
<div class="markdown level0 summary"></div>
86+
<div class="markdown level0 summary"><p>The tcp tunnel Connect request.</p>
87+
</div>
8788
<div class="markdown level0 conceptual"></div>
8889
<div class="inheritance">
8990
<h5>Inheritance</h5>

docs/api/Titanium.Web.Proxy.Http.ConnectResponse.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@
8383

8484
<h1 id="Titanium_Web_Proxy_Http_ConnectResponse" data-uid="Titanium.Web.Proxy.Http.ConnectResponse" class="text-break">Class ConnectResponse
8585
</h1>
86-
<div class="markdown level0 summary"></div>
86+
<div class="markdown level0 summary"><p>The tcp tunnel connect response object.</p>
87+
</div>
8788
<div class="markdown level0 conceptual"></div>
8889
<div class="inheritance">
8990
<h5>Inheritance</h5>

docs/api/Titanium.Web.Proxy.Http.HeaderCollection.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@
8383

8484
<h1 id="Titanium_Web_Proxy_Http_HeaderCollection" data-uid="Titanium.Web.Proxy.Http.HeaderCollection" class="text-break">Class HeaderCollection
8585
</h1>
86-
<div class="markdown level0 summary"></div>
86+
<div class="markdown level0 summary"><p>The http header collection.</p>
87+
</div>
8788
<div class="markdown level0 conceptual"></div>
8889
<div class="inheritance">
8990
<h5>Inheritance</h5>

docs/api/Titanium.Web.Proxy.Http.KnownHeaders.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@
8383

8484
<h1 id="Titanium_Web_Proxy_Http_KnownHeaders" data-uid="Titanium.Web.Proxy.Http.KnownHeaders" class="text-break">Class KnownHeaders
8585
</h1>
86-
<div class="markdown level0 summary"></div>
86+
<div class="markdown level0 summary"><p>Well known http headers.</p>
87+
</div>
8788
<div class="markdown level0 conceptual"></div>
8889
<div class="inheritance">
8990
<h5>Inheritance</h5>

docs/api/Titanium.Web.Proxy.Http.RequestResponseBase.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@
8383

8484
<h1 id="Titanium_Web_Proxy_Http_RequestResponseBase" data-uid="Titanium.Web.Proxy.Http.RequestResponseBase" class="text-break">Class RequestResponseBase
8585
</h1>
86-
<div class="markdown level0 summary"></div>
86+
<div class="markdown level0 summary"><p>Abstract base class for similar objects shared by both request and response objects.</p>
87+
</div>
8788
<div class="markdown level0 conceptual"></div>
8889
<div class="inheritance">
8990
<h5>Inheritance</h5>

docs/api/Titanium.Web.Proxy.Http.Responses.GenericResponse.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383

8484
<h1 id="Titanium_Web_Proxy_Http_Responses_GenericResponse" data-uid="Titanium.Web.Proxy.Http.Responses.GenericResponse" class="text-break">Class GenericResponse
8585
</h1>
86-
<div class="markdown level0 summary"><p>Anything other than a 200 or 302 response</p>
86+
<div class="markdown level0 summary"><p>Anything other than a 200 or 302 http response.</p>
8787
</div>
8888
<div class="markdown level0 conceptual"></div>
8989
<div class="inheritance">

docs/api/Titanium.Web.Proxy.Http.Responses.OkResponse.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383

8484
<h1 id="Titanium_Web_Proxy_Http_Responses_OkResponse" data-uid="Titanium.Web.Proxy.Http.Responses.OkResponse" class="text-break">Class OkResponse
8585
</h1>
86-
<div class="markdown level0 summary"><p>200 Ok response</p>
86+
<div class="markdown level0 summary"><p>The http 200 Ok response.</p>
8787
</div>
8888
<div class="markdown level0 conceptual"></div>
8989
<div class="inheritance">

docs/api/Titanium.Web.Proxy.Http.Responses.RedirectResponse.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383

8484
<h1 id="Titanium_Web_Proxy_Http_Responses_RedirectResponse" data-uid="Titanium.Web.Proxy.Http.Responses.RedirectResponse" class="text-break">Class RedirectResponse
8585
</h1>
86-
<div class="markdown level0 summary"><p>Redirect response</p>
86+
<div class="markdown level0 summary"><p>The http redirect response.</p>
8787
</div>
8888
<div class="markdown level0 conceptual"></div>
8989
<div class="inheritance">

docs/api/Titanium.Web.Proxy.Http.Responses.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,13 @@ <h1 id="Titanium_Web_Proxy_Http_Responses" data-uid="Titanium.Web.Proxy.Http.Res
8888
<h3 id="classes">Classes
8989
</h3>
9090
<h4><a class="xref" href="Titanium.Web.Proxy.Http.Responses.GenericResponse.html">GenericResponse</a></h4>
91-
<section><p>Anything other than a 200 or 302 response</p>
91+
<section><p>Anything other than a 200 or 302 http response.</p>
9292
</section>
9393
<h4><a class="xref" href="Titanium.Web.Proxy.Http.Responses.OkResponse.html">OkResponse</a></h4>
94-
<section><p>200 Ok response</p>
94+
<section><p>The http 200 Ok response.</p>
9595
</section>
9696
<h4><a class="xref" href="Titanium.Web.Proxy.Http.Responses.RedirectResponse.html">RedirectResponse</a></h4>
97-
<section><p>Redirect response</p>
97+
<section><p>The http redirect response.</p>
9898
</section>
9999
</article>
100100
</div>

docs/api/Titanium.Web.Proxy.Http.html

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,21 +88,26 @@ <h1 id="Titanium_Web_Proxy_Http" data-uid="Titanium.Web.Proxy.Http" class="text-
8888
<h3 id="classes">Classes
8989
</h3>
9090
<h4><a class="xref" href="Titanium.Web.Proxy.Http.ConnectRequest.html">ConnectRequest</a></h4>
91-
<section></section>
91+
<section><p>The tcp tunnel Connect request.</p>
92+
</section>
9293
<h4><a class="xref" href="Titanium.Web.Proxy.Http.ConnectResponse.html">ConnectResponse</a></h4>
93-
<section></section>
94+
<section><p>The tcp tunnel connect response object.</p>
95+
</section>
9496
<h4><a class="xref" href="Titanium.Web.Proxy.Http.HeaderCollection.html">HeaderCollection</a></h4>
95-
<section></section>
97+
<section><p>The http header collection.</p>
98+
</section>
9699
<h4><a class="xref" href="Titanium.Web.Proxy.Http.HttpWebClient.html">HttpWebClient</a></h4>
97100
<section><p>Used to communicate with the server over HTTP(S)</p>
98101
</section>
99102
<h4><a class="xref" href="Titanium.Web.Proxy.Http.KnownHeaders.html">KnownHeaders</a></h4>
100-
<section></section>
103+
<section><p>Well known http headers.</p>
104+
</section>
101105
<h4><a class="xref" href="Titanium.Web.Proxy.Http.Request.html">Request</a></h4>
102106
<section><p>Http(s) request object</p>
103107
</section>
104108
<h4><a class="xref" href="Titanium.Web.Proxy.Http.RequestResponseBase.html">RequestResponseBase</a></h4>
105-
<section></section>
109+
<section><p>Abstract base class for similar objects shared by both request and response objects.</p>
110+
</section>
106111
<h4><a class="xref" href="Titanium.Web.Proxy.Http.Response.html">Response</a></h4>
107112
<section><p>Http(s) response object</p>
108113
</section>

0 commit comments

Comments
 (0)