Skip to content

Commit

Permalink
Generate new documentation for version 4.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@FaronBracy
FaronBracy committed Dec 23, 2018
1 parent d597773 commit 9ea3a90
Show file tree
Hide file tree
Showing 55 changed files with 71 additions and 71 deletions.
4 changes: 2 additions & 2 deletions docs/RogueSharp.Algorithms/DepthFirstPaths.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h5>Returns</h5>
<dt>
<code><span title="System.Collections.Generic.IEnumerable<int>">IEnumerable&lt;int&gt;</span></code>
</dt>
<dd>An IEnumerable sequence of vertices representing the path between the sourceVertex and the specified destinationVertex or null if no such path exists
<dd>An IEnumerable sequence of vertices representing the path between the sourceVertex and the specified destinationVertex or null if no such path exists. The path will not include the source vertex
</dd>
</dl>
</div>
Expand All @@ -163,7 +163,7 @@ <h5>Returns</h5>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
6 changes: 3 additions & 3 deletions docs/RogueSharp.Algorithms/DijkstraShortestPath.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ <h4>
<span title="System.Collections.Generic.IEnumerable<DirectedEdge>">IEnumerable&lt;DirectedEdge&gt;</span> <strong>FindPath</strong>(<a href="../RogueSharp.Algorithms/EdgeWeightedDigraph.htm">EdgeWeightedDigraph</a> graph, <span title="System.int">int</span> sourceVertex, <span title="System.int">int</span> destinationVertex)
</h4>
<div class="content">Returns an IEnumerable of DirectedEdges representing a shortest path from the specified sourceVertex to the specified destinationVertex
This is more efficent than creating a new DijkstraShorestPath instance and calling PathTo( destinationVertex ) when we only
This is more efficient than creating a new DijkstraShortestPath instance and calling PathTo( destinationVertex ) when we only
want a single path from Source to Destination and don't want many paths from the source to multiple different destinations.


Expand All @@ -188,7 +188,7 @@ <h5>Parameters</h5>
<dt>
<code><span title="System.int">int</span></code> sourceVertex
</dt>
<dd>The source vertext to find a shortest path from
<dd>The source vertex to find a shortest path from
</dd>
<dt>
<code><span title="System.int">int</span></code> destinationVertex
Expand All @@ -215,7 +215,7 @@ <h5>Returns</h5>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Algorithms/DirectedEdge.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
8 changes: 4 additions & 4 deletions docs/RogueSharp.Algorithms/EdgeWeightedDigraph.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ <h2 class="fixed">Types in RogueSharp.Algorithms</h2>
<p><strong>Namespace</strong> RogueSharp.Algorithms</p>
</header>
<div class="sub-header">
<div id="summary">The EdgeWeightedDigrpah class represents an edge-weighted directed graph of vertices named 0 through V-1, where each directed edge
<div id="summary">The EdgeWeightedDigraph class represents an edge-weighted directed graph of vertices named 0 through V-1, where each directed edge
is of type DirectedEdge and has real-valued weight.
</div>

Expand Down Expand Up @@ -182,7 +182,7 @@ <h4>
<span title="System.int">int</span> <strong>OutDegree</strong>(<span title="System.int">int</span> vertex)
</h4>
<div class="content">Returns the number of directed edges incident from the specified vertex
This is known as the outdegree of the vertex
This is known as the out-degree of the vertex


<div class="parameters">
Expand All @@ -191,7 +191,7 @@ <h5>Parameters</h5>
<dt>
<code><span title="System.int">int</span></code> vertex
</dt>
<dd>The vertex to find find the outdegree of
<dd>The vertex to find find the out-degree of
</dd>
</dl>
</div>
Expand Down Expand Up @@ -232,7 +232,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Algorithms/Graph.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Algorithms/IndexMinPriorityQueue`1.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Algorithms/UnionFind.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Algorithms/index.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h3 class="section">Classes</h3>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation.Exceptions/ImpossibleDieException.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation.Exceptions/InvalidChooseException.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation.Exceptions/InvalidMultiplicityException.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation.Exceptions/index.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ <h3 class="section">Classes</h3>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation.Terms/ConstantTerm.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h5>Returns</h5>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation.Terms/DiceTerm.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation.Terms/IDiceExpressionTerm.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ <h2 class="fixed">Types in RogueSharp.DiceNotation.Terms</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation.Terms/index.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h3 class="section">Interfaces</h3>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation/Dice.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ <h5>Returns</h5>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/RogueSharp.DiceNotation/DiceExpression.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ <h5>Parameters</h5>
<dt>
<code><span title="System.Nullable<int>">Nullable&lt;int&gt;</span></code> choose
</dt>
<dd>Optional number of dice to choose out of the total rolled. The highest rolled Dice will be choosen.
<dd>Optional number of dice to choose out of the total rolled. The highest rolled Dice will be chosen.
</dd>
</dl>
</div>
Expand Down Expand Up @@ -430,7 +430,7 @@ <h5>Returns</h5>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation/DiceParser.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h2 class="fixed">Types in RogueSharp.DiceNotation</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation/DiceResult.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation/IDiceParser.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h2 class="fixed">Types in RogueSharp.DiceNotation</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation/TermResult.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.DiceNotation/index.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h3 class="section">Interfaces</h3>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.MapCreation/BorderOnlyMapCreationStrategy`1.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h5>Returns</h5>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.MapCreation/CaveMapCreationStrategy`1.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h2 class="fixed">Types in RogueSharp.MapCreation</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.MapCreation/IMapCreationStrategy`1.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h2 class="fixed">Types in RogueSharp.MapCreation</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.MapCreation/RandomRoomsMapCreationStrategy`1.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h2 class="fixed">Types in RogueSharp.MapCreation</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.MapCreation/StringDeserializeMapCreationStrategy`1.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h2 class="fixed">Types in RogueSharp.MapCreation</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.MapCreation/index.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h3 class="section">Interfaces</h3>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Random/DotNetRandom.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ <h5>Parameters</h5>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Random/GaussianRandom.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h2 class="fixed">Types in RogueSharp.Random</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/RogueSharp.Random/IRandom.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h2 class="fixed">Types in RogueSharp.Random</h2>
<div class="sub-header">
<div id="summary">An Interface for pseudo-random number generators to implement.
Useful when mocking out systems for tests, as the the random number generator can be swapped for
a mock implimentation that returns known and expected values <blockquote class="remarks">
a mock implementation that returns known and expected values <blockquote class="remarks">
Pseudo-random number generators are devices that produces a sequence of numbers
that meet certain statistical requirements for randomness
</blockquote>
Expand All @@ -99,7 +99,7 @@ <h2 class="fixed">Types in RogueSharp.Random</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Random/KnownSeriesRandom.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h2 class="fixed">Types in RogueSharp.Random</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Random/MaxRandom.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h2 class="fixed">Types in RogueSharp.Random</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Random/MinRandom.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h2 class="fixed">Types in RogueSharp.Random</h2>

</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/RogueSharp.Random/RandomState.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ <h4>
</div>
</section>
</article><footer>
<span id="version">Built from v1.0.0.0 of RogueSharp</span>
<span id="version">Built from v4.2.0.0 of RogueSharp</span>
<span id="docu-link">
Generated by <a href="http://docu.jagregory.com">docu</a>
</span>
Expand Down
Loading

0 comments on commit 9ea3a90

Please sign in to comment.