Write a Blog >>
ICSE 2021
Mon 17 May - Sat 5 June 2021

A software system evolves over time due to factors such as bug-fixes, enhancements, optimizations and deprecation. As entities interact in a software repository, the alterations made at one point may require the changes to be reflected at various other points to maintain consistency. However, often less attention is given to making appropriate changes to the documentation associated with the functions. Inconsistent documentation is undesirable, since documentation serves as a useful source of information about the functionality. This paper presents a study on the prevalence of function documentations that are indirectly or implicitly dependent on entities other than the associated function. We observe a substantial presence of such documentations, with 62% of the studied Javadoc comments being dependent on other entities, as studied in 11 open-source repositories implemented in Java. We comprehensively analyze the nature of documentation updates made in 1302 commit logs and study patterns to reason about the cause of dependency in the documentation. Our findings from the observed patterns may be applied to suggest documentations that should be updated on making a change in the repository.

Fri 28 May

Displayed time zone: Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna change

16:40 - 17:50
4.4.4. Source Code Histories and DocumentationTechnical Track / SEIS - Software Engineering in Society / NIER - New Ideas and Emerging Results at Blended Sessions Room 4 +12h
Chair(s): Davide Fucci Blekinge Institute of Technology
16:40
15m
Paper
Understanding Emotions of Developer Community Towards Software DocumentationSEIS
SEIS - Software Engineering in Society
Akhila Sri Manasa Venigalla IIT Tirupati, India, Sridhar Chimalakonda Indian Institute of Technology Tirupati
Pre-print Media Attached
16:55
20m
Paper
On Indirectly Dependent Documentation in the Context of Code Evolution: A StudyArtifact ReusableTechnical TrackArtifact Available
Technical Track
Devika Sondhi IIIT-Delhi, Avyakt Gupta IIIT-Delhi, Salil Purandare IIIT-Delhi, Ankit Rana IIIT-Delhi, Deepanshu Kaushal IIIT-Delhi, Rahul Purandare IIIT-Delhi
Pre-print Media Attached
17:15
15m
Short-paper
Mining Software Repositories with a Collaborative Heuristic RepositoryNIER
NIER - New Ideas and Emerging Results
Hlib Babii Free University of Bozen-Bolzano, Julian Prenner Free University of Bozen-Bolzano, Laurin Stricker Free University of Bozen-Bolzano, Anjan Karmakar Free University of Bozen-Bolzano, Andrea Janes Free University of Bozen-Bolzano, Romain Robbes Free University of Bozen-Bolzano
Pre-print Media Attached
17:30
20m
Paper
CodeShovel: Constructing Method-Level Source Code HistoriesACM SIGSOFT Distinguished PaperArtifact ReusableTechnical TrackArtifact Available
Technical Track
Felix Grund University of British Columbia, Shaiful Alam Chowdhury University of British Columbia, Nick Bradley University of British Columbia, Braxton Hall University of British Columbia, Reid Holmes University of British Columbia
Pre-print Media Attached

Sat 29 May

Displayed time zone: Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna change

04:40 - 05:50
04:40
15m
Paper
Understanding Emotions of Developer Community Towards Software DocumentationSEIS
SEIS - Software Engineering in Society
Akhila Sri Manasa Venigalla IIT Tirupati, India, Sridhar Chimalakonda Indian Institute of Technology Tirupati
Pre-print Media Attached
04:55
20m
Paper
On Indirectly Dependent Documentation in the Context of Code Evolution: A StudyArtifact ReusableTechnical TrackArtifact Available
Technical Track
Devika Sondhi IIIT-Delhi, Avyakt Gupta IIIT-Delhi, Salil Purandare IIIT-Delhi, Ankit Rana IIIT-Delhi, Deepanshu Kaushal IIIT-Delhi, Rahul Purandare IIIT-Delhi
Pre-print Media Attached
05:15
15m
Short-paper
Mining Software Repositories with a Collaborative Heuristic RepositoryNIER
NIER - New Ideas and Emerging Results
Hlib Babii Free University of Bozen-Bolzano, Julian Prenner Free University of Bozen-Bolzano, Laurin Stricker Free University of Bozen-Bolzano, Anjan Karmakar Free University of Bozen-Bolzano, Andrea Janes Free University of Bozen-Bolzano, Romain Robbes Free University of Bozen-Bolzano
Pre-print Media Attached
05:30
20m
Paper
CodeShovel: Constructing Method-Level Source Code HistoriesACM SIGSOFT Distinguished PaperArtifact ReusableTechnical TrackArtifact Available
Technical Track
Felix Grund University of British Columbia, Shaiful Alam Chowdhury University of British Columbia, Nick Bradley University of British Columbia, Braxton Hall University of British Columbia, Reid Holmes University of British Columbia
Pre-print Media Attached