more javadoc for class models

fujaba · Apr 7, 2018 · 3bacfc5 · 3bacfc5
1 parent 44cdb42
commit 3bacfc5
Show file tree

Hide file tree

Showing 22 changed files with 274 additions and 126 deletions.
diff --git a/doc/GroupAccountCodegen.html b/doc/GroupAccountCodegen.html
@@ -21,96 +21,9 @@
 </style>
 </head>
 <body>
-<p>Storyboard <a href='.././src/test/java/org/sdmlib/test/examples/groupaccount/GroupAccountClassModel.java' type='text/x-java'>GroupAccountCodegen</a></p>
+<p>Storyboard <a href='./src/test/java/org/sdmlib/test/examples/groupaccount/GroupAccountClassModel.java' type='text/x-java'>GroupAccountCodegen</a></p>
 <p>Start situation: Nothing here yet. Generate classes</p>
-<script>
-   var json = {
-   "typ":"class",
-   "nodes":[
-      {
-         "typ":"node",
-         "id":"Item",
-         "attributes":[
-            "description : String",
-            "price : double"
-         ]
-      },
-      {
-         "typ":"node",
-         "id":"Party",
-         "attributes":[
-            "partyName : String",
-            "share : double",
-            "total : double"
-         ]
-      },
-      {
-         "typ":"node",
-         "id":"Person",
-         "attributes":[
-            "name : String",
-            "saldo : double",
-            "total : double"
-         ]
-      }
-   ],
-   "edges":[
-      {
-         "typ":"assoc",
-         "source":{
-            "id":"Item",
-            "cardinality":"many",
-            "property":"items"
-         },
-         "target":{
-            "id":"Person",
-            "cardinality":"one",
-            "property":"person"
-         }
-      },
-      {
-         "typ":"assoc",
-         "source":{
-            "id":"Party",
-            "cardinality":"one",
-            "property":"party"
-         },
-         "target":{
-            "id":"Person",
-            "cardinality":"many",
-            "property":"guests"
-         }
-      },
-      {
-         "typ":"assoc",
-         "source":{
-            "id":"Person",
-            "cardinality":"many",
-            "property":"guests"
-         },
-         "target":{
-            "id":"Party",
-            "cardinality":"one",
-            "property":"party"
-         }
-      },
-      {
-         "typ":"assoc",
-         "source":{
-            "id":"Person",
-            "cardinality":"one",
-            "property":"person"
-         },
-         "target":{
-            "id":"Item",
-            "cardinality":"many",
-            "property":"items"
-         }
-      }
-   ]
-}   ;
-   new Graph(json, {"canvasid":"canvasGroupAccountCodegenClassDiagram1", "display":"html", fontsize:10, bar:false, propertyinfo:false}).layout(100,100);
-</script>
+<img src="doc-files/GroupAccountCodegenStep0.png"></img>
 
 </body>
 </html>
diff --git a/doc/_GroupAccountCodegenStep0.html b/doc/_GroupAccountCodegenStep0.html
@@ -0,0 +1,115 @@
+<!DOCTYPE html>
+<html>
+<head><meta charset="utf-8">
+<link rel="stylesheet" type="text/css" href="style.css">
+<link href="includes/diagramstyle.css" rel="stylesheet" type="text/css">
+
+<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.2.1/Chart.bundle.js"></script>
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
+<script src="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
+<script src="includes/dagre.min.js"></script>
+<script src="includes/drawer.js"></script>
+<script src="includes/graph.js"></script>
+<script src="includes/Chart.bundle.js"></script>
+<style>
+    canvas{
+        -moz-user-select: none;
+        -webkit-user-select: none;
+        -ms-user-select: none;
+    }
+</style>
+</head>
+<body>
+<!-- 400, 350 -->
+<script>
+   var json = {
+   "typ":"class",
+   "nodes":[
+      {
+         "typ":"node",
+         "id":"Item",
+         "attributes":[
+            "description : String",
+            "price : double"
+         ]
+      },
+      {
+         "typ":"node",
+         "id":"Party",
+         "attributes":[
+            "partyName : String",
+            "share : double",
+            "total : double"
+         ]
+      },
+      {
+         "typ":"node",
+         "id":"Person",
+         "attributes":[
+            "name : String",
+            "saldo : double",
+            "total : double"
+         ]
+      }
+   ],
+   "edges":[
+      {
+         "typ":"assoc",
+         "source":{
+            "id":"Item",
+            "cardinality":"many",
+            "property":"items"
+         },
+         "target":{
+            "id":"Person",
+            "cardinality":"one",
+            "property":"person"
+         }
+      },
+      {
+         "typ":"assoc",
+         "source":{
+            "id":"Party",
+            "cardinality":"one",
+            "property":"party"
+         },
+         "target":{
+            "id":"Person",
+            "cardinality":"many",
+            "property":"guests"
+         }
+      },
+      {
+         "typ":"assoc",
+         "source":{
+            "id":"Person",
+            "cardinality":"many",
+            "property":"guests"
+         },
+         "target":{
+            "id":"Party",
+            "cardinality":"one",
+            "property":"party"
+         }
+      },
+      {
+         "typ":"assoc",
+         "source":{
+            "id":"Person",
+            "cardinality":"one",
+            "property":"person"
+         },
+         "target":{
+            "id":"Item",
+            "cardinality":"many",
+            "property":"items"
+         }
+      }
+   ]
+}   ;
+   new Graph(json, {"canvasid":"canvasGroupAccountCodegenClassDiagram1", "display":"html", fontsize:10, bar:false, propertyinfo:false}).layout(100,100);
+</script>
+
+</body>
+</html>
diff --git a/doc/internal/JavaDocStoriesMikadoPlan.html b/doc/internal/JavaDocStoriesMikadoPlan.html
@@ -22,7 +22,11 @@
 </head>
 <body>
 <p>Storyboard <a href='.././src/test/java/org/sdmlib/test/doc/TestJavaDocStories.java' type='text/x-java'>JavaDocStoriesMikadoPlan</a></p>
-<p>Hello Story</p><img src="doc-files/JavaDocStoriesMikadoPlanStep0.png"></img><p>Start: open goals</p>
-<p>Hello Story</p><img src="doc-files/JavaDocStoriesMikadoPlanStep1.png"></img><p><a name = 'step_1'>Step 1: closed goals</a></p><p>Hello Story</p><img src="doc-files/JavaDocStoriesMikadoPlanStep2.png"></img>
+<img src="doc-files/JavaDocStoriesMikadoPlanStep0.png"></img>
+<p>Start: open goals</p>
+<img src="doc-files/JavaDocStoriesMikadoPlanStep1.png"></img>
+<p><a name = 'step_1'>Step 1: closed goals</a></p>
+<img src="doc-files/JavaDocStoriesMikadoPlanStep2.png"></img>
+
 </body>
 </html>
diff --git a/doc/internal/_GenJavaDocStoryStep0.html b/doc/internal/_GenJavaDocStoryStep0.html
@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head><meta charset="utf-8">
+<link rel="stylesheet" type="text/css" href="style.css">
+<link href="includes/diagramstyle.css" rel="stylesheet" type="text/css">
+
+<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.2.1/Chart.bundle.js"></script>
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
+<script src="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
+<script src="includes/dagre.min.js"></script>
+<script src="includes/drawer.js"></script>
+<script src="includes/graph.js"></script>
+<script src="includes/Chart.bundle.js"></script>
+<style>
+    canvas{
+        -moz-user-select: none;
+        -webkit-user-select: none;
+        -ms-user-select: none;
+    }
+</style>
+</head>
+<body>
+<script>
+   var json = {
+   "type":"objectdiagram",
+   "nodes":[
+      {
+         "type":"clazz",
+         "id":"R2 : Room",
+         "attributes":[
+            "credits=42",
+            "name=Math",
+            "topic=null"
+         ]
+      },
+      {
+         "type":"clazz",
+         "id":"U1 : University",
+         "attributes":[
+            "name=null",
+            "president=null"
+         ]
+      }
+   ],
+   "edges":[
+      {
+         "type":"assoc",
+         "source":{
+            "cardinality":"many",
+            "property":"rooms",
+            "id":"R2 : Room"
+         },
+         "target":{
+            "cardinality":"one",
+            "property":"university",
+            "id":"U1 : University"
+         }
+      }
+   ]
+}   ;
+   json["options"]={"canvasid":"canvasGenJavaDocStory4", "display":"svg", "fontsize":10,"bar":true};   var g = new Graph(json);
+   g.layout(100,100);
+</script>
+
+</body>
+</html>
diff --git a/doc/internal/_JavaDocStoriesMikadoPlanStep0.html b/doc/internal/_JavaDocStoriesMikadoPlanStep0.html
@@ -21,8 +21,8 @@
 </style>
 </head>
 <body>
-<h1>look</h1>
-<canvas id="myChart" width="1000" height="600"></canvas>
+<!-- 900, 650 -->
+<canvas id="myChart" width="880" height="550"></canvas>
 <script>
 var ctx = document.getElementById("myChart").getContext('2d');var myLineChart = new Chart(ctx, {
     type: 'line',
@@ -42,6 +42,7 @@ <h1>look</h1>
         ]
     },
     options: {
+        animation: false,
         responsive: false,
         scales: {
             xAxes: [{

diff --git a/doc/internal/_JavaDocStoriesMikadoPlanStep1.html b/doc/internal/_JavaDocStoriesMikadoPlanStep1.html
@@ -21,6 +21,7 @@
 </style>
 </head>
 <body>
+<!-- 900, 450 -->
 <script>
    var json = {
    "type":"objectdiagram",

diff --git a/doc/internal/_JavaDocStoriesMikadoPlanStep2.html b/doc/internal/_JavaDocStoriesMikadoPlanStep2.html
@@ -21,6 +21,7 @@
 </style>
 </head>
 <body>
+<!-- 950, 600 -->
 <script>
    var json = {
    "type":"objectdiagram",

diff --git a/src/main/java/org/sdmlib/models/Yamler.java b/src/main/java/org/sdmlib/models/Yamler.java
@@ -5,7 +5,8 @@
 
 /**
  *
- * <p>Yamler reads simple key value pairs in YAML syntax.</p>
+ * <p>Storyboard <a href='.././src/test/java/org/sdmlib/test/doc/TestJavaDocStories.java' type='text/x-java'>GenJavaDocStory</a></p>
+    * <p>Yamler reads simple key value pairs in YAML syntax.</p>
     * <p>Example:</p>
     * <pre>            String yaml = &quot;&quot; +
     *               &quot;msgType: newPlayer\n&quot; +
@@ -30,6 +31,7 @@ public class Yamler
 
    /**
     *
+    * <p>Storyboard <a href='.././src/test/java/org/sdmlib/test/doc/TestJavaDocStories.java' type='text/x-java'>GenJavaDocStory</a></p>
     * <p>Yamler reads simple key value pairs in YAML syntax.</p>
     * <p>Example:</p>
     * <pre>            String yaml = &quot;&quot; +
@@ -56,6 +58,7 @@ public Yamler(String yaml)
 
    /**
     *
+    * <p>Storyboard <a href='.././src/test/java/org/sdmlib/test/doc/TestJavaDocStories.java' type='text/x-java'>GenJavaDocStory</a></p>
     * <p>Yamler reads simple key value pairs in YAML syntax.</p>
     * <p>Example:</p>
     * <pre>            String yaml = &quot;&quot; +
@@ -75,6 +78,7 @@ public Yamler()
    }
 
    /**
+    * <p>Storyboard <a href='./src/test/java/org/sdmlib/test/doc/TestJavaDocStories.java' type='text/x-java'>GenJavaDocStory</a></p>
     * <p>Yamler reads simple key value pairs in YAML syntax.</p>
     * <p>Example:</p>
     * <pre>            String yaml = &quot;&quot; +