Skip to content

Feature 18 documentation update #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jul 17, 2016
Merged

Feature 18 documentation update #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ef2309b
setup sandcastle
mediumTaj Jul 15, 2016
577c075
merge in develop
mediumTaj Jul 15, 2016
df8f914
added documentation builder solution as a workaround to build documen…
mediumTaj Jul 16, 2016
95513ae
removed documentationBuilder after moving to local, updated credentials
mediumTaj Jul 16, 2016
d709148
updating documentation in camera namespace
mediumTaj Jul 17, 2016
8c42508
namespace documentation, updates to service class documentation
mediumTaj Jul 17, 2016
7841eff
merge in develop
mediumTaj Jul 17, 2016
3b1f1dc
orig cleanup
mediumTaj Jul 17, 2016
8d50f3a
documentation, removed root dataModel class from personaliy insights
mediumTaj Jul 17, 2016
e191d5f
more documentation
mediumTaj Jul 17, 2016
ed35351
documentation
mediumTaj Jul 17, 2016
632b080
compiled help file
mediumTaj Jul 17, 2016
f54b763
fixes #18 - encrypted config... updated all documentation
mediumTaj Jul 17, 2016
cf66d37
updated changelog and useragent to 0.6.1
mediumTaj Jul 17, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
Change Log
==========
## Version 0.6.1
_2016-07-17_

* Fix: Updated documentation

## Version 0.6.0

_2016-07-15_
Expand Down
Binary file modified Config.json.enc
View file
Open in desktop
Binary file not shown.
97 changes: 41 additions & 56 deletions Docs/UnitySDK.shfbproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<Name>Documentation</Name>
<!-- SHFB properties -->
<FrameworkVersion>.NET Framework 3.5</FrameworkVersion>
<OutputPath>..\Assets\Watson\Editor\Help\</OutputPath>
<OutputPath>..\Scripts\Editor\Help\</OutputPath>
<HtmlHelpName>WatsonUnitySDK</HtmlHelpName>
<Language>en-US</Language>
<ComponentPath>
Expand All @@ -25,7 +25,7 @@
<KeepLogFile>False</KeepLogFile>
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
<CleanIntermediates>True</CleanIntermediates>
<HelpFileVersion>1.0.0.0</HelpFileVersion>
<HelpFileVersion>1.1.0.0</HelpFileVersion>
<MaximumGroupParts>2</MaximumGroupParts>
<NamespaceGrouping>False</NamespaceGrouping>
<SyntaxFilters>C#</SyntaxFilters>
Expand All @@ -37,8 +37,8 @@
<HelpTitle>Watson Unity SDK</HelpTitle>
<ContentPlacement>AboveNamespaces</ContentPlacement>
<DocumentationSources>
<DocumentationSource sourceFile="..\Temp\UnityVS_bin\Debug\Assembly-CSharp.dll" />
<DocumentationSource sourceFile="..\Temp\UnityVS_bin\Debug\Assembly-CSharp.xml" />
<DocumentationSource sourceFile="..\..\..\Temp\UnityVS_bin\Debug\Assembly-CSharp.dll" />
<DocumentationSource sourceFile="..\..\..\Temp\UnityVS_bin\Debug\Assembly-CSharp.xml" />
</DocumentationSources>
<NamespaceSummaries>
<NamespaceSummaryItem name="DentedPixel.LTEditor" isDocumented="False" />
Expand Down Expand Up @@ -72,18 +72,28 @@
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.v1" isDocumented="True">Version 1.0 of all services.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Utilities" isDocumented="True">Various utility classes.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Widgets" isDocumented="True">Widget classes.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services" isDocumented="True">Watson service classes.</NamespaceSummaryItem></NamespaceSummaries>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services" isDocumented="True">Watson service classes.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.AlchemyAPI.v1" isDocumented="True">Alchemy API version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.Conversation.v1" isDocumented="True">Conversation version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.ConversationExperimental.v1" isDocumented="True">Experimental Conversation service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.DeepQA.v1" isDocumented="True">Deep QA version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.Dialog.v1" isDocumented="True">Dialog version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.DocumentConversion.v1" isDocumented="True">Document Conversiont version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.LanguageTranslator.v1" isDocumented="True">Language Translator version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1" isDocumented="True">Natural Language Classifier version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.PersonalityInsights.v2" isDocumented="True">Personality Insightst version 2 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.RetrieveAndRank.v1" isDocumented="True">Retrieve and Rankt version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.SpeechToText.v1" isDocumented="True">Speech to Text version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.TextToSpeech.v1" isDocumented="True">Text to Speech version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.ToneAnalyzer.v3" isDocumented="True">Tone Analyzer version 3 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.TradeoffAnalytics.v1" isDocumented="True">Tradeoff Analytics version 1 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3" isDocumented="True">Visual Recognitionr version 3 service abstraction.</NamespaceSummaryItem>
<NamespaceSummaryItem name="IBM.Watson.DeveloperCloud.Services.LanguageTranslation.v1" isDocumented="True">Language Translation version 1 service abstraction.</NamespaceSummaryItem></NamespaceSummaries>
<ApiFilter>
<Filter entryType="Namespace" fullName="" isExposed="False" />
<Filter entryType="Namespace" fullName="FullSerializer" isExposed="False" />
<Filter entryType="Namespace" fullName="FullSerializer.Internal" isExposed="False" />
<Filter entryType="Namespace" fullName="FullSerializer.Internal.DirectConverters" isExposed="False" />
<Filter entryType="Namespace" fullName="FullSerializer.Speedup" isExposed="False" />
<Filter entryType="Namespace" fullName="IBM.Watson.DeveloperCloud.DataModels" isExposed="True">
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.DataModels.SpeechResultList" filterName="SpeechResultList" isExposed="True">
<Filter entryType="Constructor" fullName="IBM.Watson.DeveloperCloud.DataModels.SpeechResultList.#ctor" filterName=".ctor" isExposed="False" />
</Filter>
</Filter>
<Filter entryType="Namespace" fullName="IBM.Watson.DeveloperCloud.DataTypes" isExposed="True">
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.DataTypes.AudioData" filterName="AudioData" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.DataTypes.AudioData.Finalize" filterName="Finalize" isExposed="False" />
Expand All @@ -96,32 +106,9 @@
</Filter>
</Filter>
<Filter entryType="Namespace" fullName="IBM.Watson.DeveloperCloud.Editor" isExposed="False" />
<Filter entryType="Namespace" fullName="IBM.Watson.DeveloperCloud.Services.v1" isExposed="True">
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Services.v1.Dialog" filterName="Dialog" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.Dialog.GetServiceID" filterName="GetServiceID" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.Dialog.GetServiceStatus" filterName="GetServiceStatus" isExposed="False" />
</Filter>
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Services.v1.LanguageClassifier" filterName="LanguageClassifier" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.LanguageClassifier.GetServiceID" filterName="GetServiceID" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.LanguageClassifier.GetServiceStatus" filterName="GetServiceStatus" isExposed="False" />
</Filter>
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Services.v1.SpeechToText" filterName="SpeechToText" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.SpeechToText.GetServiceID" filterName="GetServiceID" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.SpeechToText.GetServiceStatus" filterName="GetServiceStatus" isExposed="False" />
</Filter>
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Services.v1.TextToSpeech" filterName="TextToSpeech" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.TextToSpeech.GetServiceID" filterName="GetServiceID" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.TextToSpeech.GetServiceStatus" filterName="GetServiceStatus" isExposed="False" />
</Filter>
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Services.v1.Translate" filterName="Translate" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.Translate.GetServiceID" filterName="GetServiceID" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Services.v1.Translate.GetServiceStatus" filterName="GetServiceStatus" isExposed="False" />
</Filter>
</Filter>
<Filter entryType="Namespace" fullName="IBM.Watson.DeveloperCloud.UnitTests" isExposed="False" />
<Filter entryType="Namespace" fullName="IBM.Watson.DeveloperCloud.Utilities" isExposed="True">
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Utilities.Constants.String" filterName="Constants.String" isExposed="True">
<Filter entryType="Field" fullName="IBM.Watson.DeveloperCloud.Utilities.Constants.String.DEBUG_DISPLAY_AVATAR_MOOD" filterName="DEBUG_DISPLAY_AVATAR_MOOD" isExposed="False" />
<Filter entryType="Field" fullName="IBM.Watson.DeveloperCloud.Utilities.Constants.String.DEBUG_DISPLAY_QUALITY" filterName="DEBUG_DISPLAY_QUALITY" isExposed="False" />
</Filter>
</Filter>
Expand All @@ -148,10 +135,6 @@
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.MicrophoneWidget.GetName" filterName="GetName" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.MicrophoneWidget.Start" filterName="Start" isExposed="False" />
</Filter>
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Widgets.NlcWidget" filterName="NlcWidget" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.NlcWidget.GetName" filterName="GetName" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.NlcWidget.Start" filterName="Start" isExposed="False" />
</Filter>
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Widgets.SpeechDisplayWidget" filterName="SpeechDisplayWidget" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.SpeechDisplayWidget.GetName" filterName="GetName" isExposed="False" />
</Filter>
Expand All @@ -166,11 +149,6 @@
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Widgets.TouchWidget" filterName="TouchWidget" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.TouchWidget.GetName" filterName="GetName" isExposed="False" />
</Filter>
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Widgets.TranslateWidget" filterName="TranslateWidget" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.TranslateWidget.Awake" filterName="Awake" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.TranslateWidget.GetName" filterName="GetName" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.TranslateWidget.Start" filterName="Start" isExposed="False" />
</Filter>
<Filter entryType="Class" fullName="IBM.Watson.DeveloperCloud.Widgets.Widget" filterName="Widget" isExposed="True">
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.Widget.Awake" filterName="Awake" isExposed="False" />
<Filter entryType="Method" fullName="IBM.Watson.DeveloperCloud.Widgets.Widget.Start" filterName="Start" isExposed="False" />
Expand All @@ -183,26 +161,33 @@
</Filter>
</Filter>
<Filter entryType="Namespace" fullName="MiniJSON" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples.CameraControl" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples.Checkers" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples.Colors" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples.Input" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples.Multiuser" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples.Photos" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples.Portal" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples.Tap" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Examples.UI" isExposed="False" />
<Filter entryType="Namespace" fullName="UnityStandardAssets.ImageEffects" isExposed="False" />
<Filter entryType="Namespace" fullName="UnityStandardAssets.Utility" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Behaviors" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Behaviors.Visualizer" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Clusters" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Devices.Display" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Gestures" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Gestures.Base" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Gestures.Clustered" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Gestures.UI" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Hit" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.InputSources" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.InputSources.InputHandlers" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Layers" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Utils" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Utils.Attributes" isExposed="False" />
<Filter entryType="Namespace" fullName="TouchScript.Utils.Geom" isExposed="False" />
<Filter entryType="Namespace" fullName="WebSocketSharp" isExposed="False" />
<Filter entryType="Namespace" fullName="WebSocketSharp.Net" isExposed="False" />
<Filter entryType="Namespace" fullName="WebSocketSharp.Net.WebSockets" isExposed="False" />
<Filter entryType="Namespace" fullName="WebSocketSharp.Server" isExposed="False" />
</ApiFilter>
<VisibleItems>Protected, ProtectedInternalAsProtected</VisibleItems>
<VisibleItems>ProtectedInternalAsProtected</VisibleItems>
<RootNamespaceTitle>IBM.Watson</RootNamespaceTitle>
<MissingTags>Summary, Parameter, Returns, AutoDocumentCtors, Namespace, TypeParameter, AutoDocumentDispose</MissingTags>
<HtmlHelp1xCompilerPath>
</HtmlHelp1xCompilerPath>
<SaveComponentCacheCapacity>100</SaveComponentCacheCapacity>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
the build. The others are optional common platform types that may appear. -->
Expand Down
8 changes: 4 additions & 4 deletions Examples/ServiceExamples/Scripts/ExamplePersonalityInsights.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ void Start ()
LogSystem.InstallDefaultReactors();
string dataPath = Application.dataPath + "/Watson/Examples/ServiceExamples/TestData/personalityInsights.json";

if(!m_personalityInsights.GetProfile(OnGetProfile, dataPath, DataModels.ContentType.TEXT_PLAIN, DataModels.Language.ENGLISH))
if(!m_personalityInsights.GetProfile(OnGetProfile, dataPath, ContentType.TEXT_PLAIN, Language.ENGLISH))
Log.Debug("ExamplePersonalityInsights", "Failed to get profile!");
}

private void OnGetProfile(DataModels.Profile profile, string data)
private void OnGetProfile(Profile profile, string data)
{
Log.Debug("ExamplePersonalityInsights", "data: {0}", data);
if(profile != null)
Expand All @@ -60,7 +60,7 @@ private void OnGetProfile(DataModels.Profile profile, string data)
}
}

private void LogTraitTree(DataModels.TraitTreeNode traitTreeNode)
private void LogTraitTree(TraitTreeNode traitTreeNode)
{
if(!string.IsNullOrEmpty(traitTreeNode.id))
Log.Debug("ExamplePersonalityInsights", "id: {0}", traitTreeNode.id);
Expand All @@ -77,7 +77,7 @@ private void LogTraitTree(DataModels.TraitTreeNode traitTreeNode)
if(!string.IsNullOrEmpty(traitTreeNode.raw_sampling_error))
Log.Debug("ExamplePersonalityInsights", "raw_sampling_error: {0}", traitTreeNode.raw_sampling_error);
if(traitTreeNode.children != null && traitTreeNode.children.Length > 0)
foreach(DataModels.TraitTreeNode childNode in traitTreeNode.children)
foreach(TraitTreeNode childNode in traitTreeNode.children)
LogTraitTree(childNode);
}
}
4 changes: 4 additions & 0 deletions Scripts/Camera/CameraTarget.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,10 @@ void Update()

#region public Functions

/// <summary>
/// Sets the target position with offset.
/// </summary>
/// <param name="offsetPosition"></param>
public void SetTargetPositionWithOffset(Vector3 offsetPosition)
{
m_OffsetPosition = offsetPosition;
Expand Down
9 changes: 9 additions & 0 deletions Scripts/Camera/WatsonCamera.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ public class WatsonCamera : MonoBehaviour

#region Public Variable

/// <summary>
/// Static instance of WatsonCamera.
/// </summary>
public static WatsonCamera Instance
{
get
Expand All @@ -64,6 +67,9 @@ public static WatsonCamera Instance
}
}

/// <summary>
/// The camera's current target.
/// </summary>
public CameraTarget CurrentCameraTarget
{
get
Expand Down Expand Up @@ -106,6 +112,9 @@ public CameraTarget CurrentCameraTarget
}
}

/// <summary>
/// The camera's default target.
/// </summary>
public CameraTarget DefaultCameraTarget
{
get
Expand Down
Binary file modified Scripts/Editor/Help/WatsonUnitySDK.chm
100644 → 100755
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion Scripts/Editor/Help/WatsonUnitySDK.chm.meta
100644 → 100755
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading