Skip to content
Browse files

added jsdoc style comments to reporters, included usage details for r…

…eadme
  • Loading branch information...
1 parent 7b14980 commit fe58181d7e8e69005c771fed48d3fbdea210e9c7 @larrymyers larrymyers committed
Showing with 16 additions and 1 deletion.
  1. +6 −0 README.markdown
  2. +7 −0 src/jasmine.console_reporter.js
  3. +3 −1 src/jasmine.junit_reporter.js
View
6 README.markdown
@@ -7,3 +7,9 @@ Right now the project is focused on two new reporters:</p>
* ConsoleReporter - Report test results to the browser console.
* JUnitXmlReporter - Report test results to a file (using Rhino) in JUnit XML Report format.
+
+Usage:
+
+Examples are included in the test directory that show how to use the reporters, as well as a basic
+runner script for envjs, which could be used in a Continuous Integration project for running
+headless and generating JUnit XML output.
View
7 src/jasmine.console_reporter.js
@@ -5,7 +5,14 @@
}
/**
+ * Basic reporter that outputs spec results to the browser console.
+ * Useful if you need to test an html page and don't want the TrivialReporter
+ * markup mucking things up.
*
+ * Usage:
+ *
+ * jasmine.getEnv().addReporter(new jasmine.ConsoleReporter());
+ * jasmine.getEnv().execute();
*/
var ConsoleReporter = function() {
this.started = false;
View
4 src/jasmine.junit_reporter.js
@@ -29,7 +29,9 @@
}
/**
- *
+ * Generates JUnit XML for the given spec run.
+ * Allows the test results to be used in java based CI
+ * systems like CruiseControl and Hudson.
*/
var JUnitXmlReporter = function(savePath) {
this.savePath = savePath || '';

0 comments on commit fe58181

Please sign in to comment.
Something went wrong with that request. Please try again.