Skip to content

Commit a2d18a1

Browse files
DiegoRBaqueroDiegoRBaquero
committed
Update documentation on mutators
1 parent ccab360 commit a2d18a1

32 files changed

+75
-55
lines changed

‎docs/Mutode.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ <h5>Returns:</h5>
490490
<br class="clear">
491491

492492
<footer>
493-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:56:00 GMT-0500 (-05) using the Minami theme.
493+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
494494
</footer>
495495

496496
<script>prettyPrint();</script>

‎docs/index.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@
5252
<a href="https://coveralls.io/github/TheSoftwareDesignLab/mutode?branch=master"><img src="https://coveralls.io/repos/github/TheSoftwareDesignLab/mutode/badge.svg?branch=master" alt="Coverage Status"></a></p>
5353
<p>Mutation testing for Node.js and JavaScript.</p>
5454
<p><strong>Mutode</strong> generates mutants (small changes of code) and runs your tests. If the tests fail, it means the mutant was detected and <strong>killed</strong>; if your tests pass, it means the mutant <strong>survived</strong> and your tests can be improved.</p>
55-
<p>Read the thesis proposal <a href="https://docs.google.com/document/d/1V6U-ahLq6faCbtP0DtKukzdnsUC2ZBsL1LWEJvkqUiE/edit?usp=sharing">here</a></p>
55+
<p>Read the thesis proposal <a href="https://docs.google.com/document/d/1V6U-ahLq6faCbtP0DtKukzdnsUC2ZBsL1LWEJvkqUiE/edit?usp=sharing"><strong>here</strong></a></p>
56+
<p><a href="https://www.youtube.com/watch?v=DILzHOljFj0&amp;feature=youtu.be"><strong>Watch the demo video</strong></a></p>
5657
<blockquote>
5758
<p>&quot;It's like a test for your tests!&quot; - @mappum</p>
5859
<p>&quot;Higher order testing: automated testing for your unit tests&quot; - @albertomiranda</p>
@@ -86,6 +87,9 @@ <h2>Install</h2><p>Globally:</p>
8687
<li>Current supported mutation operators are available <a href="https://thesoftwaredesignlab.github.io/mutode/module-Mutators.html"><strong>here</strong></a></li>
8788
<li>General documentation is available <a href="https://thesoftwaredesignlab.github.io/mutode/"><strong>here</strong></a></li>
8889
</ul>
90+
<h2>Videos</h2><ul>
91+
<li><a href="https://www.youtube.com/watch?v=DILzHOljFj0&amp;feature=youtu.be">Demo</a></li>
92+
</ul>
8993
<h2>License</h2><p>MIT Copyright © Diego Rodríguez Baquero</p></article>
9094
</section>
9195

@@ -99,7 +103,7 @@ <h2>License</h2><p>MIT Copyright © Diego Rodríguez Baquero</p></article>
99103
<br class="clear">
100104

101105
<footer>
102-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:55:59 GMT-0500 (-05) using the Minami theme.
106+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
103107
</footer>
104108

105109
<script>prettyPrint();</script>

‎docs/module-MutantRunner.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ <h1 class="page-title">MutantRunner</h1>
161161
<br class="clear">
162162

163163
<footer>
164-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:55:59 GMT-0500 (-05) using the Minami theme.
164+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
165165
</footer>
166166

167167
<script>prettyPrint();</script>

‎docs/module-Mutators.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ <h4 class="name" id=".invertNegativesMutator"><span class="type-signature">(stat
332332

333333

334334
<div class="description">
335-
<p>Mutates <code>-a</code> to <code>a</code></p>
335+
<p>Mutates <code>-a</code> to <code>a</code>.</p>
336336
</div>
337337

338338

@@ -415,7 +415,7 @@ <h4 class="name" id=".mathMutator"><span class="type-signature">(static) </span>
415415

416416

417417
<div class="description">
418-
<p>Mutates math operators to their inverse. Exponential operator <code>**</code> is mutated to multiplication <code>*</code></p>
418+
<p>Mutates math and bitwise operators to their inverse. The modulus operator <code>%</code> and the exponential operator <code>**</code> are mutated to multiplication <code>*</code>.</p>
419419
</div>
420420

421421

@@ -498,7 +498,7 @@ <h4 class="name" id=".negateConditionalsMutator"><span class="type-signature">(s
498498

499499

500500
<div class="description">
501-
<p>Hola</p>
501+
<p>Mutates conditionals to their inverse.</p>
502502
</div>
503503

504504

@@ -665,7 +665,7 @@ <h4 class="name" id=".removeArrayElementsMutator"><span class="type-signature">(
665665

666666

667667
<div class="description">
668-
<p>Mutates array by removing elements</p>
668+
<p>Mutates array by removing single elements.</p>
669669
</div>
670670

671671

@@ -831,7 +831,7 @@ <h4 class="name" id=".removeFuncCallArgsMutator"><span class="type-signature">(s
831831

832832

833833
<div class="description">
834-
<p>Mutates function calls removing arguments</p>
834+
<p>Mutates function calls removing single arguments.</p>
835835
</div>
836836

837837

@@ -914,7 +914,7 @@ <h4 class="name" id=".removeFuncDeclarationParamsMutator"><span class="type-sign
914914

915915

916916
<div class="description">
917-
<p>Mutates function declarations removing parameters</p>
917+
<p>Mutates function declarations removing single parameters</p>
918918
</div>
919919

920920

@@ -1080,7 +1080,7 @@ <h4 class="name" id=".removeLinesMutator"><span class="type-signature">(static)
10801080

10811081

10821082
<div class="description">
1083-
<p>Mutator that traverses files and removes single line statements</p>
1083+
<p>Mutator that comments single line statements</p>
10841084
</div>
10851085

10861086

@@ -1163,7 +1163,7 @@ <h4 class="name" id=".removeObjPropsMutator"><span class="type-signature">(stati
11631163

11641164

11651165
<div class="description">
1166-
<p>Mutates objects by removing properties</p>
1166+
<p>Mutates objects by removing single properties</p>
11671167
</div>
11681168

11691169

@@ -1246,7 +1246,7 @@ <h4 class="name" id=".removeSwitchCasesMutator"><span class="type-signature">(st
12461246

12471247

12481248
<div class="description">
1249-
<p>Mutates switch statement by removing cases</p>
1249+
<p>Mutates switch statement by removing single cases</p>
12501250
</div>
12511251

12521252

@@ -1330,7 +1330,7 @@ <h4 class="name" id=".stringLiteralsMutator"><span class="type-signature">(stati
13301330

13311331
<div class="description">
13321332
<p>Mutates string literals values.
1333-
String are mutated to a random string and to an empty string. Empty string are mutated to a random string.</p>
1333+
Strings are mutated to a random string, and to an empty string (if not previously empty).</p>
13341334
</div>
13351335

13361336

@@ -1418,7 +1418,7 @@ <h4 class="name" id=".stringLiteralsMutator"><span class="type-signature">(stati
14181418
<br class="clear">
14191419

14201420
<footer>
1421-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:55:59 GMT-0500 (-05) using the Minami theme.
1421+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
14221422
</footer>
14231423

14241424
<script>prettyPrint();</script>

‎docs/mutantRunner.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h1 class="page-title">mutantRunner.js</h1>
103103
<br class="clear">
104104

105105
<footer>
106-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:55:59 GMT-0500 (-05) using the Minami theme.
106+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
107107
</footer>
108108

109109
<script>prettyPrint();</script>

‎docs/mutators_booleanLiteralsMutator.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h1 class="page-title">mutators/booleanLiteralsMutator.js</h1>
8787
<br class="clear">
8888

8989
<footer>
90-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:55:59 GMT-0500 (-05) using the Minami theme.
90+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
9191
</footer>
9292

9393
<script>prettyPrint();</script>

‎docs/mutators_conditionalsBoundaryMutator.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h1 class="page-title">mutators/conditionalsBoundaryMutator.js</h1>
9898
<br class="clear">
9999

100100
<footer>
101-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:55:59 GMT-0500 (-05) using the Minami theme.
101+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
102102
</footer>
103103

104104
<script>prettyPrint();</script>

‎docs/mutators_incrementsMutator.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h1 class="page-title">mutators/incrementsMutator.js</h1>
9696
<br class="clear">
9797

9898
<footer>
99-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:55:59 GMT-0500 (-05) using the Minami theme.
99+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
100100
</footer>
101101

102102
<script>prettyPrint();</script>

‎docs/mutators_invertNegativesMutator.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ <h1 class="page-title">mutators/invertNegativesMutator.js</h1>
4646
const lineDiff = require('../util/lineDiff')
4747

4848
/**
49-
* @description Mutates `-a` to `a`
49+
* @description Mutates `-a` to `a`.
5050
* @function invertNegativesMutator
5151
* @memberOf module:Mutators
5252
*/
@@ -88,7 +88,7 @@ <h1 class="page-title">mutators/invertNegativesMutator.js</h1>
8888
<br class="clear">
8989

9090
<footer>
91-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:55:59 GMT-0500 (-05) using the Minami theme.
91+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
9292
</footer>
9393

9494
<script>prettyPrint();</script>

‎docs/mutators_mathMutator.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h1 class="page-title">mutators/mathMutator.js</h1>
6060
]
6161

6262
/**
63-
* @description Mutates math operators to their inverse. Exponential operator `**` is mutated to multiplication `*`
63+
* @description Mutates math and bitwise operators to their inverse. The modulus operator `%` and the exponential operator `**` are mutated to multiplication `*`.
6464
* @function mathMutator
6565
* @memberOf module:Mutators
6666
*/
@@ -104,7 +104,7 @@ <h1 class="page-title">mutators/mathMutator.js</h1>
104104
<br class="clear">
105105

106106
<footer>
107-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun May 13 2018 17:55:59 GMT-0500 (-05) using the Minami theme.
107+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:55:06 GMT-0500 (-05) using the Minami theme.
108108
</footer>
109109

110110
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)