Skip to content
This repository was archived by the owner on Feb 12, 2025. It is now read-only.

Commit 68144c1

Browse files
committed
extra documentation in the StatisticsPublisher on the default provided Statistics
1 parent 3c6f4ad commit 68144c1

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

project/core/publishers/Statistics/StatisticsPublisher.cs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,25 @@ namespace ThoughtWorks.CruiseControl.Core.Publishers.Statistics
6666
/// metric on y-axis in the artifacts directory named as <statistic name>.png. This chart would still be a very basic representation.
6767
/// For now at least, exporting the report to Excel for charting/analyis might be a better option.
6868
/// </para>
69+
/// <para>
70+
/// The following are default provided :
71+
/// <code>
72+
/// &lt;FirstMatch name="StartTime" xpath= "/cruisecontrol/build/@date")&gt;
73+
/// &lt;FirstMatch name="Duration" xpath= "/cruisecontrol/build/@buildtime")&gt;
74+
///
75+
/// &lt;Statistic name="TestCount" xpath= "sum name =//test-results/@total)")&gt;
76+
/// &lt;Statistic name="TestFailures" xpath= "sum name =//test-results/@failures)")&gt;
77+
/// &lt;Statistic name="TestIgnored" xpath= "sum name =//test-results/@not-run)")&gt;
78+
///
79+
/// &lt;Statistic name="GendarmeDefects" xpath= "count name =//gendarme-output//rule/target/defect)")&gt;
80+
///
81+
/// &lt;Statistic name="FxCop Warnings" xpath= "count name =//FxCopReport//Message[Issue/@Level='Warning' or Issue/@Level='CriticalWarning'])")&gt;
82+
/// &lt;Statistic name="FxCop Errors" xpath= "count name =//FxCopReport//Message[Issue/@Level='Error' or Issue/@Level='CriticalError'])")&gt;
83+
///
84+
/// &lt;FirstMatch name="BuildErrorType" xpath= "//failure/builderror/type")&gt;
85+
/// &lt;FirstMatch name="BuildErrorMessage" xpath= "//failure/builderror/message")&gt;
86+
/// </code>
87+
/// </para>
6988
/// </remarks>
7089
/// <example>
7190
/// <code title="Minimalist example">

0 commit comments

Comments
 (0)