Skip to content

Commit

Permalink
1175 improve ge documentation (#1654)
Browse files Browse the repository at this point in the history
Added tutorial to user guide. Refined documentation. Closes #1175.
  • Loading branch information
RyanMcilnay authored and philip-alldredge committed Nov 28, 2018
1 parent a0140be commit d4b92e1
Show file tree
Hide file tree
Showing 93 changed files with 3,082 additions and 1,300 deletions.
4 changes: 4 additions & 0 deletions ge/org.osate.ge.doc/api/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,18 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/osate/ge/di/Delete.html" title="annotation in org.osate.ge.di" target="classFrame">Delete</a></li>
<li><a href="org/osate/ge/DiagramExporter.html" title="class in org.osate.ge" target="classFrame">DiagramExporter</a></li>
<li><a href="org/osate/ge/DiagramType.html" title="interface in org.osate.ge" target="classFrame"><span class="interfaceName">DiagramType</span></a></li>
<li><a href="org/osate/ge/graphics/Dimension.html" title="class in org.osate.ge.graphics" target="classFrame">Dimension</a></li>
<li><a href="org/osate/ge/DockingPosition.html" title="enum in org.osate.ge" target="classFrame">DockingPosition</a></li>
<li><a href="org/osate/ge/graphics/EllipseBuilder.html" title="class in org.osate.ge.graphics" target="classFrame">EllipseBuilder</a></li>
<li><a href="org/osate/ge/EmfContainerProvider.html" title="interface in org.osate.ge" target="classFrame"><span class="interfaceName">EmfContainerProvider</span></a></li>
<li><a href="org/osate/ge/query/FilterArguments.html" title="interface in org.osate.ge.query" target="classFrame"><span class="interfaceName">FilterArguments</span></a></li>
<li><a href="org/osate/ge/FundamentalContentFilter.html" title="interface in org.osate.ge" target="classFrame"><span class="interfaceName">FundamentalContentFilter</span></a></li>
<li><a href="org/osate/ge/di/GetBusinessObjectToModify.html" title="annotation in org.osate.ge.di" target="classFrame">GetBusinessObjectToModify</a></li>
<li><a href="org/osate/ge/di/GetCreateOwner.html" title="annotation in org.osate.ge.di" target="classFrame">GetCreateOwner</a></li>
<li><a href="org/osate/ge/di/GetGraphicalConfiguration.html" title="annotation in org.osate.ge.di" target="classFrame">GetGraphicalConfiguration</a></li>
<li><a href="org/osate/ge/di/GetName.html" title="annotation in org.osate.ge.di" target="classFrame">GetName</a></li>
<li><a href="org/osate/ge/di/GetNameForEditing.html" title="annotation in org.osate.ge.di" target="classFrame">GetNameForEditing</a></li>
<li><a href="org/osate/ge/di/GetNameForUserInterface.html" title="annotation in org.osate.ge.di" target="classFrame">GetNameForUserInterface</a></li>
<li><a href="org/osate/ge/di/GetPaletteEntries.html" title="annotation in org.osate.ge.di" target="classFrame">GetPaletteEntries</a></li>
<li><a href="org/osate/ge/graphics/Graphic.html" title="interface in org.osate.ge.graphics" target="classFrame"><span class="interfaceName">Graphic</span></a></li>
<li><a href="org/osate/ge/GraphicalAnnexUtil.html" title="class in org.osate.ge" target="classFrame">GraphicalAnnexUtil</a></li>
Expand All @@ -49,6 +52,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/osate/ge/services/GraphicalEditorService.html" title="interface in org.osate.ge.services" target="classFrame"><span class="interfaceName">GraphicalEditorService</span></a></li>
<li><a href="org/osate/ge/GraphicalExtensionUtil.html" title="class in org.osate.ge" target="classFrame">GraphicalExtensionUtil</a></li>
<li><a href="org/osate/ge/di/IsApplicable.html" title="annotation in org.osate.ge.di" target="classFrame">IsApplicable</a></li>
<li><a href="org/osate/ge/graphics/LabelBuilder.html" title="class in org.osate.ge.graphics" target="classFrame">LabelBuilder</a></li>
<li><a href="org/osate/ge/graphics/LabelPosition.html" title="enum in org.osate.ge.graphics" target="classFrame">LabelPosition</a></li>
<li><a href="org/osate/ge/di/Names.html" title="interface in org.osate.ge.di" target="classFrame"><span class="interfaceName">Names</span></a></li>
<li><a href="org/osate/ge/PaletteEntry.html" title="interface in org.osate.ge" target="classFrame"><span class="interfaceName">PaletteEntry</span></a></li>
Expand Down
4 changes: 4 additions & 0 deletions ge/org.osate.ge.doc/api/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,18 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/osate/ge/di/Delete.html" title="annotation in org.osate.ge.di">Delete</a></li>
<li><a href="org/osate/ge/DiagramExporter.html" title="class in org.osate.ge">DiagramExporter</a></li>
<li><a href="org/osate/ge/DiagramType.html" title="interface in org.osate.ge"><span class="interfaceName">DiagramType</span></a></li>
<li><a href="org/osate/ge/graphics/Dimension.html" title="class in org.osate.ge.graphics">Dimension</a></li>
<li><a href="org/osate/ge/DockingPosition.html" title="enum in org.osate.ge">DockingPosition</a></li>
<li><a href="org/osate/ge/graphics/EllipseBuilder.html" title="class in org.osate.ge.graphics">EllipseBuilder</a></li>
<li><a href="org/osate/ge/EmfContainerProvider.html" title="interface in org.osate.ge"><span class="interfaceName">EmfContainerProvider</span></a></li>
<li><a href="org/osate/ge/query/FilterArguments.html" title="interface in org.osate.ge.query"><span class="interfaceName">FilterArguments</span></a></li>
<li><a href="org/osate/ge/FundamentalContentFilter.html" title="interface in org.osate.ge"><span class="interfaceName">FundamentalContentFilter</span></a></li>
<li><a href="org/osate/ge/di/GetBusinessObjectToModify.html" title="annotation in org.osate.ge.di">GetBusinessObjectToModify</a></li>
<li><a href="org/osate/ge/di/GetCreateOwner.html" title="annotation in org.osate.ge.di">GetCreateOwner</a></li>
<li><a href="org/osate/ge/di/GetGraphicalConfiguration.html" title="annotation in org.osate.ge.di">GetGraphicalConfiguration</a></li>
<li><a href="org/osate/ge/di/GetName.html" title="annotation in org.osate.ge.di">GetName</a></li>
<li><a href="org/osate/ge/di/GetNameForEditing.html" title="annotation in org.osate.ge.di">GetNameForEditing</a></li>
<li><a href="org/osate/ge/di/GetNameForUserInterface.html" title="annotation in org.osate.ge.di">GetNameForUserInterface</a></li>
<li><a href="org/osate/ge/di/GetPaletteEntries.html" title="annotation in org.osate.ge.di">GetPaletteEntries</a></li>
<li><a href="org/osate/ge/graphics/Graphic.html" title="interface in org.osate.ge.graphics"><span class="interfaceName">Graphic</span></a></li>
<li><a href="org/osate/ge/GraphicalAnnexUtil.html" title="class in org.osate.ge">GraphicalAnnexUtil</a></li>
Expand All @@ -49,6 +52,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/osate/ge/services/GraphicalEditorService.html" title="interface in org.osate.ge.services"><span class="interfaceName">GraphicalEditorService</span></a></li>
<li><a href="org/osate/ge/GraphicalExtensionUtil.html" title="class in org.osate.ge">GraphicalExtensionUtil</a></li>
<li><a href="org/osate/ge/di/IsApplicable.html" title="annotation in org.osate.ge.di">IsApplicable</a></li>
<li><a href="org/osate/ge/graphics/LabelBuilder.html" title="class in org.osate.ge.graphics">LabelBuilder</a></li>
<li><a href="org/osate/ge/graphics/LabelPosition.html" title="enum in org.osate.ge.graphics">LabelPosition</a></li>
<li><a href="org/osate/ge/di/Names.html" title="interface in org.osate.ge.di"><span class="interfaceName">Names</span></a></li>
<li><a href="org/osate/ge/PaletteEntry.html" title="interface in org.osate.ge"><span class="interfaceName">PaletteEntry</span></a></li>
Expand Down
4 changes: 4 additions & 0 deletions ge/org.osate.ge.doc/api/index-files/index-10.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ <h2 class="title">L</h2>
<dd>
<div class="block">Configures the palette entry builder to create a palette entry with the specified label.</div>
</dd>
<dt><a href="../org/osate/ge/graphics/LabelBuilder.html" title="class in org.osate.ge.graphics"><span class="typeNameLink">LabelBuilder</span></a> - Class in <a href="../org/osate/ge/graphics/package-summary.html">org.osate.ge.graphics</a></dt>
<dd>
<div class="block">Builder for creating label graphics</div>
</dd>
<dt><a href="../org/osate/ge/graphics/LabelPosition.html" title="enum in org.osate.ge.graphics"><span class="typeNameLink">LabelPosition</span></a> - Enum in <a href="../org/osate/ge/graphics/package-summary.html">org.osate.ge.graphics</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/StyleBuilder.html#labelsAboveTop--">labelsAboveTop()</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/StyleBuilder.html" title="class in org.osate.ge.graphics">StyleBuilder</a></dt>
Expand Down
6 changes: 6 additions & 0 deletions ge/org.osate.ge.doc/api/index-files/index-18.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,14 @@ <h2 class="title">T</h2>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/ContentFilter.html#test-java.lang.Object-">test(Object)</a></span> - Method in interface org.osate.ge.<a href="../org/osate/ge/ContentFilter.html" title="interface in org.osate.ge">ContentFilter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/FundamentalContentFilter.html#test-java.lang.Object-">test(Object)</a></span> - Method in interface org.osate.ge.<a href="../org/osate/ge/FundamentalContentFilter.html" title="interface in org.osate.ge">FundamentalContentFilter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Dimension.html#toMetamodel--">toMetamodel()</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Dimension.html" title="class in org.osate.ge.graphics">Dimension</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Point.html#toMetamodel--">toMetamodel()</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Point.html" title="class in org.osate.ge.graphics">Point</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Dimension.html#toString--">toString()</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Dimension.html" title="class in org.osate.ge.graphics">Dimension</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Point.html#toString--">toString()</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Point.html" title="class in org.osate.ge.graphics">Point</a></dt>
<dd>&nbsp;</dd>
</dl>
Expand Down
4 changes: 4 additions & 0 deletions ge/org.osate.ge.doc/api/index-files/index-2.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@ <h2 class="title">B</h2>
<dd>
<div class="block">Creates an ellipse graphic based on the current state of the builder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/LabelBuilder.html#build--">build()</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/LabelBuilder.html" title="class in org.osate.ge.graphics">LabelBuilder</a></dt>
<dd>
<div class="block">Creates a label graphic based on the current state of the builder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/PolyBuilder.html#build--">build()</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/PolyBuilder.html" title="class in org.osate.ge.graphics">PolyBuilder</a></dt>
<dd>
<div class="block">Creates a poly graphic based on the current state of the builder.</div>
Expand Down
2 changes: 2 additions & 0 deletions ge/org.osate.ge.doc/api/index-files/index-20.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ <h2 class="title">W</h2>
<dl>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Color.html#WHITE">WHITE</a></span> - Static variable in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Color.html" title="class in org.osate.ge.graphics">Color</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Dimension.html#width">width</a></span> - Variable in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Dimension.html" title="class in org.osate.ge.graphics">Dimension</a></dt>
<dd>&nbsp;</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">Q</a>&nbsp;<a href="index-16.html">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">V</a>&nbsp;<a href="index-20.html">W</a>&nbsp;<a href="index-21.html">X</a>&nbsp;<a href="index-22.html">Y</a>&nbsp;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
Expand Down
6 changes: 5 additions & 1 deletion ge/org.osate.ge.doc/api/index-files/index-3.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h2 class="title">C</h2>
</dd>
<dt><a href="../org/osate/ge/ContentFilter.html" title="interface in org.osate.ge"><span class="typeNameLink">ContentFilter</span></a> - Interface in <a href="../org/osate/ge/package-summary.html">org.osate.ge</a></dt>
<dd>
<div class="block">Content filters must be stateless.</div>
<div class="block">A configurable content filters is one whose enablement can be toggled by the user.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/PaletteEntryBuilder.html#context-java.lang.Object-">context(Object)</a></span> - Method in class org.osate.ge.<a href="../org/osate/ge/PaletteEntryBuilder.html" title="class in org.osate.ge">PaletteEntryBuilder</a></dt>
<dd>
Expand All @@ -159,6 +159,10 @@ <h2 class="title">C</h2>
<dd>
<div class="block">Creates an ellipse builder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/LabelBuilder.html#create--">create()</a></span> - Static method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/LabelBuilder.html" title="class in org.osate.ge.graphics">LabelBuilder</a></dt>
<dd>
<div class="block">Creates a label graphic builder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/PolyBuilder.html#create--">create()</a></span> - Static method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/PolyBuilder.html" title="class in org.osate.ge.graphics">PolyBuilder</a></dt>
<dd>
<div class="block">Creates a poly builder.</div>
Expand Down
8 changes: 8 additions & 0 deletions ge/org.osate.ge.doc/api/index-files/index-4.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,14 @@ <h2 class="title">D</h2>
<dd>&nbsp;</dd>
<dt><a href="../org/osate/ge/DiagramType.html" title="interface in org.osate.ge"><span class="typeNameLink">DiagramType</span></a> - Interface in <a href="../org/osate/ge/package-summary.html">org.osate.ge</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../org/osate/ge/graphics/Dimension.html" title="class in org.osate.ge.graphics"><span class="typeNameLink">Dimension</span></a> - Class in <a href="../org/osate/ge/graphics/package-summary.html">org.osate.ge.graphics</a></dt>
<dd>
<div class="block">Immutable dimension type.</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Dimension.html#Dimension-double-double-">Dimension(double, double)</a></span> - Constructor for class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Dimension.html" title="class in org.osate.ge.graphics">Dimension</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Dimension.html#Dimension-org.osate.ge.graphics.Dimension-">Dimension(Dimension)</a></span> - Constructor for class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Dimension.html" title="class in org.osate.ge.graphics">Dimension</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/di/Names.html#DOCKING_POSITION">DOCKING_POSITION</a></span> - Static variable in interface org.osate.ge.di.<a href="../org/osate/ge/di/Names.html" title="interface in org.osate.ge.di">Names</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../org/osate/ge/DockingPosition.html" title="enum in org.osate.ge"><span class="typeNameLink">DockingPosition</span></a> - Enum in <a href="../org/osate/ge/package-summary.html">org.osate.ge</a></dt>
Expand Down
2 changes: 2 additions & 0 deletions ge/org.osate.ge.doc/api/index-files/index-5.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ <h2 class="title">E</h2>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Color.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Color.html" title="class in org.osate.ge.graphics">Color</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Dimension.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Dimension.html" title="class in org.osate.ge.graphics">Dimension</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Point.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Point.html" title="class in org.osate.ge.graphics">Point</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/osate/ge/graphics/Style.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.osate.ge.graphics.<a href="../org/osate/ge/graphics/Style.html" title="class in org.osate.ge.graphics">Style</a></dt>
Expand Down
Loading

0 comments on commit d4b92e1

Please sign in to comment.