Skip to content

Commit e763803

Browse files
alexeyzimarevalexeyzimarev
committed
Fixing docs
1 parent f46e0d8 commit e763803

34 files changed

+695
-2727
lines changed

‎.idea/.gitignore‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎.idea/RestSharp.iml‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/.vuepress/config.js‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ module.exports = {
2424
path: "/usage/",
2525
collapsable: false,
2626
children: [
27-
"/usage/serialization",
28-
"/usage/files",
29-
"/usage/authenticators",
30-
"/usage/parameters",
31-
"/usage/exceptions"
27+
"serialization",
28+
"files",
29+
"authenticators",
30+
"parameters",
31+
"exceptions"
3232
]
3333
},
3434
{
@@ -44,7 +44,10 @@ module.exports = {
4444
path: "/api/",
4545
collapsable: true,
4646
children: [
47-
"/api/RestSharp.md"
47+
"/api/RestSharp",
48+
"/api/RestSharp.Serializers.NewtonsoftJson",
49+
"/api/RestSharp.Serializers.SystemTextJson",
50+
"/api/RestSharp.Serializers.Utf8Json",
4851
]
4952
}
5053
],

‎docs/api/README.md‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎docs/api/RestSharp.Authenticators.md‎

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

44
### Inheritance
55
↳ `object`
6-
7-
### Inherited members
8-
96
### Syntax
107
```csharp
118
public abstract class AuthenticatorBase : IAuthenticator
@@ -33,11 +30,6 @@ Name | Type | Description
3330
```csharp
3431
protected string Token { get; }
3532
```
36-
#### Property value
37-
Type | Description
38-
--- | ---
39-
`string` |
40-
4133

4234

4335
### Method `GetAuthenticationParameter(String)`
@@ -83,9 +75,6 @@ UTF-8 is used by default but some servers might expect ISO-8859-1 encoding.
8375

8476
### Inheritance
8577
↳ `object`<br>&nbsp;&nbsp;↳ `RestSharp.Authenticators.AuthenticatorBase`
86-
87-
### Inherited members
88-
8978
### Syntax
9079
```csharp
9180
public class HttpBasicAuthenticator : AuthenticatorBase, IAuthenticator
@@ -143,9 +132,6 @@ Type | Description
143132

144133
## Interface `IAuthenticator`
145134

146-
147-
### Inherited members
148-
149135
### Syntax
150136
```csharp
151137
public interface IAuthenticator
@@ -175,9 +161,6 @@ JSON WEB TOKEN (JWT) Authenticator class.
175161
176162
### Inheritance
177163
↳ `object`
178-
179-
### Inherited members
180-
181164
### Syntax
182165
```csharp
183166
public class JwtAuthenticator : IAuthenticator
@@ -234,9 +217,6 @@ Tries to Authenticate with the credentials of the currently logged in user, or i
234217

235218
### Inheritance
236219
↳ `object`
237-
238-
### Inherited members
239-
240220
### Syntax
241221
```csharp
242222
public class NtlmAuthenticator : IAuthenticator
@@ -306,9 +286,6 @@ Name | Type | Description
306286
[RFC: The OAuth 1.0 Protocol](http://tools.ietf.org/html/rfc5849)
307287
### Inheritance
308288
↳ `object`
309-
310-
### Inherited members
311-
312289
### Syntax
313290
```csharp
314291
public class OAuth1Authenticator : IAuthenticator
@@ -323,11 +300,6 @@ public class OAuth1Authenticator : IAuthenticator
323300
```csharp
324301
public virtual string Realm { get; set; }
325302
```
326-
#### Property value
327-
Type | Description
328-
--- | ---
329-
`string` |
330-
331303

332304

333305
### Property `ParameterHandling`
@@ -336,11 +308,6 @@ Type | Description
336308
```csharp
337309
public virtual OAuthParameterHandling ParameterHandling { get; set; }
338310
```
339-
#### Property value
340-
Type | Description
341-
--- | ---
342-
`RestSharp.Authenticators.OAuth.OAuthParameterHandling` |
343-
344311

345312

346313
### Property `SignatureMethod`
@@ -349,11 +316,6 @@ Type | Description
349316
```csharp
350317
public virtual OAuthSignatureMethod SignatureMethod { get; set; }
351318
```
352-
#### Property value
353-
Type | Description
354-
--- | ---
355-
`RestSharp.Authenticators.OAuth.OAuthSignatureMethod` |
356-
357319

358320

359321
### Property `SignatureTreatment`
@@ -362,11 +324,6 @@ Type | Description
362324
```csharp
363325
public virtual OAuthSignatureTreatment SignatureTreatment { get; set; }
364326
```
365-
#### Property value
366-
Type | Description
367-
--- | ---
368-
`RestSharp.Authenticators.OAuth.OAuthSignatureTreatment` |
369-
370327

371328

372329
### Method `Authenticate(IRestClient, IRestRequest)`
@@ -578,9 +535,6 @@ abstract class.
578535

579536
### Inheritance
580537
↳ `object`
581-
582-
### Inherited members
583-
584538
### Syntax
585539
```csharp
586540
[Obsolete("Check the OAuth2 authenticators implementation on how to use the AuthenticatorBase instead")]
@@ -611,11 +565,6 @@ Gets the access token.
611565
```csharp
612566
public string AccessToken { get; }
613567
```
614-
#### Property value
615-
Type | Description
616-
--- | ---
617-
`string` |
618-
619568

620569

621570
### Method `Authenticate(IRestClient, IRestRequest)`
@@ -660,9 +609,6 @@ Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.1
660609

661610
### Inheritance
662611
↳ `object`<br>&nbsp;&nbsp;↳ `RestSharp.Authenticators.AuthenticatorBase`
663-
664-
### Inherited members
665-
666612
### Syntax
667613
```csharp
668614
public class OAuth2AuthorizationRequestHeaderAuthenticator : AuthenticatorBase, IAuthenticator
@@ -726,9 +672,6 @@ Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.2
726672
727673
### Inheritance
728674
↳ `object`<br>&nbsp;&nbsp;↳ `RestSharp.Authenticators.AuthenticatorBase`
729-
730-
### Inherited members
731-
732675
### Syntax
733676
```csharp
734677
public class OAuth2UriQueryParameterAuthenticator : AuthenticatorBase, IAuthenticator
@@ -772,9 +715,6 @@ Type | Description
772715

773716
### Inheritance
774717
↳ `object`
775-
776-
### Inherited members
777-
778718
### Syntax
779719
```csharp
780720
public class SimpleAuthenticator : IAuthenticator

‎docs/api/RestSharp.Deserializers.md‎

Lines changed: 0 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ Allows control how class and property names and values are deserialized by XmlAt
55

66
### Inheritance
77
↳ `object`<br>&nbsp;&nbsp;↳ `System.Attribute`
8-
9-
### Inherited members
10-
118
### Syntax
129
```csharp
1310
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property, Inherited = false)]
@@ -25,11 +22,6 @@ The name to use for the serialized element
2522
```csharp
2623
public string Name { get; set; }
2724
```
28-
#### Property value
29-
Type | Description
30-
--- | ---
31-
`string` |
32-
3325

3426

3527
### Property `Attribute`
@@ -40,11 +32,6 @@ Sets if the property to Deserialize is an Attribute or Element (Default: false)
4032
```csharp
4133
public bool Attribute { get; set; }
4234
```
43-
#### Property value
44-
Type | Description
45-
--- | ---
46-
`bool` |
47-
4835

4936

5037
### Property `Content`
@@ -55,18 +42,10 @@ Sets if the property to Deserialize is a content of current Element (Default: fa
5542
```csharp
5643
public bool Content { get; set; }
5744
```
58-
#### Property value
59-
Type | Description
60-
--- | ---
61-
`bool` |
62-
6345

6446

6547
## Interface `IDeserializer`
6648

67-
68-
### Inherited members
69-
7049
### Syntax
7150
```csharp
7251
public interface IDeserializer
@@ -104,9 +83,6 @@ Wrapper for System.Xml.Serialization.XmlSerializer.
10483

10584
### Inheritance
10685
↳ `object`
107-
108-
### Inherited members
109-
11086
### Syntax
11187
```csharp
11288
public class DotNetXmlDeserializer : IXmlDeserializer, IDeserializer, IWithRootElement
@@ -123,11 +99,6 @@ Encoding for serialized content
12399
```csharp
124100
public Encoding Encoding { get; set; }
125101
```
126-
#### Property value
127-
Type | Description
128-
--- | ---
129-
`System.Text.Encoding` |
130-
131102

132103

133104
### Property `RootElement`
@@ -138,11 +109,6 @@ Name of the root element to use when serializing
138109
```csharp
139110
public string RootElement { get; set; }
140111
```
141-
#### Property value
142-
Type | Description
143-
--- | ---
144-
`string` |
145-
146112

147113

148114
### Property `Namespace`
@@ -153,11 +119,6 @@ XML namespace to use when serializing
153119
```csharp
154120
public string Namespace { get; set; }
155121
```
156-
#### Property value
157-
Type | Description
158-
--- | ---
159-
`string` |
160-
161122

162123

163124
### Property `DateFormat`
@@ -166,11 +127,6 @@ Type | Description
166127
```csharp
167128
public string DateFormat { get; set; }
168129
```
169-
#### Property value
170-
Type | Description
171-
--- | ---
172-
`string` |
173-
174130

175131

176132
### Method `Deserialize<T>(IRestResponse)`
@@ -200,9 +156,6 @@ Type | Description
200156

201157
### Inheritance
202158
↳ `object`
203-
204-
### Inherited members
205-
206159
### Syntax
207160
```csharp
208161
public class XmlDeserializer : IXmlDeserializer, IDeserializer, IWithRootElement
@@ -225,11 +178,6 @@ public XmlDeserializer()
225178
```csharp
226179
public CultureInfo Culture { get; set; }
227180
```
228-
#### Property value
229-
Type | Description
230-
--- | ---
231-
`System.Globalization.CultureInfo` |
232-
233181

234182

235183
### Property `RootElement`
@@ -238,11 +186,6 @@ Type | Description
238186
```csharp
239187
public string RootElement { get; set; }
240188
```
241-
#### Property value
242-
Type | Description
243-
--- | ---
244-
`string` |
245-
246189

247190

248191
### Property `Namespace`
@@ -251,11 +194,6 @@ Type | Description
251194
```csharp
252195
public string Namespace { get; set; }
253196
```
254-
#### Property value
255-
Type | Description
256-
--- | ---
257-
`string` |
258-
259197

260198

261199
### Property `DateFormat`
@@ -264,11 +202,6 @@ Type | Description
264202
```csharp
265203
public string DateFormat { get; set; }
266204
```
267-
#### Property value
268-
Type | Description
269-
--- | ---
270-
`string` |
271-
272205

273206

274207
### Method `Deserialize<T>(IRestResponse)`

0 commit comments

Comments
 (0)