fix: explain when null in CreateMapLink doc

This commit is contained in:
goat 2021-08-28 19:21:16 +02:00
parent c8566fc9b2
commit 5efe65a655
No known key found for this signature in database
GPG key ID: F18F057873895461

View file

@ -232,6 +232,7 @@ namespace Dalamud.Game.Text.SeStringHandling
/// <summary> /// <summary>
/// Creates an SeString representing an entire Payload chain that can be used to link a map position in the chat log, matching a specified zone name. /// Creates an SeString representing an entire Payload chain that can be used to link a map position in the chat log, matching a specified zone name.
/// Returns null if no corresponding PlaceName was found.
/// </summary> /// </summary>
/// <param name="placeName">The name of the location for this link. This should be exactly the name as seen in a displayed map link in-game for the same zone.</param> /// <param name="placeName">The name of the location for this link. This should be exactly the name as seen in a displayed map link in-game for the same zone.</param>
/// <param name="xCoord">The human-readable x-coordinate for this link.</param> /// <param name="xCoord">The human-readable x-coordinate for this link.</param>
@ -266,7 +267,7 @@ namespace Dalamud.Game.Text.SeStringHandling
/// </summary> /// </summary>
/// <param name="json">A serialized SeString produced by ToJson() <see cref="ToJson"/>.</param> /// <param name="json">A serialized SeString produced by ToJson() <see cref="ToJson"/>.</param>
/// <returns>A SeString initialized with values from the json.</returns> /// <returns>A SeString initialized with values from the json.</returns>
public static SeString FromJson(string json) public static SeString? FromJson(string json)
{ {
var s = JsonConvert.DeserializeObject<SeString>(json, new JsonSerializerSettings var s = JsonConvert.DeserializeObject<SeString>(json, new JsonSerializerSettings
{ {