diff --git a/src/SparseTransform/Convert/IWriter.cs b/src/SparseTransform/Convert/IWriter.cs index 12ba16ec36392dad4f86c795ac49f6fe932b8c4e..29daa63a94acc7a0d44b607448bd46315e7a4439 100644 --- a/src/SparseTransform/Convert/IWriter.cs +++ b/src/SparseTransform/Convert/IWriter.cs @@ -2,13 +2,17 @@ namespace SparseTransform.Convert { + /// <summary> + /// Common interface for writer classes that transform a graph object to a serialized string. + /// </summary> interface IWriter { /// <summary> - /// transformes the <c>graph</c> in a MatrixMarketString + /// Transforms the <c>graph</c> to a string representation. + /// The format of String is determined by the implementing class and may not necessarily represent a graph. /// </summary> - /// <param name="graph"></param> - /// <returns>transformed MatrixMarketString</returns> + /// <param name="graph">IGraph implementation to transform</param> + /// <returns>transformed string</returns> public String Write(IGraph graph);