Added application exit codes to documentation.

bbadjari · May 29, 2012 · 5b11f93 · 5b11f93
1 parent ce2c328
commit 5b11f93
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/Documentation/Readme.mkd b/Documentation/Readme.mkd
@@ -132,6 +132,29 @@ Analyze multiple Visual Studio solution files:
 
     StyleCopCLI -sln Calculator.sln C:\Projects\ImageEditor.sln
 
+### Exit Codes ###
+
+StyleCop CLI returns an integer representing the application exit code to the calling process upon termination:
+
+<table cellpadding="5">
+   <tr align="left">
+      <th>Code</th>
+      <th>Description</th>
+   </tr>
+   <tr>
+      <td>0</td>
+      <td>Application executed successfully.</td>
+   </tr>
+   <tr>
+      <td>1</td>
+      <td>Application encountered an error during execution.</td>
+   </tr>
+   <tr>
+      <td>2</td>
+      <td>Application encountered violations during analysis.</td>
+   </tr>
+</table>
+
 Releases
 --------