Documentation Reuse: Hot or Not?
An Empirical Study

Mohamed A. Oumaziz, Alan Charpentier, Jean-Rémy Falleri, Xavier Blanc

Package

In order to replicate our experiments, we provide our tool as a package downloadable HERE.
The tool has two dependencies to install first with the two command-lines as follow :

• gem install diggit
• gem install nokogiri

The tool receives four parameters :

• Git repository URL
• Commit hash (optional)
• Folder to scan
• Kind of duplications we are looking for [method | attribute | class]

To replicate each experiment, copy-paste the corresponding command-line:

• Apache Commons Collections :
  java -cp DocReuse.jar tk.acceptus.docreuse.App https://github.com/apache/commons-collections.git 979a93d7b67e794f92a94a3ee776e5e553c21696 src/main method
• Apache Commons IO :
  java -cp DocReuse.jar tk.acceptus.docreuse.App https://github.com/apache/commons-io.git 9146eca01bc208c9923aff6880b220a0fe3e6894 src/main method
• Google Guava :
  java -cp DocReuse.jar tk.acceptus.docreuse.App https://github.com/google/guava.git 00ad4b03340a6b58134e5f6f5c46c0eb775a3895 guava/src method
• Google Gson :
  java -cp DocReuse.jar tk.acceptus.docreuse.App https://github.com/google/gson.git 2b08c88c09d14e0b1a68a982bab0bb18206df76b gson/src method
• SLF4J :
  java -cp DocReuse.jar tk.acceptus.docreuse.App https://github.com/qos-ch/slf4j.git 7c2f6cd1dc8e2fe26f6ca7334d1319ffced995a4 slf4j-api/src/main method
• Mockito :
  java -cp DocReuse.jar tk.acceptus.docreuse.App https://github.com/mockito/mockito.git 196ff979da156caa07e19f57e4849637d8bede1a src/main method
• Junit :
  java -cp DocReuse.jar tk.acceptus.docreuse.App https://github.com/junit-team/junit.git 9e98a85ecf6e857523fcda9150756297a64bccba src/main method

Detector source code

The source code of our detector can be accessed in this page: DocReuse

Proposal

The implemented JavaDoc Doclet for our proposal can be accessed in this page: Proposal

Experiments results

For the reuse experiment, you can find all the results in this page.

While the relations' results can be found in this page.

Here are all the diagrams presenting the sizes and number of owners of the identified duplications :

Apache Commons Collection

Apache Commons IO

Google Guava

Google Gson

SLF4J

Mockito

Junit

Here are all the Venn diagrams depicting the frequency of the possible combinations of items in a same duplication :

Apache Commons Collection

Apache Commons IO

Google Guava

Google Gson

SLF4J

Mockito

Junit