Skip to content

Commit

Permalink
Update docs. This was performed automatically.
Browse files Browse the repository at this point in the history
  • Loading branch information
airbreather committed Aug 20, 2018
1 parent 11df21c commit dd06695
Show file tree
Hide file tree
Showing 7 changed files with 644 additions and 7 deletions.
467 changes: 467 additions & 0 deletions api/NetTopologySuite.IO.GpxFile.html

Large diffs are not rendered by default.

54 changes: 52 additions & 2 deletions api/NetTopologySuite.IO.GpxReader.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h3 id="methods">Methods
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/new/develop/doc/overwrite/new?filename=NetTopologySuite_IO_GpxReader_Read_System_Xml_XmlReader_NetTopologySuite_IO_GpxReaderSettings_NetTopologySuite_IO_GpxVisitorBase_.md&amp;value=---%0Auid%3A%20NetTopologySuite.IO.GpxReader.Read(System.Xml.XmlReader%2CNetTopologySuite.IO.GpxReaderSettings%2CNetTopologySuite.IO.GpxVisitorBase)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxReader.cs/#L68">View Source</a>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxReader.cs/#L88">View Source</a>
</span>
<a id="NetTopologySuite_IO_GpxReader_Read_" data-uid="NetTopologySuite.IO.GpxReader.Read*"></a>
<h4 id="NetTopologySuite_IO_GpxReader_Read_System_Xml_XmlReader_NetTopologySuite_IO_GpxReaderSettings_NetTopologySuite_IO_GpxVisitorBase_" data-uid="NetTopologySuite.IO.GpxReader.Read(System.Xml.XmlReader,NetTopologySuite.IO.GpxReaderSettings,NetTopologySuite.IO.GpxVisitorBase)">Read(XmlReader, GpxReaderSettings, GpxVisitorBase)</h4>
Expand Down Expand Up @@ -174,12 +174,37 @@ <h5 class="parameters">Parameters</h5>
<h5 id="NetTopologySuite_IO_GpxReader_Read_System_Xml_XmlReader_NetTopologySuite_IO_GpxReaderSettings_NetTopologySuite_IO_GpxVisitorBase__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method is the &quot;core&quot; reading method; everything else builds off of this.</p>
</div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></td>
<td><p>Thrown when <code data-dev-comment-type="paramref" class="paramref">reader</code> or <code data-dev-comment-type="paramref" class="paramref">visitor</code> is
<span class="xref">null</span>.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.xml.xmlexception">XmlException</a></td>
<td><p>Thrown when <code data-dev-comment-type="paramref" class="paramref">reader</code> does not specify a valid GPX file (i.e., cases
where XSD schema validation would fail, and/or some values are <strong>well</strong> outside of
the slightly stricter, but still completely reasonable, limits imposed by the idiomatic
.NET data types above and beyond the XSD limits).</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/new/develop/doc/overwrite/new?filename=NetTopologySuite_IO_GpxReader_ReadFeatures_System_Xml_XmlReader_NetTopologySuite_IO_GpxReaderSettings_GeoAPI_Geometries_IGeometryFactory_.md&amp;value=---%0Auid%3A%20NetTopologySuite.IO.GpxReader.ReadFeatures(System.Xml.XmlReader%2CNetTopologySuite.IO.GpxReaderSettings%2CGeoAPI.Geometries.IGeometryFactory)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxReader.cs/#L34">View Source</a>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxReader.cs/#L44">View Source</a>
</span>
<a id="NetTopologySuite_IO_GpxReader_ReadFeatures_" data-uid="NetTopologySuite.IO.GpxReader.ReadFeatures*"></a>
<h4 id="NetTopologySuite_IO_GpxReader_ReadFeatures_System_Xml_XmlReader_NetTopologySuite_IO_GpxReaderSettings_GeoAPI_Geometries_IGeometryFactory_" data-uid="NetTopologySuite.IO.GpxReader.ReadFeatures(System.Xml.XmlReader,NetTopologySuite.IO.GpxReaderSettings,GeoAPI.Geometries.IGeometryFactory)">ReadFeatures(XmlReader, GpxReaderSettings, IGeometryFactory)</h4>
Expand Down Expand Up @@ -236,6 +261,31 @@ <h5 class="returns">Returns</h5>
<td><p>The <span class="xref">NetTopologySuite.Features.Feature</span> instances that represent the top-level GPX data elements, as
well as the <a class="xref" href="NetTopologySuite.IO.GpxMetadata.html">GpxMetadata</a> for the GPX file and the top-level extension
content from the file.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></td>
<td><p>Thrown when <code data-dev-comment-type="paramref" class="paramref">reader</code> or <code data-dev-comment-type="paramref" class="paramref">geometryFactory</code> is
<span class="xref">null</span>.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.xml.xmlexception">XmlException</a></td>
<td><p>Thrown when <code data-dev-comment-type="paramref" class="paramref">reader</code> does not specify a valid GPX file (i.e., cases
where XSD schema validation would fail, and/or some values are <strong>well</strong> outside of
the slightly stricter, but still completely reasonable, limits imposed by the idiomatic
.NET data types above and beyond the XSD limits).</p>
</td>
</tr>
</tbody>
Expand Down
3 changes: 3 additions & 0 deletions api/NetTopologySuite.IO.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ <h4><a class="xref" href="NetTopologySuite.IO.GpxExtensionWriter.html">GpxExtens
sequence. This allows us to round-trip when the default <a class="xref" href="NetTopologySuite.IO.GpxExtensionReader.html">GpxExtensionReader</a>
implementation is used, and not much else.
</p>
</section>
<h4><a class="xref" href="NetTopologySuite.IO.GpxFile.html">GpxFile</a></h4>
<section><p>A container that holds all the individual pieces of a GPX file.</p>
</section>
<h4><a class="xref" href="NetTopologySuite.IO.GpxMetadata.html">GpxMetadata</a></h4>
<section><p>Represents metadata about a GPX document.</p>
Expand Down
3 changes: 3 additions & 0 deletions api/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
<li>
<a href="NetTopologySuite.IO.GpxExtensionWriter.html" name="" title="GpxExtensionWriter">GpxExtensionWriter</a>
</li>
<li>
<a href="NetTopologySuite.IO.GpxFile.html" name="" title="GpxFile">GpxFile</a>
</li>
<li>
<a href="NetTopologySuite.IO.GpxFixKind.html" name="" title="GpxFixKind">GpxFixKind</a>
</li>
Expand Down

0 comments on commit dd06695

Please sign in to comment.