Skip to content

Commit 1f7f3fa

Browse files
Set required type attribute for lists in docs (Azure#36196)
1 parent 3d9146b commit 1f7f3fa

File tree

13 files changed

+29
-29
lines changed

13 files changed

+29
-29
lines changed

sdk/maps/Azure.Maps.Rendering/src/Models/Options/GetMapTileOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public GetMapTileOptions(MapTileSetId mapTileSetId, MapTileIndex mapTileIndex)
3434
public MapTileIndex MapTileIndex { get; }
3535
/// <summary>
3636
/// The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by <see href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</see>. This parameter is only supported when <see cref="MapTileSetId"/> option is set to one of the values below.
37-
/// <list>
37+
/// <list type="bullet">
3838
/// <item> <c>microsoft.weather.infrared.main</c>: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame. </item>
3939
/// <item> <c>microsoft.weather.radar.main</c>: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame. </item>
4040
/// </list>

sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteDirectionOptions.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public RouteDirectionOptions()
7575

7676
/// <summary>
7777
/// Possible values:
78-
/// <list>
78+
/// <list type="bullet">
7979
/// <item><description> <c>true</c> - Do consider all available traffic information during routing </description></item>
8080
/// <item><description> <c>false</c> - Ignore current traffic data during routing. Note that although the current traffic data is ignored </description></item>
8181
/// </list>
@@ -109,7 +109,7 @@ public RouteDirectionOptions()
109109

110110
/// <summary>
111111
/// Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.
112-
/// <list>
112+
/// <list type="bullet">
113113
/// <item><description> A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. </description></item>
114114
/// <item><description> A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. </description></item>
115115
/// </list>
@@ -118,7 +118,7 @@ public RouteDirectionOptions()
118118

119119
/// <summary>
120120
/// Weight of the vehicle in kilograms.
121-
/// <list>
121+
/// <list type="bullet">
122122
/// <item><description> It is mandatory if any of the *Efficiency parameters are set. </description></item>
123123
/// <item><description> It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered. </description></item>
124124
/// <item><description> If no detailed <c>Consumption Model</c> is specified and the value of <c>vehicleWeight</c> is non-zero, then weight restrictions are considered. </description></item>
@@ -140,7 +140,7 @@ public RouteDirectionOptions()
140140
/// <summary>
141141
/// Specifies the speed-dependent component of consumption.
142142
/// Provided as an unordered list of colon-delimited speed &amp; consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
143-
/// <list>
143+
/// <list type="bullet">
144144
/// <item><description> by linear interpolation, if the given speed lies in between two speeds in the list </description></item>
145145
/// <item><description> by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list </description></item>
146146
/// </list>
@@ -208,7 +208,7 @@ public RouteDirectionOptions()
208208
/// <summary>
209209
/// Specifies the speed-dependent component of consumption.
210210
/// Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
211-
/// <list>
211+
/// <list type="bullet">
212212
/// <item><description> by linear interpolation, if the given speed lies in between two speeds in the list </description></item>
213213
/// <item><description> by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list </description></item>
214214
/// </list>
@@ -247,7 +247,7 @@ public RouteDirectionOptions()
247247
/// <summary>
248248
/// Used for reconstructing a route and for calculating zero or more alternative routes to this reference route. The provided sequence of coordinates is used as input for route reconstruction. The alternative routes are calculated between the origin and destination points specified in the base path parameter locations. If both minDeviationDistance and minDeviationTime are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively. Intermediate locations (waypoints) are not supported when using supportingPoints.
249249
/// Setting at least one of minDeviationDistance or minDeviationTime to a value greater than zero has the following consequences:
250-
/// <list>
250+
/// <list type="bullet">
251251
/// <item><description> The origin point of the calculateRoute request must be on (or very near) the input reference route. If this is not the case, an error is returned. However, the origin point does not need to be at the beginning of the input reference route (it can be thought of as the current vehicle position on the reference route). </description></item>
252252
/// <item><description> The reference route, returned as the first route in the calculateRoute response, will start at the origin point specified in the calculateRoute request. The initial part of the input reference route up until the origin point will be excluded from the response. </description></item>
253253
/// <item><description> The values of minDeviationDistance and minDeviationTime determine how far alternative routes will be guaranteed to follow the reference route from the origin point onwards. </description></item>

sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteMatrixOptions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public RouteMatrixOptions(RouteMatrixQuery query)
6363

6464
/// <summary>
6565
/// Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.
66-
/// <list>
66+
/// <list type="bullet">
6767
/// <item><description> A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. </description></item>
6868
/// <item><description> A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. </description></item>
6969
/// </list>
@@ -87,7 +87,7 @@ public RouteMatrixOptions(RouteMatrixQuery query)
8787

8888
/// <summary>
8989
/// Possible values:
90-
/// <list>
90+
/// <list type="bullet">
9191
/// <item><description> <c>true</c> - Do consider all available traffic information during routing </description></item>
9292
/// <item><description> <c>false</c> - Ignore current traffic data during routing. Note that although the current traffic data is ignored </description></item>
9393
/// </list>

sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteRangeOptions.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public RouteRangeOptions(GeoPosition routeRangePoint)
6464

6565
/// <summary>
6666
/// Possible values:
67-
/// <list>
67+
/// <list type="bullet">
6868
/// <item><description> <c>true</c> - Do consider all available traffic information during routing </description></item>
6969
/// <item><description> <c>false</c> - Ignore current traffic data during routing. Note that although the current traffic data is ignored </description></item>
7070
/// </list>
@@ -98,7 +98,7 @@ public RouteRangeOptions(GeoPosition routeRangePoint)
9898

9999
/// <summary>
100100
/// Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.
101-
/// <list>
101+
/// <list type="bullet">
102102
/// <item><description> A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. </description></item>
103103
/// <item><description> A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. </description></item>
104104
/// </list>
@@ -107,7 +107,7 @@ public RouteRangeOptions(GeoPosition routeRangePoint)
107107

108108
/// <summary>
109109
/// Weight of the vehicle in kilograms.
110-
/// <list>
110+
/// <list type="bullet">
111111
/// <item><description> It is mandatory if any of the *Efficiency parameters are set. </description></item>
112112
/// <item><description> It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered. </description></item>
113113
/// <item><description> If no detailed Consumption Model is specified and the value of <c>vehicleWeight</c> is non-zero, then weight restrictions are considered. </description></item>
@@ -129,7 +129,7 @@ public RouteRangeOptions(GeoPosition routeRangePoint)
129129
/// <summary>
130130
/// Specifies the speed-dependent component of consumption.
131131
/// Provided as an unordered list of colon-delimited speed &amp; consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
132-
/// <list>
132+
/// <list type="bullet">
133133
/// <item><description> by linear interpolation, if the given speed lies in between two speeds in the list. </description></item>
134134
/// <item><description> by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list. </description></item>
135135
/// </list>
@@ -197,7 +197,7 @@ public RouteRangeOptions(GeoPosition routeRangePoint)
197197
/// <summary>
198198
/// Specifies the speed-dependent component of consumption.
199199
/// Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
200-
/// <list>
200+
/// <list type="bullet">
201201
/// <item><description> by linear interpolation, if the given speed lies in between two speeds in the list </description></item>
202202
/// <item><description> by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list </description></item>
203203
/// </list>

sdk/maps/Azure.Maps.Routing/src/Models/RouteDirectionParameters.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public RouteDirectionParameters()
2828
private GeoCollection _SupportingPoints;
2929
/// <summary>
3030
/// A GeoJSON collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route.
31-
/// <list>
31+
/// <list type="bullet">
3232
/// <item><description> The provided sequence of supporting points is used as input for route reconstruction. </description></item>
3333
/// <item><description> The alternative routes are calculated between the origin and destination points specified in the base path parameter locations. </description></item>
3434
/// <item><description> If both <c>MinDeviationDistance</c> and <c>MinDeviationTime</c> are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively. </description></item>

sdk/maps/Azure.Maps.Routing/src/Models/RouteInstruction.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ public partial class RouteInstruction
2727
/// <param name="junctionType"> The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout. </param>
2828
/// <param name="turnAngleInDegrees">
2929
/// Indicates the direction of an instruction. If junctionType indicates a turn instruction:
30-
/// <list>
30+
/// <list type="bullet">
3131
/// <item><description> 180 = U-turn </description></item>
3232
/// <item><description> [-179, -1] = Left turn </description></item>
3333
/// <item><description> 0 = Straight on (a "0 degree" turn) </description></item>
3434
/// <item><description> [1, 179] = Right turn </description></item>
3535
/// </list>
3636
/// If junctionType indicates a bifurcation instruction:
37-
/// <list>
37+
/// <list type="bullet">
3838
/// <item><description> less than 0 - keep left </description></item>
3939
/// <item><description> larger than 0 - keep right </description></item>
4040
/// </list>

sdk/maps/Azure.Maps.Search/src/Models/Options/FuzzySearchOptions.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public class FuzzySearchOptions: SearchPointOfInterestOptions
2323
/// <summary>
2424
/// Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the &apos;smallest entity available&apos;. Returned Geometry ID can be used to get the geometry of that geography via <see href="https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon">Get Search Polygon</see> API. The following parameters are ignored when entityType is set:
2525
/// </summary>
26-
/// <list>
26+
/// <list type="bullet">
2727
/// <item><description> heading </description></item>
2828
/// <item><description> number </description></item>
2929
/// <item><description> returnRoadUse </description></item>
@@ -35,7 +35,7 @@ public class FuzzySearchOptions: SearchPointOfInterestOptions
3535
/// <summary>
3636
/// Minimum fuzziness level to be used. Default: 1, minimum: 1 and maximum: 4
3737
/// </summary>
38-
/// <list>
38+
/// <list type="bullet">
3939
/// <item><description> Level 1 has no spell checking. </description></item>
4040
/// <item><description> Level 2 uses normal n-gram spell checking. For example, query &quot;restrant&quot; can be matched to &quot;restaurant.&quot; </description></item>
4141
/// <item><description> Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for &quot;rstrnt&quot; to &quot;restaurant&quot; matching. Shingle spell checking is for &quot;mountainview&quot; to &quot;mountain view&quot; matching. </description></item>
@@ -47,7 +47,7 @@ public class FuzzySearchOptions: SearchPointOfInterestOptions
4747
/// Maximum fuzziness level to be used. Default: 2, minimum: 1 and maximum: 4
4848
/// The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.
4949
/// </summary>
50-
/// <list>
50+
/// <list type="bullet">
5151
/// <item><description> Level 1 has no spell checking. </description></item>
5252
/// <item><description> Level 2 uses normal n-gram spell checking. For example, query &quot;restrant&quot; can be matched to &quot;restaurant.&quot; </description></item>
5353
/// <item><description> Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for &quot;rstrnt&quot; to &quot;restaurant&quot; matching. Shingle spell checking is for &quot;mountainview&quot; to &quot;mountain view&quot; matching. </description></item>
@@ -59,7 +59,7 @@ public class FuzzySearchOptions: SearchPointOfInterestOptions
5959
/// Indexes which should be utilized for the search.
6060
///
6161
/// Available indexes are:
62-
/// <list>
62+
/// <list type="bullet">
6363
/// <item><description> <c>Addr</c> - Address ranges </description></item>
6464
/// <item><description> <c>Geo</c> - Geographies </description></item>
6565
/// <item><description> <c>PAD</c> - Point Addresses </description></item>
@@ -76,7 +76,7 @@ public class FuzzySearchOptions: SearchPointOfInterestOptions
7676
/// Indexes for which extended postal codes should be included in the results.
7777
///
7878
/// Available indexes are:
79-
/// <list>
79+
/// <list type="bullet">
8080
/// <item><description> <c>Addr</c> - Address ranges </description></item>
8181
/// <item><description> <c>Geo</c> - Geographies </description></item>
8282
/// <item><description> <c>PAD</c> - Point Addresses </description></item>

sdk/maps/Azure.Maps.Search/src/Models/Options/ReverseSearchOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public class ReverseSearchOptions: ReverseSearchBaseOptions
3535

3636
/// <summary>
3737
/// Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the &apos;smallest entity available&apos;. Returned Geometry ID can be used to get the geometry of that geography via <see href="https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon">Get Search Polygon</see> API. The following parameters are ignored when entityType is set:
38-
/// <list>
38+
/// <list type="bullet">
3939
/// <item><description> heading </description></item>
4040
/// <item><description> number </description></item>
4141
/// <item><description> returnRoadUse </description></item>

sdk/maps/Azure.Maps.Search/src/Models/Options/SearchAddressOptions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public class SearchAddressOptions: SearchAddressBaseOptions
1919
/// <summary>
2020
/// Indexes for which extended postal codes should be included in the results.
2121
/// Available indexes are:
22-
/// <list>
22+
/// <list type="bullet">
2323
/// <item><description> <c>Addr</c> - Address ranges </description></item>
2424
/// <item><description> <c>Geo</c> - Geographies </description></item>
2525
/// <item><description> <c>PAD</c> - Point Addresses </description></item>
@@ -35,7 +35,7 @@ public class SearchAddressOptions: SearchAddressBaseOptions
3535
/// <summary>
3636
/// Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the &apos;smallest entity available&apos;. Returned Geometry ID can be used to get the geometry of that geography via <see href="https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon">Get Search Polygon</see> API.
3737
/// The following parameters are ignored when entityType is set:
38-
/// <list>
38+
/// <list type="bullet">
3939
/// <item><description> heading </description></item>
4040
/// <item><description> number </description></item>
4141
/// <item><description> returnRoadUse </description></item>

0 commit comments

Comments
 (0)