Skip to content

Commit e191d5f

Browse files
committed
more documentation
1 parent 8d50f3a commit e191d5f

File tree

8 files changed

+99
-4
lines changed

8 files changed

+99
-4
lines changed
30.4 KB
Binary file not shown.

Scripts/Services/Conversation-Experimental/DataModels.cs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -392,10 +392,13 @@ public class GoTo
392392
/// <value><c>true</c> if m return; otherwise, <c>false</c>.</value>
393393
public bool m_return { get; set; }
394394
}
395-
#endregion
395+
#endregion
396396

397-
#region Version
398-
public class Version
397+
/// <summary>
398+
/// The conversation service version.
399+
/// </summary>
400+
#region Version
401+
public class Version
399402
{
400403
public const string VERSION = "2016-05-19";
401404
}

Scripts/Services/Conversation/DataModels.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -394,6 +394,9 @@ public class GoTo
394394
}
395395
#endregion
396396

397+
/// <summary>
398+
/// The conversation service version.
399+
/// </summary>
397400
#region Version
398401
public class Version
399402
{

Scripts/Services/PersonalityInsights/DataModels.cs

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121

2222
namespace IBM.Watson.DeveloperCloud.Services.PersonalityInsights.v2
2323
{
24+
/// <summary>
25+
/// The profile result from Personality Insights.
26+
/// </summary>
2427
[fsObject]
2528
public class Profile
2629
{
@@ -67,6 +70,9 @@ public class Profile
6770
public Warning[] warnings { get; set; }
6871
}
6972

73+
/// <summary>
74+
/// The trait tree node of the trait tree.
75+
/// </summary>
7076
[fsObject]
7177
public class TraitTreeNode
7278
{
@@ -119,6 +125,9 @@ public class TraitTreeNode
119125
public TraitTreeNode[] children { get; set; }
120126
}
121127

128+
/// <summary>
129+
/// The warning object.
130+
/// </summary>
122131
[fsObject]
123132
public class Warning
124133
{
@@ -129,12 +138,15 @@ public class Warning
129138
public string id { get; set; }
130139

131140
/// <summary>
132-
/// The message associated with the id. For WORD_COUNT_MESSAGE, "There were <number> words in the input. We need a minimum of 3,500, preferably 6,000 or more, to compute statistically significant estimates"; for JSON_AS_TEXT, "Request input was processed as text/plain as indicated, however detected a JSON input. Did you mean application/json?".
141+
/// The message associated with the id. For WORD_COUNT_MESSAGE, "There were [number] words in the input. We need a minimum of 3,500, preferably 6,000 or more, to compute statistically significant estimates"; for JSON_AS_TEXT, "Request input was processed as text/plain as indicated, however detected a JSON input. Did you mean application/json?".
133142
/// </summary>
134143
/// <value>The message.</value>
135144
public string message { get; set; }
136145
}
137146

147+
/// <summary>
148+
/// Holder for content items.
149+
/// </summary>
138150
[fsObject]
139151
public class ContentListContainer
140152
{
@@ -145,6 +157,9 @@ public class ContentListContainer
145157
public ContentItem[] contentItems { get; set; }
146158
}
147159

160+
/// <summary>
161+
/// The content item.
162+
/// </summary>
148163
[fsObject]
149164
public class ContentItem
150165
{
@@ -215,6 +230,9 @@ public class ContentItem
215230
public bool forward { get; set; }
216231
}
217232

233+
/// <summary>
234+
/// The content type. Either text, html or json.
235+
/// </summary>
218236
public class ContentType
219237
{
220238
/// <summary>
@@ -233,6 +251,9 @@ public class ContentType
233251
public const string APPLICATION_JSON = "application/json";
234252
}
235253

254+
/// <summary>
255+
/// The content language. Either English, Arabic, Spanish or Japanese.
256+
/// </summary>
236257
public class Language
237258
{
238259
/// <summary>

Scripts/Services/RetrieveAndRank/DataModels.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,9 @@ public class IndexResponse
220220
public ResponseHeader responseHeader { get; set; }
221221
}
222222

223+
/// <summary>
224+
/// The query parameters.
225+
/// </summary>
223226
[fsObject]
224227
public class QueryParams
225228
{

Scripts/Services/RetrieveAndRank/RetrieveAndRank.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,13 +405,21 @@ private void OnGetClusterResponse(RESTConnector.Request req, RESTConnector.Respo
405405
return connector.Send(req);
406406
}
407407

408+
/// <summary>
409+
/// The GetClusterConfigs request.
410+
/// </summary>
408411
public class GetClusterConfigsRequest : RESTConnector.Request
409412
{
410413
public string Data { get; set; }
411414
public string ClusterID { get; set; }
412415
public OnGetClusterConfigs Callback { get; set; }
413416
}
414417

418+
/// <summary>
419+
/// The OnGetClusterConfigs response.
420+
/// </summary>
421+
/// <param name="req"></param>
422+
/// <param name="resp"></param>
415423
private void OnGetClusterConfigsResponse(RESTConnector.Request req, RESTConnector.Response resp)
416424
{
417425
SolrConfigList configData = new SolrConfigList();

Scripts/Services/VisualRecognition/DataModels.cs

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
namespace IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3
2020
{
2121
#region Classify
22+
/// <summary>
23+
/// Holds multiple classifications.
24+
/// </summary>
2225
[fsObject]
2326
public class ClassifyTopLevelMultiple
2427
{
@@ -27,6 +30,9 @@ public class ClassifyTopLevelMultiple
2730
public WarningInfo[] warnings { get; set; }
2831
}
2932

33+
/// <summary>
34+
/// One classification.
35+
/// </summary>
3036
[fsObject]
3137
public class ClassifyTopLevelSingle
3238
{
@@ -37,6 +43,9 @@ public class ClassifyTopLevelSingle
3743
public ClassifyPerClassifier[] classifiers { get; set; }
3844
}
3945

46+
/// <summary>
47+
/// One classifier.
48+
/// </summary>
4049
[fsObject]
4150
public class ClassifyPerClassifier
4251
{
@@ -45,6 +54,9 @@ public class ClassifyPerClassifier
4554
public ClassResult[] classes { get; set; }
4655
}
4756

57+
/// <summary>
58+
/// One class result.
59+
/// </summary>
4860
[fsObject]
4961
public class ClassResult
5062
{
@@ -54,6 +66,9 @@ public class ClassResult
5466
public string type_hierarchy { get; set; }
5567
}
5668

69+
/// <summary>
70+
/// The classify parameters.
71+
/// </summary>
5772
[fsObject]
5873
public class ClassifyParameters
5974
{
@@ -65,6 +80,9 @@ public class ClassifyParameters
6580
#endregion
6681

6782
#region Detect Faces
83+
/// <summary>
84+
/// Multiple faces.
85+
/// </summary>
6886
[fsObject]
6987
public class FacesTopLevelMultiple
7088
{
@@ -73,6 +91,9 @@ public class FacesTopLevelMultiple
7391
public WarningInfo[] warnings { get; set; }
7492
}
7593

94+
/// <summary>
95+
/// One face classification.
96+
/// </summary>
7697
[fsObject]
7798
public class FacesTopLevelSingle
7899
{
@@ -83,6 +104,9 @@ public class FacesTopLevelSingle
83104
public OneFaceResult[] faces { get; set; }
84105
}
85106

107+
/// <summary>
108+
/// One face result.
109+
/// </summary>
86110
[fsObject]
87111
public class OneFaceResult
88112
{
@@ -92,6 +116,9 @@ public class OneFaceResult
92116
public Identity identity { get; set; }
93117
}
94118

119+
/// <summary>
120+
/// Detect faces parameters.
121+
/// </summary>
95122
[fsObject]
96123
public class DetectFacesParameters
97124
{
@@ -100,6 +127,9 @@ public class DetectFacesParameters
100127
#endregion
101128

102129
#region Recognize Text
130+
/// <summary>
131+
/// Mulitple text pages.
132+
/// </summary>
103133
[fsObject]
104134
public class TextRecogTopLevelMultiple
105135
{
@@ -108,6 +138,9 @@ public class TextRecogTopLevelMultiple
108138
public WarningInfo[] warnings { get; set; }
109139
}
110140

141+
/// <summary>
142+
/// One text page.
143+
/// </summary>
111144
[fsObject]
112145
public class TextRecogTopLevelSingle
113146
{
@@ -119,6 +152,9 @@ public class TextRecogTopLevelSingle
119152
public TextRecogOneWord[] words { get; set; }
120153
}
121154

155+
/// <summary>
156+
/// One word.
157+
/// </summary>
122158
[fsObject]
123159
public class TextRecogOneWord
124160
{
@@ -128,6 +164,9 @@ public class TextRecogOneWord
128164
public double line_number { get; set; }
129165
}
130166

167+
/// <summary>
168+
/// Word location.
169+
/// </summary>
131170
[fsObject]
132171
public class Location
133172
{
@@ -137,6 +176,9 @@ public class Location
137176
public double top { get; set; }
138177
}
139178

179+
/// <summary>
180+
/// Recognize text parameters.
181+
/// </summary>
140182
[fsObject]
141183
public class RecognizeTextParameters
142184
{
@@ -145,19 +187,28 @@ public class RecognizeTextParameters
145187
#endregion
146188

147189
#region Classifiers
190+
/// <summary>
191+
/// Classifiers breif.
192+
/// </summary>
148193
[fsObject]
149194
public class GetClassifiersTopLevelBrief
150195
{
151196
public GetClassifiersPerClassifierBrief[] classifiers { get; set; }
152197
}
153198

199+
/// <summary>
200+
/// Classifier breif.
201+
/// </summary>
154202
[fsObject]
155203
public class GetClassifiersPerClassifierBrief
156204
{
157205
public string classifier_id { get; set; }
158206
public string name { get; set; }
159207
}
160208

209+
/// <summary>
210+
/// Classifier verbose.
211+
/// </summary>
161212
[fsObject]
162213
public class GetClassifiersPerClassifierVerbose
163214
{
@@ -170,6 +221,9 @@ public class GetClassifiersPerClassifierVerbose
170221
public Class[] classes { get; set; }
171222
}
172223

224+
/// <summary>
225+
/// The class.
226+
/// </summary>
173227
[fsObject]
174228
public class Class
175229
{

Scripts/Utilities/FrameRateCounter.cs

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

2121
namespace IBM.Watson.DeveloperCloud.Utilities
2222
{
23+
/// <summary>
24+
/// Displays the frame rate of the application.
25+
/// </summary>
2326
public class FrameRateCounter : MonoBehaviour
2427
{
2528
const float FPS_INTERVAL = 0.5f;

0 commit comments

Comments
 (0)