Skip to content

Commit c220e18

Browse files
author
Petr Šrámek
committed
Minor source code changes, documentation updated
1 parent 9be6b15 commit c220e18

36 files changed

+2044
-1796
lines changed

‎src/Cloudikka.PolylineAlgorithm/.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
###############
2+
# folder #
3+
###############
4+
/**/DROP/
5+
/**/TEMP/
6+
/**/packages/
7+
/**/bin/
8+
/**/obj/
9+
_site

‎src/Cloudikka.PolylineAlgorithm/Cloudikka.PolylineAlgorithm.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</PropertyGroup>
1414

1515
<ItemGroup>
16-
<PackageReference Include="docfx.console" Version="2.33.0" />
16+
<PackageReference Include="docfx.console" Version="2.36.1" />
1717
</ItemGroup>
1818

1919
<ItemGroup>

‎src/Cloudikka.PolylineAlgorithm/Cloudikka.PolylineAlgorithm.sln

Lines changed: 0 additions & 49 deletions
This file was deleted.

‎src/Cloudikka.PolylineAlgorithm/Encoding/IPolylineEncoding.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public interface IPolylineEncoding<T> {
1818
/// <summary>
1919
/// Method performs decoding from polyline encoded <see cref="System.String"/> to <see cref="IEnumerable{T}"/>
2020
/// </summary>
21-
/// <param name="source">The <see cref="string"/> as polyline encoded source</param>
21+
/// <param name="source">The <see cref="System.String"/> as polyline encoded source</param>
2222
/// <returns>The <see cref="IEnumerable{T}"/></returns>
2323
IEnumerable<T> Decode(string source);
2424

‎src/Cloudikka.PolylineAlgorithm/Encoding/PolylineEncoding.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace Cloudikka.PolylineAlgorithm.Encoding {
77
/// <summary>
8-
/// Defines default polyline encoding with generic <see cref="System.ValueTuple[double, double]"/>
8+
/// Defines default polyline encoding with generic <see cref="System.ValueTuple[double, double]"/>
99
/// </summary>
1010
public class PolylineEncoding : PolylineEncodingBase<(double Latitude, double Longitude)> {
1111
#region Methods

‎src/Cloudikka.PolylineAlgorithm/Encoding/PolylineEncodingBase.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public abstract class PolylineEncodingBase<T> : IPolylineEncoding<T> {
1818
/// <summary>
1919
/// Method performs decode operation and coversion to desired type
2020
/// </summary>
21-
/// <param name="source">The <see cref="string"/></param>
21+
/// <param name="source">The <see cref="String"/></param>
2222
/// <returns>The <see cref="IEnumerable{T}"/></returns>
2323
public IEnumerable<T> Decode(string source) {
2424
if (String.IsNullOrEmpty(source)) {
@@ -35,7 +35,7 @@ public IEnumerable<T> Decode(string source) {
3535
/// Method performs conversion to coordinate tuple and encode operation.
3636
/// </summary>
3737
/// <param name="source">The <see cref="IEnumerable{T}"/></param>
38-
/// <returns>The <see cref="string"/></returns>
38+
/// <returns>The <see cref="String"/></returns>
3939
public string Encode(IEnumerable<T> source) {
4040
if (source == null || !source.Any()) {
4141
throw new ArgumentException(ExceptionMessageResource.ArgumentCannotBeNullOrEmpty, nameof(source));

‎src/Cloudikka.PolylineAlgorithm/_site/api/Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding-1.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<meta name="viewport" content="width=device-width">
1111
<meta name="title" content="Interface IPolylineEncoding&lt;T&gt;
1212
">
13-
<meta name="generator" content="docfx 2.33.0.0">
13+
<meta name="generator" content="docfx 2.36.1.0">
1414

1515
<link rel="shortcut icon" href="../favicon.ico">
1616
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -22,7 +22,7 @@
2222

2323

2424
</head>
25-
<body data-spy="scroll" data-target="#affix">
25+
<body data-spy="scroll" data-target="#affix" data-offset="120">
2626
<div id="wrapper">
2727
<header>
2828

@@ -102,14 +102,14 @@ <h3 id="methods">Methods
102102
</h3>
103103
<span class="small pull-right mobile-hide">
104104
<span class="divider">|</span>
105-
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/new/alpha/apiSpec/new?filename=Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1_Decode_System_String_.md&amp;value=---%0Auid%3A%20Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding%601.Decode(System.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>
105+
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/new/master/apiSpec/new?filename=Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1_Decode_System_String_.md&amp;value=---%0Auid%3A%20Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding%601.Decode(System.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>
106106
</span>
107107
<span class="small pull-right mobile-hide">
108-
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/blob/alpha/src/Cloudikka.PolylineAlgorithm/Encoding/IPolylineEncoding.cs/#L23">View Source</a>
108+
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/blob/master/src/Cloudikka.PolylineAlgorithm/Encoding/IPolylineEncoding.cs/#L23">View Source</a>
109109
</span>
110110
<a id="Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1_Decode_" data-uid="Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding`1.Decode*"></a>
111111
<h4 id="Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1_Decode_System_String_" data-uid="Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding`1.Decode(System.String)">Decode(String)</h4>
112-
<div class="markdown level1 summary"><p>Method performs decoding from polyline encoded <span class="xref">System.String</span> to <span class="xref">System.Collections.Generic.IEnumerable&lt;T&gt;</span></p>
112+
<div class="markdown level1 summary"><p>Method performs decoding from polyline encoded <see cref="!:System.String"></see> to <see cref="!:IEnumerable&lt;T>"></see></p>
113113
</div>
114114
<div class="markdown level1 conceptual"></div>
115115
<h5 class="decalaration">Declaration</h5>
@@ -129,7 +129,7 @@ <h5 class="parameters">Parameters</h5>
129129
<tr>
130130
<td><span class="xref">System.String</span></td>
131131
<td><span class="parametername">source</span></td>
132-
<td><p>The <span class="xref">System.String</span> as polyline encoded source</p>
132+
<td><p>The <see cref="!:System.String"></see> as polyline encoded source</p>
133133
</td>
134134
</tr>
135135
</tbody>
@@ -144,22 +144,22 @@ <h5 class="returns">Returns</h5>
144144
</thead>
145145
<tbody>
146146
<tr>
147-
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
148-
<td><p>The <span class="xref">System.Collections.Generic.IEnumerable&lt;T&gt;</span></p>
147+
<td><span class="xref">IEnumerable</span>&lt;T&gt;</td>
148+
<td><p>The <see cref="!:IEnumerable&lt;T>"></see></p>
149149
</td>
150150
</tr>
151151
</tbody>
152152
</table>
153153
<span class="small pull-right mobile-hide">
154154
<span class="divider">|</span>
155-
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/new/alpha/apiSpec/new?filename=Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1_Encode_System_Collections_Generic_IEnumerable__0__.md&amp;value=---%0Auid%3A%20Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding%601.Encode(System.Collections.Generic.IEnumerable%7B%600%7D)%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>
155+
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/new/master/apiSpec/new?filename=Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1_Encode_IEnumerable__0__.md&amp;value=---%0Auid%3A%20Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding%601.Encode(IEnumerable%7B%600%7D)%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>
156156
</span>
157157
<span class="small pull-right mobile-hide">
158-
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/blob/alpha/src/Cloudikka.PolylineAlgorithm/Encoding/IPolylineEncoding.cs/#L30">View Source</a>
158+
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/blob/master/src/Cloudikka.PolylineAlgorithm/Encoding/IPolylineEncoding.cs/#L30">View Source</a>
159159
</span>
160160
<a id="Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1_Encode_" data-uid="Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding`1.Encode*"></a>
161-
<h4 id="Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1_Encode_System_Collections_Generic_IEnumerable__0__" data-uid="Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding`1.Encode(System.Collections.Generic.IEnumerable{`0})">Encode(IEnumerable&lt;T&gt;)</h4>
162-
<div class="markdown level1 summary"><p>Method performs encoding from generic type to polyline encoded <span class="xref">System.String</span></p>
161+
<h4 id="Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1_Encode_IEnumerable__0__" data-uid="Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding`1.Encode(IEnumerable{`0})">Encode(IEnumerable&lt;T&gt;)</h4>
162+
<div class="markdown level1 summary"><p>Method performs encoding from generic type to polyline encoded <see cref="!:System.String"></see></p>
163163
</div>
164164
<div class="markdown level1 conceptual"></div>
165165
<h5 class="decalaration">Declaration</h5>
@@ -177,7 +177,7 @@ <h5 class="parameters">Parameters</h5>
177177
</thead>
178178
<tbody>
179179
<tr>
180-
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
180+
<td><span class="xref">IEnumerable</span>&lt;T&gt;</td>
181181
<td><span class="parametername">source</span></td>
182182
<td><p>Coordinates to encode</p>
183183
</td>
@@ -208,10 +208,10 @@ <h5 class="returns">Returns</h5>
208208
<div class="contribution">
209209
<ul class="nav">
210210
<li>
211-
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/new/alpha/apiSpec/new?filename=Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1.md&amp;value=---%0Auid%3A%20Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding%601%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>
211+
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/new/master/apiSpec/new?filename=Cloudikka_PolylineAlgorithm_Encoding_IPolylineEncoding_1.md&amp;value=---%0Auid%3A%20Cloudikka.PolylineAlgorithm.Encoding.IPolylineEncoding%601%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>
212212
</li>
213213
<li>
214-
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/blob/alpha/src/Cloudikka.PolylineAlgorithm/Encoding/IPolylineEncoding.cs/#L15" class="contribution-link">View Source</a>
214+
<a href="https://github.com/cloudikka/polyline-algorithm-csharp/blob/master/src/Cloudikka.PolylineAlgorithm/Encoding/IPolylineEncoding.cs/#L15" class="contribution-link">View Source</a>
215215
</li>
216216
</ul>
217217
</div>

0 commit comments

Comments
 (0)