Skip to content

Commit

Permalink
Deploying to javadoc from @ 2711fe2 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
espertus committed Mar 8, 2024
1 parent 5fc0c14 commit 61037d7
Show file tree
Hide file tree
Showing 10 changed files with 275 additions and 67 deletions.
74 changes: 39 additions & 35 deletions docs/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,85 +173,89 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="block">Checks whether the correct modifiers are used for methods (instance and
static).</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/Parser.html" title="class in com.spertus.jacquard.syntaxgrader">Parser</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/MutableInteger.html" title="class in com.spertus.jacquard.syntaxgrader">MutableInteger</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A wrapper for <code>JavaParser</code>.</div>
<div class="block">A wrapper around a mutable integer value.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/pmdgrader/PmdGrader.html" title="class in com.spertus.jacquard.pmdgrader">PmdGrader</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/Parser.html" title="class in com.spertus.jacquard.syntaxgrader">Parser</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A wrapper for <code>JavaParser</code>.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/pmdgrader/PmdGrader.html" title="class in com.spertus.jacquard.pmdgrader">PmdGrader</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A grader that makes use of the linked <a href="https://docs.pmd-code.org/latest/index.html">
PMD Source Code Analyzer Project</a>.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/publisher/Publisher.html" title="class in com.spertus.jacquard.publisher">Publisher</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/publisher/Publisher.html" title="class in com.spertus.jacquard.publisher">Publisher</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class contains code to publish the results of grading to an external
grading system, such as Gradescope.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/common/Result.html" title="class in com.spertus.jacquard.common">Result</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/common/Result.html" title="class in com.spertus.jacquard.common">Result</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The result of an evaluation of student code.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="com/spertus/jacquard/common/Result.Order.html" title="enum class in com.spertus.jacquard.common">Result.Order</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com/spertus/jacquard/common/Result.Order.html" title="enum class in com.spertus.jacquard.common">Result.Order</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">The publication order for results.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/coverage/Scorer.html" title="class in com.spertus.jacquard.coverage">Scorer</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/coverage/Scorer.html" title="class in com.spertus.jacquard.coverage">Scorer</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A way of converting branch coverage and line coverage information
into a single score.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/StatementCountGrader.html" title="class in com.spertus.jacquard.syntaxgrader">StatementCountGrader</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/StatementCountGrader.html" title="class in com.spertus.jacquard.syntaxgrader">StatementCountGrader</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A counter to test whether the number of occurrences of a given statement
type is within the specified range.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/StringInterpolationCountGrader.html" title="class in com.spertus.jacquard.syntaxgrader">StringInterpolationCountGrader</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/StringInterpolationCountGrader.html" title="class in com.spertus.jacquard.syntaxgrader">StringInterpolationCountGrader</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A grader that counts the number of occurrences of string interpolation.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com/spertus/jacquard/exceptions/SubmissionException.html" title="class in com.spertus.jacquard.exceptions">SubmissionException</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="com/spertus/jacquard/exceptions/SubmissionException.html" title="class in com.spertus.jacquard.exceptions">SubmissionException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">A checked exception indicating a problem with a submission.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxCheckGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxCheckGrader</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxCheckGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxCheckGrader</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The base class for syntax-based graders that may involve multiple items of
the same type.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxConditionCountGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxConditionCountGrader</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxConditionCountGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxConditionCountGrader</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A grader that counts whether the number of parse nodes satisfying a given
predicate is in the specified range.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxConditionGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxConditionGrader</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxConditionGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxConditionGrader</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A grader to test whether exactly the specified number of parse nodes
satisfy a predicate.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxCountGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxCountGrader</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxCountGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxCountGrader</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">The base class for counters to test whether the number of occurrences of a
syntactic element is within the specified range.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxGrader</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/syntaxgrader/SyntaxGrader.html" title="class in com.spertus.jacquard.syntaxgrader">SyntaxGrader</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The base class for syntax-based graders that make use of the linked
<a href="https://javaparser.org/">Java parser</a>.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/common/Target.html" title="class in com.spertus.jacquard.common">Target</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/common/Target.html" title="class in com.spertus.jacquard.common">Target</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">The target of a <a href="com/spertus/jacquard/common/Grader.html" title="class in com.spertus.jacquard.common"><code>Grader</code></a>, which must be a file.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/common/Tester.html" title="class in com.spertus.jacquard.common">Tester</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spertus/jacquard/common/Tester.html" title="class in com.spertus.jacquard.common">Tester</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The superclass for JUnit-based testers.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com/spertus/jacquard/exceptions/TimeoutException.html" title="class in com.spertus.jacquard.exceptions">TimeoutException</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="com/spertus/jacquard/exceptions/TimeoutException.html" title="class in com.spertus.jacquard.exceptions">TimeoutException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">A checked exception due to a test timing out.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com/spertus/jacquard/common/Visibility.html" title="enum class in com.spertus.jacquard.common">Visibility</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="com/spertus/jacquard/common/Visibility.html" title="enum class in com.spertus.jacquard.common">Visibility</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">The visibility of a <a href="com/spertus/jacquard/common/Result.html" title="class in com.spertus.jacquard.common"><code>Result</code></a>.</div>
</div>
</div>
Expand Down
18 changes: 10 additions & 8 deletions docs/com/spertus/jacquard/pmdgrader/PmdGrader.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ <h2>Method Summary</h2>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="PmdGrader.html" title="class in com.spertus.jacquard.pmdgrader">PmdGrader</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFromRules(double,double,java.lang.String,java.lang.String...)" class="member-name-link">createFromRules</a><wbr>(double&nbsp;penaltyPerViolation,
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFromRules(double,double,java.lang.String,java.lang.String,java.lang.String...)" class="member-name-link">createFromRules</a><wbr>(double&nbsp;penaltyPerViolation,
double&nbsp;maxPenalty,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;ruleSetPath,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;ruleNames)</code></div>
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;ruleName0,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;moreRuleNames)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Creates a PMD-based grader for the specified rules.</div>
</div>
Expand Down Expand Up @@ -172,25 +173,26 @@ <h3>createFromRuleSetPaths</h3>
</section>
</li>
<li>
<section class="detail" id="createFromRules(double,double,java.lang.String,java.lang.String...)">
<section class="detail" id="createFromRules(double,double,java.lang.String,java.lang.String,java.lang.String...)">
<h3>createFromRules</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="PmdGrader.html" title="class in com.spertus.jacquard.pmdgrader">PmdGrader</a></span>&nbsp;<span class="element-name">createFromRules</span><wbr><span class="parameters">(double&nbsp;penaltyPerViolation,
double&nbsp;maxPenalty,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;ruleSetPath,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;ruleNames)</span></div>
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;ruleName0,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;moreRuleNames)</span></div>
<div class="block">Creates a PMD-based grader for the specified rules. The ruleSetPath
argument should be the path to a rule set in <a href="https://github.com/pmd/pmd/tree/master/pmd-java/src/main/resources">
the PMD resource directory</a> (such as "category/java/quickstart.xml")
or in one of the client project's resource directories. The ruleNames
argument should give rule names without a preceding path, such as
"MissingOverride".</div>
or in one of the client project's resource directories. The rule names
should be provided without a preceding path, such as "MissingOverride".</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>penaltyPerViolation</code> - the penalty per violation, which should be a
positive number</dd>
<dd><code>maxPenalty</code> - the maximum penalty</dd>
<dd><code>ruleSetPath</code> - the path to a rule set</dd>
<dd><code>ruleNames</code> - the names of the rules in the rule set to use</dd>
<dd><code>ruleName0</code> - the first rule in the set to use</dd>
<dd><code>moreRuleNames</code> - additions rules in the set to use</dd>
<dt>Returns:</dt>
<dd>new PMD grader</dd>
<dt>Throws:</dt>
Expand Down
Loading

0 comments on commit 61037d7

Please sign in to comment.