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 6, 2018
1 parent e1e55a9 commit 817e391
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion api/NetTopologySuite.IO.GpxMetadata.html
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ <h5 class="propertyValue">Property Value</h5>
</table>
<h5 id="NetTopologySuite_IO_GpxMetadata_IsTrivial_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This behavior is not completely round-trip safe. An instance loaded from XML that has a
bare &quot;metadata&quot; element, without any content will look the same as an instance that had
bare &quot;metadata&quot; element without any content will look the same as an instance that had
no &quot;metadata&quot; element at all. It will be written out without a &quot;metadata&quot; element.</p>
</div>
<span class="small pull-right mobile-hide">
Expand Down
2 changes: 1 addition & 1 deletion index.json
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
"api/NetTopologySuite.IO.GpxMetadata.html": {
"href": "api/NetTopologySuite.IO.GpxMetadata.html",
"title": "Class GpxMetadata | NetTopologySuite.IO.GPX",
"keywords": "Class GpxMetadata Represents metadata about a GPX document. Inheritance Object GpxMetadata 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 GpxMetadata Remarks In the official XSD schema for GPX 1.1, this corresponds to the complex type \" metadataType \", plus the \"creator\" attribute from the complex type \" gpxType \". Constructors | Improve this Doc View Source GpxMetadata(String) Initializes a new instance of the GpxMetadata class. Declaration public GpxMetadata(string creator) Parameters Type Name Description String creator The value for Creator . Remarks IsTrivial will always be true for instances initialized using this constructor. Exceptions Type Condition ArgumentNullException creator is null . | Improve this Doc View Source GpxMetadata(String, String, String, GpxPerson, GpxCopyright, ImmutableArray<GpxWebLink>, Nullable<DateTime>, String, GpxBoundingBox, Object) Initializes a new instance of the GpxMetadata class. Declaration public GpxMetadata(string creator, string name, string description, GpxPerson author, GpxCopyright copyright, ImmutableArray<GpxWebLink> links, DateTime? creationTimeUtc, string keywords, GpxBoundingBox bounds, object extensions) Parameters Type Name Description String creator The value for Creator . String name The value for Name . String description The value for Description . GpxPerson author The value for Author . GpxCopyright copyright The value for Copyright . ImmutableArray < GpxWebLink > links The value for Links . Nullable < DateTime > creationTimeUtc The value for CreationTimeUtc . String keywords The value for Keywords . GpxBoundingBox bounds The value for Bounds . Object extensions The value for Extensions . Remarks IsTrivial will be false for instances initialized using this constructor, unless links contains no elements and all other parameters besides creator are null . Exceptions Type Condition ArgumentNullException creator is null . Properties | Improve this Doc View Source Author Gets an optional representation of the person who created this GPX file. Declaration public GpxPerson Author { get; } Property Value Type Description GpxPerson Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"author\" element. | Improve this Doc View Source Bounds Gets an optional representation of the lat/lon extents covered by this GPX file. Declaration public GpxBoundingBox Bounds { get; } Property Value Type Description GpxBoundingBox Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"bounds\" element. The system does not currently validate that this value is an accurate representation of the extents of the contents of a GPX file. | Improve this Doc View Source Copyright Gets an optional representation of the copyright that this GPX file was created under. Declaration public GpxCopyright Copyright { get; } Property Value Type Description GpxCopyright Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"copyright\" element. | Improve this Doc View Source CreationTimeUtc Gets an optional timestamp indicating when this GPX file was created. Declaration public DateTime? CreationTimeUtc { get; } Property Value Type Description Nullable < DateTime > Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"time\" element. The value, if present, will have its Kind set to Utc . | Improve this Doc View Source Creator Gets the creator of this GPX document. Declaration public string Creator { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"creator\" attribute of the top-level \"gpx\" element. | Improve this Doc View Source Description Gets an optional description of the contents of this GPX file. Declaration public string Description { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"desc\" element. | Improve this Doc View Source Extensions Gets an optional representation of arbitrary data associated with the metadata of this GPX file. Declaration public object Extensions { get; } Property Value Type Description Object Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"extensions\" element. This contains the extension content of the \"metadata\" element itself, not the extension content of the outermost \"gpx\" element. See Also ConvertMetadataExtensionElement(IEnumerable<XElement>) ConvertMetadataExtension(Object) | Improve this Doc View Source IsTrivial Gets a value indicating whether or not Creator is the only relevant data element. Used to determine when we can skip writing out a \"metadata\" element. Declaration public bool IsTrivial { get; } Property Value Type Description Boolean Remarks This behavior is not completely round-trip safe. An instance loaded from XML that has a bare \"metadata\" element, without any content will look the same as an instance that had no \"metadata\" element at all. It will be written out without a \"metadata\" element. | Improve this Doc View Source Keywords Gets an optional list of keywords associated with this GPX file. Declaration public string Keywords { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"keywords\" element. GPX does not define, by construction, how this string should be built when multiple keywords exist, so check with your provider / consumer what convention to use. | Improve this Doc View Source Links Gets a representation of URLs associated with the contents of this GPX file. Declaration public ImmutableArray<GpxWebLink> Links { get; } Property Value Type Description ImmutableArray < GpxWebLink > Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"link\" elements. | Improve this Doc View Source Name Gets an optional name for this GPX file. Declaration public string Name { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"name\" element. Methods | Improve this Doc View Source ToString() Declaration public override string ToString() Returns Type Description String Overrides Object.ToString()"
"keywords": "Class GpxMetadata Represents metadata about a GPX document. Inheritance Object GpxMetadata 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 GpxMetadata Remarks In the official XSD schema for GPX 1.1, this corresponds to the complex type \" metadataType \", plus the \"creator\" attribute from the complex type \" gpxType \". Constructors | Improve this Doc View Source GpxMetadata(String) Initializes a new instance of the GpxMetadata class. Declaration public GpxMetadata(string creator) Parameters Type Name Description String creator The value for Creator . Remarks IsTrivial will always be true for instances initialized using this constructor. Exceptions Type Condition ArgumentNullException creator is null . | Improve this Doc View Source GpxMetadata(String, String, String, GpxPerson, GpxCopyright, ImmutableArray<GpxWebLink>, Nullable<DateTime>, String, GpxBoundingBox, Object) Initializes a new instance of the GpxMetadata class. Declaration public GpxMetadata(string creator, string name, string description, GpxPerson author, GpxCopyright copyright, ImmutableArray<GpxWebLink> links, DateTime? creationTimeUtc, string keywords, GpxBoundingBox bounds, object extensions) Parameters Type Name Description String creator The value for Creator . String name The value for Name . String description The value for Description . GpxPerson author The value for Author . GpxCopyright copyright The value for Copyright . ImmutableArray < GpxWebLink > links The value for Links . Nullable < DateTime > creationTimeUtc The value for CreationTimeUtc . String keywords The value for Keywords . GpxBoundingBox bounds The value for Bounds . Object extensions The value for Extensions . Remarks IsTrivial will be false for instances initialized using this constructor, unless links contains no elements and all other parameters besides creator are null . Exceptions Type Condition ArgumentNullException creator is null . Properties | Improve this Doc View Source Author Gets an optional representation of the person who created this GPX file. Declaration public GpxPerson Author { get; } Property Value Type Description GpxPerson Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"author\" element. | Improve this Doc View Source Bounds Gets an optional representation of the lat/lon extents covered by this GPX file. Declaration public GpxBoundingBox Bounds { get; } Property Value Type Description GpxBoundingBox Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"bounds\" element. The system does not currently validate that this value is an accurate representation of the extents of the contents of a GPX file. | Improve this Doc View Source Copyright Gets an optional representation of the copyright that this GPX file was created under. Declaration public GpxCopyright Copyright { get; } Property Value Type Description GpxCopyright Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"copyright\" element. | Improve this Doc View Source CreationTimeUtc Gets an optional timestamp indicating when this GPX file was created. Declaration public DateTime? CreationTimeUtc { get; } Property Value Type Description Nullable < DateTime > Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"time\" element. The value, if present, will have its Kind set to Utc . | Improve this Doc View Source Creator Gets the creator of this GPX document. Declaration public string Creator { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"creator\" attribute of the top-level \"gpx\" element. | Improve this Doc View Source Description Gets an optional description of the contents of this GPX file. Declaration public string Description { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"desc\" element. | Improve this Doc View Source Extensions Gets an optional representation of arbitrary data associated with the metadata of this GPX file. Declaration public object Extensions { get; } Property Value Type Description Object Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"extensions\" element. This contains the extension content of the \"metadata\" element itself, not the extension content of the outermost \"gpx\" element. See Also ConvertMetadataExtensionElement(IEnumerable<XElement>) ConvertMetadataExtension(Object) | Improve this Doc View Source IsTrivial Gets a value indicating whether or not Creator is the only relevant data element. Used to determine when we can skip writing out a \"metadata\" element. Declaration public bool IsTrivial { get; } Property Value Type Description Boolean Remarks This behavior is not completely round-trip safe. An instance loaded from XML that has a bare \"metadata\" element without any content will look the same as an instance that had no \"metadata\" element at all. It will be written out without a \"metadata\" element. | Improve this Doc View Source Keywords Gets an optional list of keywords associated with this GPX file. Declaration public string Keywords { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"keywords\" element. GPX does not define, by construction, how this string should be built when multiple keywords exist, so check with your provider / consumer what convention to use. | Improve this Doc View Source Links Gets a representation of URLs associated with the contents of this GPX file. Declaration public ImmutableArray<GpxWebLink> Links { get; } Property Value Type Description ImmutableArray < GpxWebLink > Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"link\" elements. | Improve this Doc View Source Name Gets an optional name for this GPX file. Declaration public string Name { get; } Property Value Type Description String Remarks In the official XSD schema for GPX 1.1, this corresponds to the \"name\" element. Methods | Improve this Doc View Source ToString() Declaration public override string ToString() Returns Type Description String Overrides Object.ToString()"
},
"api/NetTopologySuite.IO.GpxLongitude.html": {
"href": "api/NetTopologySuite.IO.GpxLongitude.html",
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@
"output": {
".html": {
"relative_path": "api/NetTopologySuite.IO.GpxMetadata.html",
"hash": "u3xpLVtranXLSV3tBJfC6w=="
"hash": "Pp9zi4lMhy2yFsz/Ogy/fQ=="
}
},
"is_incremental": false,
Expand Down

0 comments on commit 817e391

Please sign in to comment.