Skip to content

Commit 1d56ad8

Browse files
pmbittnerpmbittner
committed
docs: improved documentation of DiffNode and DiffTree, added interesting classes to Readme
1 parent d2f7689 commit 1d56ad8

526 files changed

Lines changed: 1103 additions & 1159 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,16 @@ The aggregated results can be found in the following files.
6161

6262
Moreover, the results comprise the (LaTeX) tables that are part of our paper and appendix.
6363

64+
### Documentation
65+
66+
DiffDetective's code base is documented with javadoc and can be accessed on this [website][documentation]. Interesting classes of our library are:
67+
- [DiffTree](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/diff/difftree/DiffTree.html) and [DiffNode](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/diff/difftree/DiffNode.html) implement variation tree diffs from our paper. A variation tree diff is represented by an instance of the `DiffTree` class. It stores the root node of the diff and offers various methods to parse, traverse, and analyze variation tree diffs. `DiffNode`s represent individual nodes within a variation tree diff.
68+
- [Validation](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/validation/Validation.html) contains the main method for our validation.
69+
- [ProposedElementaryPatterns](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/pattern/elementary/proposed/ProposedElementaryPatterns.html) holds the catalog of nine edit patterns we proposed in our paper. It implements the interface [ElementaryPatternCatalogue](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/pattern/elementary/ElementaryPatternCatalogue.html), which allows to define custom pattern catalogs.
70+
- [BooleanAbstraction](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/feature/BooleanAbstraction.html) contains data and methods for boolean abstraction of higher-order logic formulas. We use this for macro parsing.
71+
- [GitDiffer](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/diff/GitDiffer.html) may parse the history of a git repository to variation tree diffs.
72+
- The [datasets](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/datasets/package-summary.html) package contains various classes for describing and loading datasets.
73+
6474
## 2. Appendix
6575

6676
Our appendix consists of:

‎docs/javadoc/allclasses-index.html‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (16) on Wed Jul 06 15:39:16 CEST 2022 -->
5+
<!-- Generated by javadoc (16) on Fri Jul 08 16:40:43 CEST 2022 -->
66
<title>All Classes (diffdetective 1.0.0 API)</title>
77
<meta name="viewport" content="width=device-width, initial-scale=1">
88
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9-
<meta name="dc.created" content="2022-07-06">
9+
<meta name="dc.created" content="2022-07-08">
1010
<meta name="description" content="class index">
1111
<meta name="generator" content="javadoc/AllClassesIndexWriter">
1212
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -254,7 +254,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
254254
</div>
255255
<div class="col-first odd-row-color all-classes-table-tab2 all-classes-table"><a href="org/variantsync/diffdetective/diff/difftree/DiffTree.html" title="class in org.variantsync.diffdetective.diff.difftree">DiffTree</a></div>
256256
<div class="col-last odd-row-color all-classes-table-tab2 all-classes-table">
257-
<div class="block">Implementation of the diff tree.</div>
257+
<div class="block">Implementation of variation tree diffs from our ESEC/FSE'22 paper.</div>
258258
</div>
259259
<div class="col-first even-row-color all-classes-table-tab2 all-classes-table"><a href="org/variantsync/diffdetective/diff/difftree/filter/DiffTreeFilter.html" title="class in org.variantsync.diffdetective.diff.difftree.filter">DiffTreeFilter</a></div>
260260
<div class="col-last even-row-color all-classes-table-tab2 all-classes-table">
@@ -748,20 +748,16 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
748748
<div class="col-last even-row-color all-classes-table-tab2 all-classes-table">
749749
<div class="block">Labels are of the form <code>CodeType_DiffType</code>.</div>
750750
</div>
751-
<div class="col-first odd-row-color all-classes-table-tab2 all-classes-table"><a href="org/variantsync/diffdetective/pattern/elementary/proposed/Untouched.html" title="class in org.variantsync.diffdetective.pattern.elementary.proposed">Untouched</a></div>
751+
<div class="col-first odd-row-color all-classes-table-tab2 all-classes-table"><a href="org/variantsync/diffdetective/validation/Validation.html" title="class in org.variantsync.diffdetective.validation">Validation</a></div>
752752
<div class="col-last odd-row-color all-classes-table-tab2 all-classes-table">
753-
<div class="block">Our Untouched pattern from the ESEC/FSE'22 paper.</div>
754-
</div>
755-
<div class="col-first even-row-color all-classes-table-tab2 all-classes-table"><a href="org/variantsync/diffdetective/validation/Validation.html" title="class in org.variantsync.diffdetective.validation">Validation</a></div>
756-
<div class="col-last even-row-color all-classes-table-tab2 all-classes-table">
757753
<div class="block">This is the validation from our ESEC/FSE'22 paper.</div>
758754
</div>
759-
<div class="col-first odd-row-color all-classes-table-tab2 all-classes-table"><a href="org/variantsync/diffdetective/tablegen/styles/VariabilityShare.html" title="class in org.variantsync.diffdetective.tablegen.styles">VariabilityShare</a></div>
760-
<div class="col-last odd-row-color all-classes-table-tab2 all-classes-table">
755+
<div class="col-first even-row-color all-classes-table-tab2 all-classes-table"><a href="org/variantsync/diffdetective/tablegen/styles/VariabilityShare.html" title="class in org.variantsync.diffdetective.tablegen.styles">VariabilityShare</a></div>
756+
<div class="col-last even-row-color all-classes-table-tab2 all-classes-table">
761757
<div class="block">A template of a LaTex table containing the share of variability changing edits for each dataset.</div>
762758
</div>
763-
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="org/variantsync/diffdetective/diff/difftree/WrongTimeException.html" title="class in org.variantsync.diffdetective.diff.difftree">WrongTimeException</a></div>
764-
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
759+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="org/variantsync/diffdetective/diff/difftree/WrongTimeException.html" title="class in org.variantsync.diffdetective.diff.difftree">WrongTimeException</a></div>
760+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
765761
<div class="block">An exception that signals that an invalid <a href="org/variantsync/diffdetective/diff/difftree/Time.html" title="enum class in org.variantsync.diffdetective.diff.difftree"><code>Time</code></a> was used for a certain computation.</div>
766762
</div>
767763
</div>

‎docs/javadoc/allpackages-index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (16) on Wed Jul 06 15:39:16 CEST 2022 -->
5+
<!-- Generated by javadoc (16) on Fri Jul 08 16:40:43 CEST 2022 -->
66
<title>All Packages (diffdetective 1.0.0 API)</title>
77
<meta name="viewport" content="width=device-width, initial-scale=1">
88
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9-
<meta name="dc.created" content="2022-07-06">
9+
<meta name="dc.created" content="2022-07-08">
1010
<meta name="description" content="package index">
1111
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
1212
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/javadoc/constant-values.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (16) on Wed Jul 06 15:39:16 CEST 2022 -->
5+
<!-- Generated by javadoc (16) on Fri Jul 08 16:40:43 CEST 2022 -->
66
<title>Constant Field Values (diffdetective 1.0.0 API)</title>
77
<meta name="viewport" content="width=device-width, initial-scale=1">
88
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9-
<meta name="dc.created" content="2022-07-06">
9+
<meta name="dc.created" content="2022-07-08">
1010
<meta name="description" content="summary of constants">
1111
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
1212
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/javadoc/deprecated-list.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (16) on Wed Jul 06 15:39:16 CEST 2022 -->
5+
<!-- Generated by javadoc (16) on Fri Jul 08 16:40:43 CEST 2022 -->
66
<title>Deprecated List (diffdetective 1.0.0 API)</title>
77
<meta name="viewport" content="width=device-width, initial-scale=1">
88
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9-
<meta name="dc.created" content="2022-07-06">
9+
<meta name="dc.created" content="2022-07-08">
1010
<meta name="description" content="deprecated elements">
1111
<meta name="generator" content="javadoc/DeprecatedListWriter">
1212
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/javadoc/help-doc.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (16) on Wed Jul 06 15:39:16 CEST 2022 -->
5+
<!-- Generated by javadoc (16) on Fri Jul 08 16:40:43 CEST 2022 -->
66
<title>API Help (diffdetective 1.0.0 API)</title>
77
<meta name="viewport" content="width=device-width, initial-scale=1">
88
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9-
<meta name="dc.created" content="2022-07-06">
9+
<meta name="dc.created" content="2022-07-08">
1010
<meta name="description" content="help">
1111
<meta name="generator" content="javadoc/HelpWriter">
1212
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/javadoc/index-all.html‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (16) on Wed Jul 06 15:39:16 CEST 2022 -->
5+
<!-- Generated by javadoc (16) on Fri Jul 08 16:40:43 CEST 2022 -->
66
<title>Index (diffdetective 1.0.0 API)</title>
77
<meta name="viewport" content="width=device-width, initial-scale=1">
88
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9-
<meta name="dc.created" content="2022-07-06">
9+
<meta name="dc.created" content="2022-07-08">
1010
<meta name="description" content="index">
1111
<meta name="generator" content="javadoc/IndexWriter">
1212
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -1131,7 +1131,7 @@ <h2 class="title" id="I:D">D</h2>
11311131
</dd>
11321132
<dt><a href="org/variantsync/diffdetective/diff/difftree/DiffTree.html" title="class in org.variantsync.diffdetective.diff.difftree"><span class="type-name-link">DiffTree</span></a> - Class in <a href="org/variantsync/diffdetective/diff/difftree/package-summary.html">org.variantsync.diffdetective.diff.difftree</a></dt>
11331133
<dd>
1134-
<div class="block">Implementation of the diff tree.</div>
1134+
<div class="block">Implementation of variation tree diffs from our ESEC/FSE'22 paper.</div>
11351135
</dd>
11361136
<dt><span class="member-name-link"><a href="org/variantsync/diffdetective/diff/difftree/DiffTree.html#%3Cinit%3E(org.variantsync.diffdetective.diff.difftree.DiffNode)">DiffTree(DiffNode)</a></span> - Constructor for class org.variantsync.diffdetective.diff.difftree.<a href="org/variantsync/diffdetective/diff/difftree/DiffTree.html" title="class in org.variantsync.diffdetective.diff.difftree">DiffTree</a></dt>
11371137
<dd>
@@ -3606,8 +3606,6 @@ <h2 class="title" id="I:M">M</h2>
36063606
<dd>
36073607
<div class="block">Returns true iff given node matches this pattern.</div>
36083608
</dd>
3609-
<dt><span class="member-name-link"><a href="org/variantsync/diffdetective/pattern/elementary/proposed/Untouched.html#matchesCodeNode(org.variantsync.diffdetective.diff.difftree.DiffNode)">matchesCodeNode(DiffNode)</a></span> - Method in class org.variantsync.diffdetective.pattern.elementary.proposed.<a href="org/variantsync/diffdetective/pattern/elementary/proposed/Untouched.html" title="class in org.variantsync.diffdetective.pattern.elementary.proposed">Untouched</a></dt>
3610-
<dd>&nbsp;</dd>
36113609
<dt><span class="member-name-link"><a href="org/variantsync/diffdetective/analysis/AnalysisResult.html#max">max</a></span> - Variable in class org.variantsync.diffdetective.analysis.<a href="org/variantsync/diffdetective/analysis/AnalysisResult.html" title="class in org.variantsync.diffdetective.analysis">AnalysisResult</a></dt>
36123610
<dd>&nbsp;</dd>
36133611
<dt><span class="member-name-link"><a href="org/variantsync/diffdetective/analysis/CommitProcessTime.html#max(org.variantsync.diffdetective.analysis.CommitProcessTime,org.variantsync.diffdetective.analysis.CommitProcessTime)">max(CommitProcessTime, CommitProcessTime)</a></span> - Static method in class org.variantsync.diffdetective.analysis.<a href="org/variantsync/diffdetective/analysis/CommitProcessTime.html" title="class in org.variantsync.diffdetective.analysis">CommitProcessTime</a></dt>
@@ -5304,10 +5302,6 @@ <h2 class="title" id="I:U">U</h2>
53045302
<dd>
53055303
<div class="block">Creates an count for an unkown commit in the given repository.</div>
53065304
</dd>
5307-
<dt><a href="org/variantsync/diffdetective/pattern/elementary/proposed/Untouched.html" title="class in org.variantsync.diffdetective.pattern.elementary.proposed"><span class="type-name-link">Untouched</span></a> - Class in <a href="org/variantsync/diffdetective/pattern/elementary/proposed/package-summary.html">org.variantsync.diffdetective.pattern.elementary.proposed</a></dt>
5308-
<dd>
5309-
<div class="block">Our Untouched pattern from the ESEC/FSE'22 paper.</div>
5310-
</dd>
53115305
<dt><span class="member-name-link"><a href="org/variantsync/diffdetective/pattern/elementary/proposed/ProposedElementaryPatterns.html#Untouched">Untouched</a></span> - Static variable in class org.variantsync.diffdetective.pattern.elementary.proposed.<a href="org/variantsync/diffdetective/pattern/elementary/proposed/ProposedElementaryPatterns.html" title="class in org.variantsync.diffdetective.pattern.elementary.proposed">ProposedElementaryPatterns</a></dt>
53125306
<dd>&nbsp;</dd>
53135307
<dt><span class="member-name-link"><a href="org/variantsync/diffdetective/diff/result/DiffResult.html#unwrap()">unwrap()</a></span> - Method in class org.variantsync.diffdetective.diff.result.<a href="org/variantsync/diffdetective/diff/result/DiffResult.html" title="class in org.variantsync.diffdetective.diff.result">DiffResult</a></dt>

‎docs/javadoc/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (16) on Wed Jul 06 15:39:16 CEST 2022 -->
5+
<!-- Generated by javadoc (16) on Fri Jul 08 16:40:43 CEST 2022 -->
66
<title>Overview (diffdetective 1.0.0 API)</title>
77
<meta name="viewport" content="width=device-width, initial-scale=1">
88
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9-
<meta name="dc.created" content="2022-07-06">
9+
<meta name="dc.created" content="2022-07-08">
1010
<meta name="description" content="package index">
1111
<meta name="generator" content="javadoc/PackageIndexWriter">
1212
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/javadoc/member-search-index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/javadoc/org/variantsync/diffdetective/analysis/AnalysisResult.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (16) on Wed Jul 06 15:39:16 CEST 2022 -->
5+
<!-- Generated by javadoc (16) on Fri Jul 08 16:40:43 CEST 2022 -->
66
<title>AnalysisResult (diffdetective 1.0.0 API)</title>
77
<meta name="viewport" content="width=device-width, initial-scale=1">
88
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9-
<meta name="dc.created" content="2022-07-06">
9+
<meta name="dc.created" content="2022-07-08">
1010
<meta name="description" content="declaration: package: org.variantsync.diffdetective.analysis, class: AnalysisResult">
1111
<meta name="generator" content="javadoc/ClassWriterImpl">
1212
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

0 commit comments

Comments
 (0)