Modify documentation of APIs
[platform/core/csapi/tizenfx.git] / src / Tizen.Maps / Tizen.Maps / IGeocodePreference.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17
18 namespace Tizen.Maps
19 {
20     /// <summary>
21     /// Preferences for geocode searches
22     /// </summary>
23     public interface IGeocodePreference
24     {
25         /// <summary>
26         /// Gets or sets a string that presents preferred language.
27         /// </summary>
28         /// <remarks>Language should be specified as an ISO 3166 alpha-2 two letter country-code
29         /// followed by ISO 639-1 for the two-letter language code.<br/>e.g. "ko-KR", "en-US".</remarks>
30         string Language { get; set; }
31
32         /// <summary>
33         /// Gets or sets the maximum number of results.
34         /// </summary>
35         /// <remarks>Setting negative value will not have any effect on MaxResults value.</remarks>
36         int MaxResults { get; set; }
37     }
38 }