Purpose

DYN-2655
Take the following example of XML documentation on a zero touch method. Strictly speaking it isn't a badly formatted XML as there is no XML exception that is thrown, however it does result in a different unhandled exception from our own code that parses the XML and converts it into node tooltips. Notice that here the <returns> tag following the <params> tag was missing that led to the exception and consequently the crash.

/// <summary> 
/// Create a T-Spline Surface from the string in T-Spline Mesh format. 
/// </summary> 
/// <param name="content">String representation of T-Spline Mesh file</param> 
/// <param name="inSmoothMode">Show T-Spline Surface in box or smooth visualization</param> 
/// Newly loaded T-Spline surface in list 
/// <search>tspline,import,serialize</search> 
[AllowRankReduction] 
public static TSplineSurface[] DeserializeFromTSM(string content, bool inSmoothMode = false) {...}

Declarations

Check these if you believe they are true

• The codebase is in a better state after this PR
• Is documented according to the standards
• The level of testing this PR includes is appropriate
• User facing strings, if any, are extracted into *.resx files
• All tests pass using the self-service CI.
• Snapshot of UI changes, if any.
• Changes to the API follow Semantic Versioning and are documented in the API Changes document.

Reviewers

@DynamoDS/dynamo