Skip to content

Commit 04c38ce

Browse files
Erik Bylundkirre-bylund
authored andcommitted
Use the correct ///<summary> style documentation
1 parent a24883e commit 04c38ce

File tree

6 files changed

+344
-371
lines changed

6 files changed

+344
-371
lines changed

Runtime/Client/LootLockerServerRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ public struct LootLockerServerRequest
428428

429429
/// <summary>
430430
/// Query parameters to append to the end of the request URI
431-
/// <para>Example: If you include a dictionary with a key of "page" and a value of "42" (as a string) then the url would become "https: //mydomain.com/endpoint?page=42"</para>
431+
/// Example: If you include a dictionary with a key of "page" and a value of "42" (as a string) then the url would become "https://mydomain.com/endpoint?page=42"
432432
/// </summary>
433433
public Dictionary<string, string> queryParams;
434434

Runtime/Game/Requests/AccountLinkRequest.cs

Lines changed: 30 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
namespace LootLocker.LootLockerEnums
44
{
5-
/*
6-
* Possible account linking process statuses. Undefined means that the object couldn't be constructed correctly
7-
*/
5+
/// <summary> Possible account linking process statuses. Undefined means that the object couldn't be constructed correctly
6+
/// </summary>
87
public enum LootLockerAccountLinkingProcessStatus
98
{
109
Undefined = 0,
@@ -20,55 +19,53 @@ namespace LootLocker.Requests
2019
// Response Definitions
2120
//==================================================
2221

23-
/*
24-
*
25-
*/
22+
/// <summary>
23+
/// </summary>
2624
public class LootLockerAccountLinkStartResponse : LootLockerResponse
2725
{
28-
/*
29-
* ID of the account linking process. Save this as you will need it for checking the linking process status and if you want to cancel it.
30-
*/
26+
/// <summary>
27+
/// ID of the account linking process. Save this as you will need it for checking the linking process status and if you want to cancel it.
28+
/// </summary>
3129
public string Link_id { get; set; }
32-
/*
33-
* Used by the user in the online account linking process
34-
*/
30+
/// <summary>
31+
/// Used by the user in the online account linking process
32+
/// </summary>
3533
public string Code { get; set; }
36-
/*
37-
* Base64 encoded PNG image of a qr code that can be shown to the player for them to scan and open the account linking flow
38-
*/
34+
/// <summary>
35+
/// Base64 encoded PNG image of a qr code that can be shown to the player for them to scan and open the account linking flow
36+
/// </summary>
3937
public string Qr_code { get; set; }
40-
/*
41-
* URL to where the user can continue the online account linking process
42-
*/
38+
/// <summary>
39+
/// URL to where the user can continue the online account linking process
40+
/// </summary>
4341
public string Code_page_url { get; set; }
4442
};
4543

46-
/*
47-
*
48-
*/
44+
/// <summary>
45+
/// </summary>
4946
public class LootLockerAccountLinkProcessStatusResponse : LootLockerResponse
5047
{
51-
/*
52-
* Current status of the specified account linking process
53-
*/
48+
/// <summary>
49+
/// Current status of the specified account linking process
50+
/// </summary>
5451

5552
LootLockerAccountLinkingProcessStatus Status;
56-
/*
57-
* Time when the specified account linking process was started
58-
*/
53+
/// <summary>
54+
/// Time when the specified account linking process was started
55+
/// </summary>
5956
public string Created_at { get; set; }
6057
};
6158

62-
/*
63-
* This response will be empty unless there's an error
64-
*/
59+
/// <summary>
60+
/// This response will be empty unless there's an error
61+
/// </summary>
6562
public class LootLockerCancelAccountLinkingProcessResponse : LootLockerResponse
6663
{
6764
};
6865

69-
/*
70-
* This response will be empty unless there's an error
71-
*/
66+
/// <summary>
67+
/// This response will be empty unless there's an error
68+
/// </summary>
7269
public class LootLockerUnlinkProviderFromAccountResponse : LootLockerResponse
7370
{
7471
};

Runtime/Game/Requests/BalanceRequests.cs

Lines changed: 55 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
namespace LootLocker.LootLockerEnums
44
{
5-
/*
6-
* Possible account linking process statuses. Undefined means that the object couldn't be constructed correctly
7-
*/
5+
/// <summary> Possible account linking process statuses. Undefined means that the object couldn't be constructed correctly
6+
/// </summary>
87
public enum LootLockerWalletHolderTypes
98
{
109
Character = 0,
@@ -18,113 +17,103 @@ namespace LootLocker.Requests
1817
// Data Definitions
1918
//==================================================
2019

21-
/*
22-
*
23-
*/
20+
/// <summary>
21+
/// </summary>
2422
public class LootLockerBalance
2523
{
26-
/*
27-
* Current amount of the given currency in this wallet
28-
*/
24+
/// <summary>
25+
/// Current amount of the given currency in this wallet
26+
/// </summary>
2927
public string amount { get; set; }
30-
/*
31-
* Information about the currency that this balance is in
32-
*/
28+
/// <summary>
29+
/// Information about the currency that this balance is in
30+
/// </summary>
3331
public LootLockerCurrency currency { get; set; }
34-
/*
35-
* The id of the wallet holding this balance
36-
*/
32+
/// <summary>
33+
/// The id of the wallet holding this balance
34+
/// </summary>
3735
public string wallet_id { get; set; }
38-
/*
39-
* The time that this balance was created
40-
*/
36+
/// <summary>
37+
/// The time that this balance was created
38+
/// </summary>
4139
public string created_at { get; set; }
4240
};
4341

4442
//==================================================
4543
// Request Definitions
4644
//==================================================
4745

48-
/*
49-
*
50-
*/
46+
/// <summary>
47+
/// </summary>
5148
public class LootLockerCreditRequest
5249
{
53-
/*
54-
* Amount of the given currency to debit/credit to/from the given wallet
55-
*/
50+
/// <summary> Amount of the given currency to debit/credit to/from the given wallet
51+
/// </summary>
5652
public string amount { get; set; }
57-
/*
58-
* The id of the currency that the amount is given in
59-
*/
53+
/// <summary>
54+
/// The id of the currency that the amount is given in
55+
/// </summary>
6056
public string currency_id { get; set; }
61-
/*
62-
* The id of the wallet to credit/debit to/from
63-
*/
57+
/// <summary> The id of the wallet to credit/debit to/from
58+
/// </summary>
6459
public string wallet_id { get; set; }
6560
};
6661

67-
/*
68-
*
69-
*/
62+
/// <summary>
63+
/// </summary>
7064
public class LootLockerDebitRequest
7165
{
72-
/*
73-
* Amount of the given currency to debit/credit to/from the given wallet
74-
*/
66+
/// <summary> Amount of the given currency to debit/credit to/from the given wallet
67+
/// </summary>
7568
public string amount { get; set; }
76-
/*
77-
* The id of the currency that the amount is given in
78-
*/
69+
/// <summary>
70+
/// The id of the currency that the amount is given in
71+
/// </summary>
7972
public string currency_id { get; set; }
80-
/*
81-
* The id of the wallet to credit/debit to/from
82-
*/
73+
/// <summary> The id of the wallet to credit/debit to/from
74+
/// </summary>
8375
public string wallet_id { get; set; }
8476
};
8577

8678
//==================================================
8779
// Response Definitions
8880
//==================================================
8981

90-
/*
91-
*
92-
*/
82+
/// <summary>
83+
/// </summary>
9384
public class LootLockerListBalancesForWalletResponse : LootLockerResponse
9485
{
95-
/*
96-
* List of balances in different currencies in the requested wallet
97-
*/
86+
/// <summary>
87+
/// List of balances in different currencies in the requested wallet
88+
/// </summary>
9889
public LootLockerBalance[] balances { get; set; }
9990
};
10091

101-
/*
102-
*
103-
*/
92+
/// <summary>
93+
/// </summary>
10494
public class LootLockerBalanceForWalletResponse : LootLockerResponse
10595
{
106-
/*
107-
* The balance of the wallet
108-
*/
96+
/// <summary>
97+
/// The balance of the wallet
98+
/// </summary>
10999
public LootLockerBalance balance { get; set; }
110100
};
111101

112-
/*
113-
*
114-
*/
102+
/// <summary>
103+
/// </summary>
115104
public class LootLockerGetWalletResponse : LootLockerResponse
116105
{
117-
/*
118-
* The unique id of the holder of this wallet
119-
*/
106+
/// <summary>
107+
/// The unique id of the holder of this wallet
108+
/// </summary>
120109
public string holder_id { get; set; }
121-
/*
122-
* The unique id of this wallet
123-
*/
110+
/// <summary>
111+
/// The unique id of this wallet
112+
/// </summary>
124113
public string id { get; set; }
125-
/*
126-
* The type of entity that holds this wallet
127-
*/
114+
/// <summary>
115+
/// The type of entity that holds this wallet
116+
/// </summary>
128117
public LootLockerWalletHolderTypes type { get; set;}
129118
};
130119

0 commit comments

Comments
 (0)