Rhodes documentation map#65
Conversation
Public docs test [publish docs]
consisting of serveral lines and trying to [publish docs]
…de and longitude).
…dk-cs into rhodes-documentation-map
add build--docs.sh [publish docs]
Map example. Elevation data example. [publish docs]
…ed formatting of map example. [publish docs]
isiyu
left a comment
isiyu
left a comment
There was a problem hiding this comment.
@david-rhodes 👍
Mostly formatting issues from docFX and referencing and whether we should prefer Console.write over Debug.log
had one note about making "Canonical TileID more explicit"
| /// </summary> | ||
| public struct CanonicalTileId | ||
| /// <summary> | ||
| /// Canonical tile identifier in a slippy map. |
There was a problem hiding this comment.
Rephrase to something like
Data type to store Web Mercator tile scheme.
| /// data for a geographic bounding box at a certain zoom level. | ||
| /// </summary> | ||
| /// <typeparam name="T"> | ||
| /// The tile type, currently <see cref="T:Mapbox.Map.Vector"/> or |
There was a problem hiding this comment.
these links weren't building for me locally. doesn't seem like they were building on the to the mapbox.github.io page either?
https://mapbox.github.io/mapbox-sdk-unity/api/mapbox-sdk-cs/Mapbox.Map.Map-1.html
There was a problem hiding this comment.
You're looking at the wrong repo. Use: https://mapbox.github.io/mapbox-unity-sdk/api/mapbox-sdk-cs/Mapbox.Map.Map-1.html or https://mapbox.github.io/mapbox-sdk-cs/api/Mapbox.Map.Map-1.html.
| /// // Handle the error. | ||
| /// } | ||
| /// | ||
| /// // Consume the <see cref="Data"/>. |
There was a problem hiding this comment.
some weird formatting issues here? This is what i'm seeing on the local build:
cc @BergWerkGIS
There was a problem hiding this comment.
@isiyu
We saw xref problems before on Linux/OSX.
Updating docfx solved it.
In root of mapbox-unity-sdk delete
- file
docfx.zip - folder
docfx
and then run ./scripts/build-docs.sh again.
Does it work now?
| /// Convert a geocoordinate to a TileId: | ||
| /// <code> | ||
| /// var unwrappedTileId = TileCover.CoordinateToTileId(new Vector2d(40.015, -105.2705), 18); | ||
| /// Debug.Log("UnwrappedTileId: " + unwrappedTileId.ToString()); |
There was a problem hiding this comment.
Debug.Log is Unity specific right?
Should we make this not depend on unity. Console.write should work here in both Unity and Non-unity cases?
| /// // Handle the error. | ||
| /// } | ||
| /// | ||
| /// // Consume the <see cref="Data"/>. |
…Console.Write [publish docs]
3 participants
Source code documentation pass for
Mappieces. See latest published documents here: https://mapbox.github.io/mapbox-sdk-cs/api/Mapbox.Map.html.I also removed the Update side effects from
Map.csand updated tests.