DROPS

Document

DOI: 10.4230/OASIcs.SLATE.2017.3

Generating Method Documentation Using Concrete Values from Executions

Authors: Matúš Sulír and Jaroslav Porubän

Published in: OASIcs, Volume 56, 6th Symposium on Languages, Applications and Technologies (SLATE 2017)

Abstract

There exist multiple automated approaches of source code documentation generation. They often describe methods in abstract terms, using the words contained in the static source code or code excerpts from repositories. In this paper, we introduce DynamiDoc - a simple yet effective automated documentation approach based on dynamic analysis. It traces the program being executed and records string representations of concrete argument values, a return value, and a target object state before and after each method execution. Then for every concerned method, it generates documentation sentences containing examples, such as "When called on [3, 1.2] with element = 3, the object changed to [1.2]". A qualitative evaluation is performed, listing advantages and shortcomings of the approach.

Cite as

Matúš Sulír and Jaroslav Porubän. Generating Method Documentation Using Concrete Values from Executions. In 6th Symposium on Languages, Applications and Technologies (SLATE 2017). Open Access Series in Informatics (OASIcs), Volume 56, pp. 3:1-3:13, Schloss Dagstuhl – Leibniz-Zentrum für Informatik (2017)

Copy BibTex To Clipboard

@InProceedings{sulir_et_al:OASIcs.SLATE.2017.3,
  author =	{Sul{\'\i}r, Mat\'{u}\v{s} and Porub\"{a}n, Jaroslav},
  title =	{{Generating Method Documentation Using Concrete Values from Executions}},
  booktitle =	{6th Symposium on Languages, Applications and Technologies (SLATE 2017)},
  pages =	{3:1--3:13},
  series =	{Open Access Series in Informatics (OASIcs)},
  ISBN =	{978-3-95977-056-9},
  ISSN =	{2190-6807},
  year =	{2017},
  volume =	{56},
  editor =	{Queir\'{o}s, Ricardo and Pinto, M\'{a}rio and Sim\~{o}es, Alberto and Leal, Jos\'{e} Paulo and Varanda, Maria Jo\~{a}o},
  publisher =	{Schloss Dagstuhl -- Leibniz-Zentrum f{\"u}r Informatik},
  address =	{Dagstuhl, Germany},
  URL =		{https://drops.dagstuhl.de/entities/document/10.4230/OASIcs.SLATE.2017.3},
  URN =		{urn:nbn:de:0030-drops-79398},
  doi =		{10.4230/OASIcs.SLATE.2017.3},
  annote =	{Keywords: documentation generation, source code summarization, methods, dynamic analysis, examples}
}

Document

DOI: 10.4230/OASIcs.SLATE.2016.6

Locating User Interface Concepts in Source Code

Authors: Matúš Sulír and Jaroslav Porubän

Published in: OASIcs, Volume 51, 5th Symposium on Languages, Applications and Technologies (SLATE'16) (2016)

Abstract

Developers often start their work by exploring a graphical user interface (GUI) of a program. They spot a textual label of interest in the GUI and try to find it in the source code, as a straightforward way of feature location. We performed a study on four Java applications, asking a simple question: Are strings displayed in the GUI of a running program present in its source code? We came to a conclusion that the majority of strings are present there; they occur mainly in Java and "properties" files.

Cite as

Matúš Sulír and Jaroslav Porubän. Locating User Interface Concepts in Source Code. In 5th Symposium on Languages, Applications and Technologies (SLATE'16). Open Access Series in Informatics (OASIcs), Volume 51, pp. 6:1-6:9, Schloss Dagstuhl – Leibniz-Zentrum für Informatik (2016)

Copy BibTex To Clipboard

@InProceedings{sulir_et_al:OASIcs.SLATE.2016.6,
  author =	{Sul{\'\i}r, Mat\'{u}\v{s} and Porub\"{a}n, Jaroslav},
  title =	{{Locating User Interface Concepts in Source Code}},
  booktitle =	{5th Symposium on Languages, Applications and Technologies (SLATE'16)},
  pages =	{6:1--6:9},
  series =	{Open Access Series in Informatics (OASIcs)},
  ISBN =	{978-3-95977-006-4},
  ISSN =	{2190-6807},
  year =	{2016},
  volume =	{51},
  editor =	{Mernik, Marjan and Leal, Jos\'{e} Paulo and Gon\c{c}alo Oliveira, Hugo},
  publisher =	{Schloss Dagstuhl -- Leibniz-Zentrum f{\"u}r Informatik},
  address =	{Dagstuhl, Germany},
  URL =		{https://drops.dagstuhl.de/entities/document/10.4230/OASIcs.SLATE.2016.6},
  URN =		{urn:nbn:de:0030-drops-60110},
  doi =		{10.4230/OASIcs.SLATE.2016.6},
  annote =	{Keywords: Source code, graphical user interfaces, feature location}
}

Search Results

Documents authored by Sulír, Matúš

Generating Method Documentation Using Concrete Values from Executions

Abstract

Cite as

Locating User Interface Concepts in Source Code

Abstract

Cite as

Thanks for your feedback!

Could not send message