Merge pull request #25 from BastianBlokland/feature/example-comments

Feature/example comments
BastianBlokland · Apr 22, 2019 · b0b5421 · b0b5421
2 parents 419e97b + 3523a86
commit b0b5421
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/example/Example.csproj b/example/Example.csproj
@@ -24,7 +24,7 @@
     <None Update="brain.tree.json" CopyToOutputDirectory="PreserveNewest" />
 
     <!-- Tools -->
-    <DotNetCliToolReference Include="TypedTree.Generator.Cli" Version="*" />
+    <DotNetCliToolReference Include="TypedTree.Generator.Cli" Version="1.1.*" />
 
   </ItemGroup>
 

diff --git a/example/brain.treescheme.json b/example/brain.treescheme.json
@@ -32,6 +32,7 @@
   "nodes": [
     {
       "nodeType": "Example.Ai.Inverter",
+      "comment": "Invert the result of the child.\n",
       "fields": [
         {
           "name": "child",
@@ -41,10 +42,12 @@
     },
     {
       "nodeType": "Example.Ai.MatchAnyNumber",
+      "comment": "Returns successfull if the user typed any number.\n",
       "fields": []
     },
     {
       "nodeType": "Example.Ai.MatchNumber",
+      "comment": "Returns successful if the user typed a specific number.\n",
       "fields": [
         {
           "name": "number",
@@ -54,6 +57,7 @@
     },
     {
       "nodeType": "Example.Ai.MatchString",
+      "comment": "Returns successful if the user typed a specific string.\n",
       "fields": [
         {
           "name": "text",
@@ -67,6 +71,7 @@
     },
     {
       "nodeType": "Example.Ai.Say",
+      "comment": "Print given text to the console.\nWill wait for given time before continuing.\n",
       "fields": [
         {
           "name": "text",
@@ -80,6 +85,7 @@
     },
     {
       "nodeType": "Example.Ai.Selector",
+      "comment": "Executes child nodes, will stop at the first child that returns successful.\n",
       "fields": [
         {
           "name": "children",
@@ -90,6 +96,7 @@
     },
     {
       "nodeType": "Example.Ai.Sequence",
+      "comment": "Executes child nodes, will stop at the first child that returns failure.\n",
       "fields": [
         {
           "name": "children",
@@ -99,4 +106,4 @@
       ]
     }
   ]
-}
+}
diff --git a/src/TypedTree.Generator.Cli/readme.md b/src/TypedTree.Generator.Cli/readme.md
@@ -6,7 +6,7 @@ Can be used to generate scheme files for the [**TypedTree-Editor**](https://bast
 
 Add a reference to the cli-tool to a `ItemGroup` section your of your csproj.
 ```xml
-<DotNetCliToolReference Include="TypedTree.Generator.Cli" Version="1.0.*" />
+<DotNetCliToolReference Include="TypedTree.Generator.Cli" Version="1.1.*" />
 ```
 
 ## Usage

diff --git a/src/TypedTree.Generator.Core/readme.md b/src/TypedTree.Generator.Core/readme.md
@@ -11,11 +11,11 @@ Can be used for more complex integration into a build pipeline, for simple use-c
 There are two ways to add the nuget package:
 1. Run:
 ```bash
-dotnet add package TypedTree.Generator.Core --version 1.0.*
+dotnet add package TypedTree.Generator.Core --version 1.1.*
 ```
 2. Add the following to a `ItemGroup` section of your csproj:
 ```xml
-<PackageReference Include="TypedTree.Generator.Core" Version="1.0.*" />
+<PackageReference Include="TypedTree.Generator.Core" Version="1.1.*" />
 ```
 
 ## Usage