To help developers in using frameworks, good documentation is crucial. However, it is a challenge to create high quality documentation especially of hotspots in white-box frameworks. This paper presents an approach to documentation of object-oriented white-box frameworks which mines from client code four different kinds of documentation items, which we call subclassing directives. A case study on the Eclipse JFace user-interface framework shows that the approach can improve the state of API documentation w.r.t. subclassing directives.
authors in alphabetical order, acceptance rate: 16/51, 31%
Reference:
Mining Subclassing Directives to Improve Framework Reuse (Marcel Bruch, Mira Mezini, Martin Monperrus), In Proceedings of the 7th IEEE Working Conference on Mining Software Repositories, IEEE, 2010. (authors in alphabetical order, acceptance rate: 16/51, 31%)
Bibtex Entry:
@INPROCEEDINGS{Bruch2010,
author = {Marcel Bruch and Mira Mezini and Martin Monperrus},
title = {Mining Subclassing Directives to Improve Framework Reuse},
booktitle = {Proceedings of the 7th IEEE Working Conference on Mining Software
Repositories},
year = {2010},
publisher = {IEEE},
abstract = {To help developers in using frameworks, good documentation is crucial.
However, it is a challenge to create high quality documentation especially
of hotspots in white-box frameworks. This paper presents an approach
to documentation of object-oriented white-box frameworks which mines
from client code four different kinds of documentation items, which
we call subclassing directives. A case study on the Eclipse JFace
user-interface framework shows that the approach can improve the
state of API documentation w.r.t. subclassing directives.},
comment = {authors in alphabetical order, acceptance rate: 16/51, 31%},
doi = {10.1109/MSR.2010.5463347},
url = {http://www.monperrus.net/martin/Mining-Subclassing-Directives-to-Improve-Framework-Reuse.pdf},
x-abbrv = {MSR}
}Powered by bibtexbrowser
View PDF