Skip to content

Commit ed35351

Browse files
mediumTajmediumTaj
committed
documentation
1 parent e191d5f commit ed35351

File tree

26 files changed

+1168
-42
lines changed

26 files changed

+1168
-42
lines changed

‎Scripts/Editor/Help/WatsonUnitySDK.chm

-1.86 KB
Binary file not shown.

‎Scripts/Services/AlchemyAPI/AlchemyAPI.cs

Lines changed: 120 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,13 @@ private void SetCredentials()
127127
/// </summary>
128128
public class GetAuthorsRequest : RESTConnector.Request
129129
{
130+
/// <summary>
131+
/// Custom data.
132+
/// </summary>
130133
public string Data { get; set; }
134+
/// <summary>
135+
/// The callback.
136+
/// </summary>
131137
public OnGetAuthors Callback { get; set; }
132138
}
133139

@@ -247,7 +253,13 @@ public bool GetRankedConcepts(OnGetRankedConcepts callback, string source,
247253
/// </summary>
248254
public class GetRankedConceptsRequest : RESTConnector.Request
249255
{
256+
/// <summary>
257+
/// Custom data.
258+
/// </summary>
250259
public string Data { get; set; }
260+
/// <summary>
261+
/// The callback.
262+
/// </summary>
251263
public OnGetRankedConcepts Callback { get; set; }
252264
}
253265

@@ -360,7 +372,13 @@ private void OnGetRankedConceptsResponse(RESTConnector.Request req, RESTConnecto
360372
/// </summary>
361373
public class GetDatesRequest : RESTConnector.Request
362374
{
375+
/// <summary>
376+
/// Custom data.
377+
/// </summary>
363378
public string Data { get; set; }
379+
/// <summary>
380+
/// The callback.
381+
/// </summary>
364382
public OnGetDates Callback { get; set; }
365383
}
366384

@@ -476,7 +494,13 @@ private string GetCurrentDatetime()
476494
/// </summary>
477495
public class GetEmotionsRequest : RESTConnector.Request
478496
{
497+
/// <summary>
498+
/// Custom data.
499+
/// </summary>
479500
public string Data { get; set; }
501+
/// <summary>
502+
/// The callback.
503+
/// </summary>
480504
public OnGetEmotions Callback { get; set; }
481505
}
482506

@@ -611,7 +635,13 @@ public bool ExtractEntities(OnGetEntities callback, string source,
611635
/// </summary>
612636
public class GetEntitiesRequest : RESTConnector.Request
613637
{
638+
/// <summary>
639+
/// Custom data.
640+
/// </summary>
614641
public string Data { get; set; }
642+
/// <summary>
643+
/// The callback.
644+
/// </summary>
615645
public OnGetEntities Callback { get; set; }
616646
}
617647

@@ -714,7 +744,13 @@ private void OnGetEntitiesResponse(RESTConnector.Request req, RESTConnector.Resp
714744
/// </summary>
715745
public class DetectFeedsRequest : RESTConnector.Request
716746
{
747+
/// <summary>
748+
/// Custom data.
749+
/// </summary>
717750
public string Data { get; set; }
751+
/// <summary>
752+
/// The callback.
753+
/// </summary>
718754
public OnDetectFeeds Callback { get; set; }
719755
}
720756

@@ -835,7 +871,13 @@ public bool ExtractKeywords(OnGetKeywords callback, string source,
835871
/// </summary>
836872
public class GetKeywordsRequest : RESTConnector.Request
837873
{
874+
/// <summary>
875+
/// Custom data.
876+
/// </summary>
838877
public string Data { get; set; }
878+
/// <summary>
879+
/// The callback.
880+
/// </summary>
839881
public OnGetKeywords Callback { get; set; }
840882
}
841883

@@ -944,7 +986,13 @@ private void OnGetKeywordsResponse(RESTConnector.Request req, RESTConnector.Resp
944986
/// </summary>
945987
public class GetLanguagesRequest : RESTConnector.Request
946988
{
989+
/// <summary>
990+
/// Custom data.
991+
/// </summary>
947992
public string Data { get; set; }
993+
/// <summary>
994+
/// The callback.
995+
/// </summary>
948996
public OnGetLanguages Callback { get; set; }
949997
}
950998

@@ -1047,7 +1095,13 @@ private void OnGetLanguagesResponse(RESTConnector.Request req, RESTConnector.Res
10471095
/// </summary>
10481096
public class GetMicroformatsRequest : RESTConnector.Request
10491097
{
1098+
/// <summary>
1099+
/// Custom data.
1100+
/// </summary>
10501101
public string Data { get; set; }
1102+
/// <summary>
1103+
/// The callback.
1104+
/// </summary>
10511105
public OnGetMicroformats Callback { get; set; }
10521106
}
10531107

@@ -1153,7 +1207,13 @@ private void OnGetMicroformatsResponse(RESTConnector.Request req, RESTConnector.
11531207
/// </summary>
11541208
public class GetPublicationDateRequest : RESTConnector.Request
11551209
{
1210+
/// <summary>
1211+
/// Custom data.
1212+
/// </summary>
11561213
public string Data { get; set; }
1214+
/// <summary>
1215+
/// The callback.
1216+
/// </summary>
11571217
public OnGetPublicationDate Callback { get; set; }
11581218
}
11591219

@@ -1295,8 +1355,14 @@ public bool GetRelations(OnGetRelations callback, string source,
12951355
/// </summary>
12961356
public class GetRelationsRequest : RESTConnector.Request
12971357
{
1298-
public string Data { get; set; }
1299-
public OnGetRelations Callback { get; set; }
1358+
/// <summary>
1359+
/// Custom data.
1360+
/// </summary>
1361+
public string Data { get; set; }
1362+
/// <summary>
1363+
/// The callback.
1364+
/// </summary>
1365+
public OnGetRelations Callback { get; set; }
13001366
}
13011367

13021368
private void OnGetRelationsResponse(RESTConnector.Request req, RESTConnector.Response resp)
@@ -1404,8 +1470,14 @@ private void OnGetRelationsResponse(RESTConnector.Request req, RESTConnector.Res
14041470
/// </summary>
14051471
public class GetTextSentimentRequest : RESTConnector.Request
14061472
{
1407-
public string Data { get; set; }
1408-
public OnGetTextSentiment Callback { get; set; }
1473+
/// <summary>
1474+
/// Custom data.
1475+
/// </summary>
1476+
public string Data { get; set; }
1477+
/// <summary>
1478+
/// The callback.
1479+
/// </summary>
1480+
public OnGetTextSentiment Callback { get; set; }
14091481
}
14101482

14111483
private void OnGetTextSentimentResponse(RESTConnector.Request req, RESTConnector.Response resp)
@@ -1517,8 +1589,14 @@ private void OnGetTextSentimentResponse(RESTConnector.Request req, RESTConnector
15171589
/// </summary>
15181590
public class GetTargetedSentimentRequest : RESTConnector.Request
15191591
{
1520-
public string Data { get; set; }
1521-
public OnGetTargetedSentiment Callback { get; set; }
1592+
/// <summary>
1593+
/// Custom data.
1594+
/// </summary>
1595+
public string Data { get; set; }
1596+
/// <summary>
1597+
/// The callback.
1598+
/// </summary>
1599+
public OnGetTargetedSentiment Callback { get; set; }
15221600
}
15231601

15241602
private void OnGetTargetedSentimentResponse(RESTConnector.Request req, RESTConnector.Response resp)
@@ -1626,8 +1704,14 @@ private void OnGetTargetedSentimentResponse(RESTConnector.Request req, RESTConne
16261704
/// </summary>
16271705
public class GetRankedTaxomomyRequest : RESTConnector.Request
16281706
{
1629-
public string Data { get; set; }
1630-
public OnGetRankedTaxonomy Callback { get; set; }
1707+
/// <summary>
1708+
/// Custom data.
1709+
/// </summary>
1710+
public string Data { get; set; }
1711+
/// <summary>
1712+
/// The callback.
1713+
/// </summary>
1714+
public OnGetRankedTaxonomy Callback { get; set; }
16311715
}
16321716

16331717
private void OnGetRankedTaxonomyResponse(RESTConnector.Request req, RESTConnector.Response resp)
@@ -1736,8 +1820,14 @@ private void OnGetRankedTaxonomyResponse(RESTConnector.Request req, RESTConnecto
17361820
/// </summary>
17371821
public class GetTextRequest : RESTConnector.Request
17381822
{
1739-
public string Data { get; set; }
1740-
public OnGetText Callback { get; set; }
1823+
/// <summary>
1824+
/// Custom data.
1825+
/// </summary>
1826+
public string Data { get; set; }
1827+
/// <summary>
1828+
/// The callback.
1829+
/// </summary>
1830+
public OnGetText Callback { get; set; }
17411831
}
17421832

17431833
private void OnGetTextResponse(RESTConnector.Request req, RESTConnector.Response resp)
@@ -1908,8 +1998,14 @@ private void OnGetTextResponse(RESTConnector.Request req, RESTConnector.Response
19081998
/// </summary>
19091999
public class GetTitleRequest : RESTConnector.Request
19102000
{
1911-
public string Data { get; set; }
1912-
public OnGetTitle Callback { get; set; }
2001+
/// <summary>
2002+
/// Custom data.
2003+
/// </summary>
2004+
public string Data { get; set; }
2005+
/// <summary>
2006+
/// The callback.
2007+
/// </summary>
2008+
public OnGetTitle Callback { get; set; }
19132009
}
19142010

19152011
private void OnGetTitleResponse(RESTConnector.Request req, RESTConnector.Response resp)
@@ -2093,7 +2189,13 @@ public bool GetCombinedData(OnGetCombinedData callback, string source,
20932189
/// </summary>
20942190
public class CombinedCallRequest : RESTConnector.Request
20952191
{
2192+
/// <summary>
2193+
/// Custom data.
2194+
/// </summary>
20962195
public string Data { get; set; }
2196+
/// <summary>
2197+
/// The callback.
2198+
/// </summary>
20972199
public OnGetCombinedData Callback { get; set; }
20982200
}
20992201

@@ -2191,7 +2293,13 @@ public bool GetNews(OnGetNews callback,
21912293
/// </summary>
21922294
public class GetNewsRequest : RESTConnector.Request
21932295
{
2296+
/// <summary>
2297+
/// Custom data.
2298+
/// </summary>
21942299
public string Data { get; set; }
2300+
/// <summary>
2301+
/// The callback.
2302+
/// </summary>
21952303
public OnGetNews Callback { get; set; }
21962304
}
21972305

‎Scripts/Services/Conversation-Experimental/Conversation-Experimental.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,13 @@ private void MessageResp(RESTConnector.Request req, RESTConnector.Response resp)
129129
#endregion
130130

131131
#region IWatsonService implementation
132-
132+
/// <exclude />
133133
public string GetServiceID()
134134
{
135135
return SERVICE_ID;
136136
}
137137

138+
/// <exclude />
138139
public void GetServiceStatus(ServiceStatus callback)
139140
{
140141
if (Config.Instance.FindCredentials(SERVICE_ID) != null)

‎Scripts/Services/Conversation-Experimental/DataModels.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,9 @@ public class GoTo
400400
#region Version
401401
public class Version
402402
{
403+
/// <summary>
404+
/// The version.
405+
/// </summary>
403406
public const string VERSION = "2016-05-19";
404407
}
405408
#endregion

‎Scripts/Services/Conversation/Conversation.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,12 +194,13 @@ private void MessageResp(RESTConnector.Request req, RESTConnector.Response resp)
194194
#endregion
195195

196196
#region IWatsonService implementation
197-
197+
/// <exclude />
198198
public string GetServiceID()
199199
{
200200
return SERVICE_ID;
201201
}
202202

203+
/// <exclude />
203204
public void GetServiceStatus(ServiceStatus callback)
204205
{
205206
if (Config.Instance.FindCredentials(SERVICE_ID) != null)

‎Scripts/Services/Conversation/DataModels.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,9 @@ public class GoTo
400400
#region Version
401401
public class Version
402402
{
403+
/// <summary>
404+
/// The version.
405+
/// </summary>
403406
public const string VERSION = "2016-07-11";
404407
}
405408
#endregion

0 commit comments

Comments
 (0)