namespace documentation, updates to service class documentation

mediumTaj · mediumTaj · commit 8c42508145ce · 2016-07-17T13:41:35.000-05:00
diff --git a/Docs/UnitySDK.shfbproj b/Docs/UnitySDK.shfbproj
diff --git a/Scripts/Camera/WatsonCamera.cs b/Scripts/Camera/WatsonCamera.cs
@@ -57,7 +57,7 @@ public class WatsonCamera : MonoBehaviour
         #region Public Variable
 
 		/// <summary>
-		/// Instance of WatsonCamera.
+		/// Static instance of WatsonCamera.
 		/// </summary>
         public static WatsonCamera Instance
         {
diff --git a/Scripts/Editor/Help/WatsonUnitySDK.chm b/Scripts/Editor/Help/WatsonUnitySDK.chm
diff --git a/Scripts/Services/AlchemyAPI/AlchemyAPI.cs b/Scripts/Services/AlchemyAPI/AlchemyAPI.cs
@@ -29,10 +29,12 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.AlchemyAPI.v1
 {
-    /// <summary>
-    /// Service integration for Alchemy API
-    /// </summary>
-    public class AlchemyAPI : IWatsonService
+	/// <summary>
+	/// This class wraps the Alchemy API Services.
+	/// <a href="http://www.ibm.com/watson/developercloud/alchemy-language.html">Alchemy Language</a>
+	/// <a href="http://www.ibm.com/watson/developercloud/alchemy-data-news.html">AlchemyData News</a>
+	/// </summary>
+	public class AlchemyAPI : IWatsonService
     {
 
         #region Private Data
diff --git a/Scripts/Services/Conversation-Experimental/Conversation-Experimental.cs b/Scripts/Services/Conversation-Experimental/Conversation-Experimental.cs
@@ -27,8 +27,8 @@
 namespace IBM.Watson.DeveloperCloud.Services.ConversationExperimental.v1
 {
 	/// <summary>
-	/// This class wraps the Watson Conversation service. 
-	/// <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/conversation.html">Conversation Service</a>
+	/// This class wraps the Watson Experimental Conversation service. 
+	/// <a href="http://www.ibm.com/watson/developercloud/conversation.html">Experimental Conversation Service</a>
 	/// </summary>
 	public class ConversationExperimental : IWatsonService
 	{
diff --git a/Scripts/Services/Conversation/Conversation.cs b/Scripts/Services/Conversation/Conversation.cs
@@ -28,7 +28,7 @@ namespace IBM.Watson.DeveloperCloud.Services.Conversation.v1
 {
 	/// <summary>
 	/// This class wraps the Watson Conversation service. 
-	/// <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/conversation.html">Conversation Service</a>
+	/// <a href="http://www.ibm.com/watson/developercloud/conversation.html">Conversation Service</a>
 	/// </summary>
 	public class Conversation : IWatsonService
 	{
diff --git a/Scripts/Services/Dialog/Dialog.cs b/Scripts/Services/Dialog/Dialog.cs
@@ -28,11 +28,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.Dialog.v1
 {
-    /// <summary>
-    /// This class wraps the Watson Dialog service. 
-    /// <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/dialog.html">Dialog Service</a>
-    /// </summary>
-    public class Dialog : IWatsonService
+	/// <summary>
+	/// This class wraps the Watson Dialog service. 
+	/// <a href="http://www.ibm.com/watson/developercloud/dialog.html">Dialog Service</a>
+	/// </summary>
+	public class Dialog : IWatsonService
     {
         #region Public Types
         /// <summary>
diff --git a/Scripts/Services/DocumentConversion/DataModels.cs b/Scripts/Services/DocumentConversion/DataModels.cs
@@ -109,6 +109,9 @@ public class AnswerUnit
         public Content[] content { get; set; }
     }
 
+	/// <summary>
+	/// Document content.
+	/// </summary>
     [fsObject]
     public class Content
     {
diff --git a/Scripts/Services/DocumentConversion/DocumentConversion.cs b/Scripts/Services/DocumentConversion/DocumentConversion.cs
@@ -28,7 +28,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.DocumentConversion.v1
 {
-    public class DocumentConversion : IWatsonService
+	/// <summary>
+	/// This class wraps the Document Conversion service.
+	/// <a href="http://www.ibm.com/watson/developercloud/document-conversion.html">Document Conversion Service</a>
+	/// </summary>
+	public class DocumentConversion : IWatsonService
     {
         #region Private Data
         private const string SERVICE_ID = "DocumentConversionV1";
diff --git a/Scripts/Services/LanguageTranslator/LanguageTranslator.cs b/Scripts/Services/LanguageTranslator/LanguageTranslator.cs
@@ -27,11 +27,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.LanguageTranslator.v1
 {
-    /// <summary>
-    /// This class wraps the Language Translator service.
-    /// <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/language-translator.html">Language Translator Service</a>
-    /// </summary>
-    public class LanguageTranslator : IWatsonService
+	/// <summary>
+	/// This class wraps the Language Translator service.
+	/// <a href="http://www.ibm.com/watson/developercloud/language-translator.html">Language Translator Service</a>
+	/// </summary>
+	public class LanguageTranslator : IWatsonService
     {
         #region Public Types
         /// <summary>
diff --git a/Scripts/Services/NaturalLanguageClassifier/NaturalLanguageClassifier.cs b/Scripts/Services/NaturalLanguageClassifier/NaturalLanguageClassifier.cs
@@ -26,11 +26,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1
 {
-    /// <summary>
-    /// This class wraps the Natural Language Classifier service.
-	/// <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/nl-classifier.html">Natural Language Classifier Service</a>
-    /// </summary>
-    public class NaturalLanguageClassifier : IWatsonService
+	/// <summary>
+	/// This class wraps the Natural Language Classifier service.
+	/// <a href="http://www.ibm.com/watson/developercloud/nl-classifier.html">Natural Language Classifier Service</a>
+	/// </summary>
+	public class NaturalLanguageClassifier : IWatsonService
     {
         #region Public Types
         /// <summary>
diff --git a/Scripts/Services/PersonalityInsights/PersonalityInsights.cs b/Scripts/Services/PersonalityInsights/PersonalityInsights.cs
@@ -27,7 +27,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.PersonalityInsights.v2
 {
-    public class PersonalityInsights : IWatsonService 
+	/// <summary>
+	/// This class wraps the Personality Insights service.
+	/// <a href="http://www.ibm.com/watson/developercloud/personality-insights.html">Personality Insights Service</a>
+	/// </summary>
+	public class PersonalityInsights : IWatsonService 
     {
         #region Private Data
         private const string SERVICE_ID = "PersonalityInsightsV2";
diff --git a/Scripts/Services/RetrieveAndRank/RetrieveAndRank.cs b/Scripts/Services/RetrieveAndRank/RetrieveAndRank.cs
@@ -28,7 +28,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.RetrieveAndRank.v1
 {
-    public class RetrieveAndRank : IWatsonService
+	/// <summary>
+	/// This class wraps the Retrieve and Rank service.
+	/// <a href="http://www.ibm.com/watson/developercloud/retrieve-rank.html">Retrieve and Rank Service</a>
+	/// </summary>
+	public class RetrieveAndRank : IWatsonService
     {
         #region Private Data
         private const string SERVICE_ID = "RetrieveAndRankV1";
diff --git a/Scripts/Services/SpeechToText/SpeechToText.cs b/Scripts/Services/SpeechToText/SpeechToText.cs
@@ -30,11 +30,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.SpeechToText.v1
 {
-    /// <summary>
-    /// This class wraps the Watson SpeechToText service.
-    /// <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/speech-to-text.html">SpeechToText Service</a>
-    /// </summary>
-    public class SpeechToText : IWatsonService
+	/// <summary>
+	/// This class wraps the Watson Speech to Text service.
+	/// <a href="http://www.ibm.com/watson/developercloud/speech-to-text.html">Speech to Text Service</a>
+	/// </summary>
+	public class SpeechToText : IWatsonService
     {
         #region Constants
         /// <summary>
diff --git a/Scripts/Services/TextToSpeech/TextToSpeech.cs b/Scripts/Services/TextToSpeech/TextToSpeech.cs
@@ -27,11 +27,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.TextToSpeech.v1
 {
-    /// <summary>
-    /// This class wraps the TextToSpeech service.
-    /// <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/text-to-speech.html">TextToSpeech Service</a>
-    /// </summary>
-    public class TextToSpeech : IWatsonService
+	/// <summary>
+	/// This class wraps the Text to Speech service.
+	/// <a href="http://www.ibm.com/watson/developercloud/text-to-speech.html">Text to Speech Service</a>
+	/// </summary>
+	public class TextToSpeech : IWatsonService
     {
         #region Public Types
 
diff --git a/Scripts/Services/ToneAnalyzer/ToneAnalyzer.cs b/Scripts/Services/ToneAnalyzer/ToneAnalyzer.cs
@@ -27,7 +27,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.ToneAnalyzer.v3
 {
-    public class ToneAnalyzer : IWatsonService 
+	/// <summary>
+	/// This class wraps the Tone Analyzer service.
+	/// <a href="http://www.ibm.com/watson/developercloud/tone-analyzer.html">Tone Analyzer Service</a>
+	/// </summary>
+	public class ToneAnalyzer : IWatsonService 
     {
         #region Private Data
         private const string SERVICE_ID = "ToneAnalyzerV3";
diff --git a/Scripts/Services/TradeoffAnalytics/TradeoffAnalytics.cs b/Scripts/Services/TradeoffAnalytics/TradeoffAnalytics.cs
@@ -27,11 +27,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.TradeoffAnalytics.v1
 {
-    /// <summary>
-    /// This class wraps the TradeOff Analytics service.
-    /// <a href="https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/tradeoff-analytics/">TradeOff Analytics Service</a>
-    /// </summary>
-    public class TradeoffAnalytics : IWatsonService
+	/// <summary>
+	/// This class wraps the TradeOff Analytics service.
+	/// <a href="http://www.ibm.com/watson/developercloud/tradeoff-analytics.html">TradeOff Analytics Service</a>
+	/// </summary>
+	public class TradeoffAnalytics : IWatsonService
     {
 
         #region Private Data
diff --git a/Scripts/Services/VisualRecognition/VisualRecognition.cs b/Scripts/Services/VisualRecognition/VisualRecognition.cs
@@ -30,7 +30,11 @@
 
 namespace IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3
 {
-    public class VisualRecognition : IWatsonService
+	/// <summary>
+	/// This class wraps the Visual Recognition service.
+	/// <a href="http://www.ibm.com/watson/developercloud/visual-recognition.html">Visual Recognition Service</a>
+	/// </summary>
+	public class VisualRecognition : IWatsonService
     {
         #region Public Types
         /// <summary>

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public class WatsonCamera : MonoBehaviour`
`57`	`57`	`#region Public Variable`
`58`	`58`
`59`	`59`	`/// <summary>`
`60`		`- /// Instance of WatsonCamera.`
	`60`	`+ /// Static instance of WatsonCamera.`
`61`	`61`	`/// </summary>`
`62`	`62`	`public static WatsonCamera Instance`
`63`	`63`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,8 @@`
`27`	`27`	`namespace IBM.Watson.DeveloperCloud.Services.ConversationExperimental.v1`
`28`	`28`	`{`
`29`	`29`	`/// <summary>`
`30`		`- /// This class wraps the Watson Conversation service.`
`31`		`- /// <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/conversation.html">Conversation Service</a>`
	`30`	`+ /// This class wraps the Watson Experimental Conversation service.`
	`31`	`+ /// <a href="http://www.ibm.com/watson/developercloud/conversation.html">Experimental Conversation Service</a>`
`32`	`32`	`/// </summary>`
`33`	`33`	`public class ConversationExperimental : IWatsonService`
`34`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ namespace IBM.Watson.DeveloperCloud.Services.Conversation.v1`
`28`	`28`	`{`
`29`	`29`	`/// <summary>`
`30`	`30`	`/// This class wraps the Watson Conversation service.`
`31`		`- /// <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/conversation.html">Conversation Service</a>`
	`31`	`+ /// <a href="http://www.ibm.com/watson/developercloud/conversation.html">Conversation Service</a>`
`32`	`32`	`/// </summary>`
`33`	`33`	`public class Conversation : IWatsonService`
`34`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,9 @@ public class AnswerUnit`
`109`	`109`	`public Content[] content { get; set; }`
`110`	`110`	`}`
`111`	`111`
	`112`	`+ /// <summary>`
	`113`	`+ /// Document content.`
	`114`	`+ /// </summary>`
`112`	`115`	`[fsObject]`
`113`	`116`	`public class Content`
`114`	`117`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,11 @@`
`28`	`28`
`29`	`29`	`namespace IBM.Watson.DeveloperCloud.Services.DocumentConversion.v1`
`30`	`30`	`{`
`31`		`- public class DocumentConversion : IWatsonService`
	`31`	`+ /// <summary>`
	`32`	`+ /// This class wraps the Document Conversion service.`
	`33`	`+ /// <a href="http://www.ibm.com/watson/developercloud/document-conversion.html">Document Conversion Service</a>`
	`34`	`+ /// </summary>`
	`35`	`+ public class DocumentConversion : IWatsonService`
`32`	`36`	`{`
`33`	`37`	`#region Private Data`
`34`	`38`	`private const string SERVICE_ID = "DocumentConversionV1";`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,11 @@`
`27`	`27`
`28`	`28`	`namespace IBM.Watson.DeveloperCloud.Services.PersonalityInsights.v2`
`29`	`29`	`{`
`30`		`- public class PersonalityInsights : IWatsonService`
	`30`	`+ /// <summary>`
	`31`	`+ /// This class wraps the Personality Insights service.`
	`32`	`+ /// <a href="http://www.ibm.com/watson/developercloud/personality-insights.html">Personality Insights Service</a>`
	`33`	`+ /// </summary>`
	`34`	`+ public class PersonalityInsights : IWatsonService`
`31`	`35`	`{`
`32`	`36`	`#region Private Data`
`33`	`37`	`private const string SERVICE_ID = "PersonalityInsightsV2";`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,11 @@`
`30`	`30`
`31`	`31`	`namespace IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3`
`32`	`32`	`{`
`33`		`- public class VisualRecognition : IWatsonService`
	`33`	`+ /// <summary>`
	`34`	`+ /// This class wraps the Visual Recognition service.`
	`35`	`+ /// <a href="http://www.ibm.com/watson/developercloud/visual-recognition.html">Visual Recognition Service</a>`
	`36`	`+ /// </summary>`
	`37`	`+ public class VisualRecognition : IWatsonService`
`34`	`38`	`{`
`35`	`39`	`#region Public Types`
`36`	`40`	`/// <summary>`