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
airbreather committed Aug 20, 2018
1 parent 78fc357 commit 11df21c
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 7 deletions.
27 changes: 22 additions & 5 deletions api/NetTopologySuite.IO.GpxEmail.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ <h3 id="constructors">Constructors
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/new/develop/doc/overwrite/new?filename=NetTopologySuite_IO_GpxEmail__ctor_System_String_System_String_.md&amp;value=---%0Auid%3A%20NetTopologySuite.IO.GpxEmail.%23ctor(System.String%2CSystem.String)%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/GpxEmail.cs/#L24">View Source</a>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxEmail.cs/#L29">View Source</a>
</span>
<a id="NetTopologySuite_IO_GpxEmail__ctor_" data-uid="NetTopologySuite.IO.GpxEmail.#ctor*"></a>
<h4 id="NetTopologySuite_IO_GpxEmail__ctor_System_String_System_String_" data-uid="NetTopologySuite.IO.GpxEmail.#ctor(System.String,System.String)">GpxEmail(String, String)</h4>
Expand Down Expand Up @@ -160,6 +160,23 @@ <h5 class="parameters">Parameters</h5>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="parametername">domain</span></td>
<td><p>The value for <a class="xref" href="NetTopologySuite.IO.GpxEmail.html#NetTopologySuite_IO_GpxEmail_Domain">Domain</a>.</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">id</code> or <code data-dev-comment-type="paramref" class="paramref">domain</code> is
<span class="xref">null</span>.</p>
</td>
</tr>
</tbody>
Expand All @@ -171,7 +188,7 @@ <h3 id="properties">Properties
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/new/develop/doc/overwrite/new?filename=NetTopologySuite_IO_GpxEmail_Domain.md&amp;value=---%0Auid%3A%20NetTopologySuite.IO.GpxEmail.Domain%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/GpxEmail.cs/#L46">View Source</a>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxEmail.cs/#L51">View Source</a>
</span>
<a id="NetTopologySuite_IO_GpxEmail_Domain_" data-uid="NetTopologySuite.IO.GpxEmail.Domain*"></a>
<h4 id="NetTopologySuite_IO_GpxEmail_Domain" data-uid="NetTopologySuite.IO.GpxEmail.Domain">Domain</h4>
Expand Down Expand Up @@ -206,7 +223,7 @@ <h5 id="NetTopologySuite_IO_GpxEmail_Domain_remarks">Remarks</h5>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/new/develop/doc/overwrite/new?filename=NetTopologySuite_IO_GpxEmail_Id.md&amp;value=---%0Auid%3A%20NetTopologySuite.IO.GpxEmail.Id%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/GpxEmail.cs/#L37">View Source</a>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxEmail.cs/#L42">View Source</a>
</span>
<a id="NetTopologySuite_IO_GpxEmail_Id_" data-uid="NetTopologySuite.IO.GpxEmail.Id*"></a>
<h4 id="NetTopologySuite_IO_GpxEmail_Id" data-uid="NetTopologySuite.IO.GpxEmail.Id">Id</h4>
Expand Down Expand Up @@ -243,7 +260,7 @@ <h3 id="methods">Methods
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/new/develop/doc/overwrite/new?filename=NetTopologySuite_IO_GpxEmail_ToString.md&amp;value=---%0Auid%3A%20NetTopologySuite.IO.GpxEmail.ToString%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/GpxEmail.cs/#L49">View Source</a>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxEmail.cs/#L54">View Source</a>
</span>
<a id="NetTopologySuite_IO_GpxEmail_ToString_" data-uid="NetTopologySuite.IO.GpxEmail.ToString*"></a>
<h4 id="NetTopologySuite_IO_GpxEmail_ToString" data-uid="NetTopologySuite.IO.GpxEmail.ToString">ToString()</h4>
Expand Down Expand Up @@ -281,7 +298,7 @@ <h5 class="overrides">Overrides</h5>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/new/develop/doc/overwrite/new?filename=NetTopologySuite_IO_GpxEmail.md&amp;value=---%0Auid%3A%20NetTopologySuite.IO.GpxEmail%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxEmail.cs/#L13" class="contribution-link">View Source</a>
<a href="https://github.com/NetTopologySuite/NetTopologySuite.IO.GPX/blob/develop/src/NetTopologySuite.IO.GPX/GpxEmail.cs/#L14" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
"api/NetTopologySuite.IO.GpxEmail.html": {
"href": "api/NetTopologySuite.IO.GpxEmail.html",
"title": "Class GpxEmail | NetTopologySuite.IO.GPX",
"keywords": "Class GpxEmail Represents an e-mail address by ID and domain, kept separate in GPX files in an attempt to defeat simple e-mail harvesting schemes. Inheritance Object GpxEmail Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Namespace : NetTopologySuite.IO Assembly : NetTopologySuite.IO.GPX.dll Syntax public sealed class GpxEmail : ICanWriteToXmlWriter Remarks In the official XSD schema for GPX 1.1, this corresponds to the simple type \" emailType \". Constructors | Improve this Doc View Source GpxEmail(String, String) Initializes a new instance of the GpxEmail class. Declaration public GpxEmail(string id, string domain) Parameters Type Name Description String id The value for Id . String domain The value for Domain . Properties | Improve this Doc View Source Domain Gets the user ID fragment of the e-mail address. This is the part after the '@'. Declaration public string Domain { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"domain\" attribute. | Improve this Doc View Source Id Gets the user ID fragment of the e-mail address. This is the part before the '@'. Declaration public string Id { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"id\" attribute. Methods | Improve this Doc View Source ToString() Declaration public override string ToString() Returns Type Description String Overrides Object.ToString()"
"keywords": "Class GpxEmail Represents an e-mail address by ID and domain, kept separate in GPX files in an attempt to defeat simple e-mail harvesting schemes. Inheritance Object GpxEmail Inherited Members Object.Equals(Object) Object.Equals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Object.ReferenceEquals(Object, Object) Namespace : NetTopologySuite.IO Assembly : NetTopologySuite.IO.GPX.dll Syntax public sealed class GpxEmail : ICanWriteToXmlWriter Remarks In the official XSD schema for GPX 1.1, this corresponds to the simple type \" emailType \". Constructors | Improve this Doc View Source GpxEmail(String, String) Initializes a new instance of the GpxEmail class. Declaration public GpxEmail(string id, string domain) Parameters Type Name Description String id The value for Id . String domain The value for Domain . Exceptions Type Condition ArgumentNullException Thrown when id or domain is null . Properties | Improve this Doc View Source Domain Gets the user ID fragment of the e-mail address. This is the part after the '@'. Declaration public string Domain { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"domain\" attribute. | Improve this Doc View Source Id Gets the user ID fragment of the e-mail address. This is the part before the '@'. Declaration public string Id { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"id\" attribute. Methods | Improve this Doc View Source ToString() Declaration public override string ToString() Returns Type Description String Overrides Object.ToString()"
},
"api/NetTopologySuite.IO.GpxDgpsStationId.html": {
"href": "api/NetTopologySuite.IO.GpxDgpsStationId.html",
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
"output": {
".html": {
"relative_path": "api/NetTopologySuite.IO.GpxEmail.html",
"hash": "UCC+Y5XYyK6hVX1GJkYYUw=="
"hash": "T9luDqQjJVRiFqQ/0T4J+w=="
}
},
"is_incremental": false,
Expand Down

0 comments on commit 11df21c

Please sign in to comment.