diff --git a/CSV Metrics Logger Generator/CSV Metrics Logger Generator.csproj b/CSV Metrics Logger Generator/CSV Metrics Logger Generator.csproj index 9c5d44a..c89277e 100644 --- a/CSV Metrics Logger Generator/CSV Metrics Logger Generator.csproj +++ b/CSV Metrics Logger Generator/CSV Metrics Logger Generator.csproj @@ -7,6 +7,19 @@ enable CS8600;CS8602;CS8603 true + + true + false + 1.0.0 + 1.0.0 + 1.0.0 + Thorsten Sommer + https://devops.tsommer.org/open-source/dotnet/csv-metrics-logger + https://devops.tsommer.org/open-source/dotnet/csv-metrics-logger + MIT + README.md + CSVMetricsLoggerGenerator + true @@ -17,4 +30,13 @@ + + + + + + + + + diff --git a/CSV Metrics Logger Generator/README.md b/CSV Metrics Logger Generator/README.md new file mode 100644 index 0000000..30404ce --- /dev/null +++ b/CSV Metrics Logger Generator/README.md @@ -0,0 +1 @@ +TODO \ No newline at end of file diff --git a/CSV Metrics Logger/CSV Metrics Logger.csproj b/CSV Metrics Logger/CSV Metrics Logger.csproj index c4d0220..a86d2d2 100644 --- a/CSV Metrics Logger/CSV Metrics Logger.csproj +++ b/CSV Metrics Logger/CSV Metrics Logger.csproj @@ -7,10 +7,33 @@ enable enable CS8600;CS8602;CS8603 + + true + 1.0.0 + 1.0.0 + 1.0.0 + Thorsten Sommer + https://devops.tsommer.org/open-source/dotnet/csv-metrics-logger + https://devops.tsommer.org/open-source/dotnet/csv-metrics-logger + MIT + README.md + CSVMetricsLogger + + bin\Debug\CSVMetricsLogger.xml + + + + bin\Release\CSVMetricsLogger.xml + + + + + + diff --git a/CSV Metrics Logger/CSVRecordAttribute.cs b/CSV Metrics Logger/CSVRecordAttribute.cs index 977b306..df54881 100644 --- a/CSV Metrics Logger/CSVRecordAttribute.cs +++ b/CSV Metrics Logger/CSVRecordAttribute.cs @@ -1,4 +1,9 @@ namespace CSV_Metrics_Logger; +/// +/// An attribute to mark a struct as a CSV record. Every so marked struct +/// will be augmented with the necessary methods to convert it to a CSV record. +/// In order to work, the struct must be partial. +/// [AttributeUsage(AttributeTargets.Struct)] public sealed class CSVRecordAttribute : Attribute; \ No newline at end of file diff --git a/CSV Metrics Logger/IConvertToCSV.cs b/CSV Metrics Logger/IConvertToCSV.cs index 9f61e82..d025d00 100644 --- a/CSV Metrics Logger/IConvertToCSV.cs +++ b/CSV Metrics Logger/IConvertToCSV.cs @@ -1,10 +1,27 @@ namespace CSV_Metrics_Logger; +/// +/// Interface for converting a struct to a CSV record. This interface is used +/// by the source generator to augment the struct with the necessary methods. +/// Hence, you DO NOT need to implement this interface yourself. +/// public interface IConvertToCSV { + /// + /// Returns the number of columns in the CSV record. + /// + /// The number of columns in the CSV record. public uint GetCSVColumnCount(); + /// + /// Returns the headers of the CSV record. + /// + /// The headers of the CSV record. public IList GetCSVHeaders(); + /// + /// Returns the data line of the CSV record. + /// + /// The data line of the CSV record. public IList ConvertToCSVDataLine(); } \ No newline at end of file diff --git a/CSV Metrics Logger/README.md b/CSV Metrics Logger/README.md new file mode 100644 index 0000000..30404ce --- /dev/null +++ b/CSV Metrics Logger/README.md @@ -0,0 +1 @@ +TODO \ No newline at end of file diff --git a/README.md b/README.md index e69de29..30404ce 100644 --- a/README.md +++ b/README.md @@ -0,0 +1 @@ +TODO \ No newline at end of file