| Title: | an empirical study on evolution of api documentation |
| Author: | Shi Lin
; Zhong Hao
; Xie Tao
; Li Mingshu
|
| Source: | Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics)
|
| Conference Name: | 14th International Conference on Fundamental Approaches to Software Engineering, FASE 2011, Held as Part of the Joint European Conferences on Theory and Practice of Software, ETAPS 2011
|
| Conference Date: | March 26,
|
| Issued Date: | 2011
|
| Conference Place: | Saarbrucken, Germany
|
| Keyword: | Software engineering
|
| Publish Place: | Germany
|
| ISSN: | 3029743
|
| ISBN: | 9783642198106
|
| Department: | (1) Laboratory for Internet Software Technologies, Institute of Software, Chinese Academy of Sciences, Beijing 100190, China; (2) Key Laboratory for Computer Science, Chinese Academy of Sciences, Beijing 100190, China; (3) Department of Computer Science, North Carolina State University, United States
|
| Sponsorship: | DFG Deutsche Forschungsgemeinschaft; AbsInt Angewandte Informatik GmbH; Microsoft Research; Robert Bosch GmbH; IDS Scheer AG / Software AG
|
| English Abstract: | With the evolution of an API library, its documentation also evolves. The evolution of API documentation is common knowledge for programmers and library developers, but not in a quantitative form. Without such quantitative knowledge, programmers may neglect important revisions of API documentation, and library developers may not effectively improve API documentation based on its revision histories. There is a strong need to conduct a quantitative study on API documentation evolution. However, as API documentation is large in size and revisions can be complicated, it is quite challenging to conduct such a study. In this paper, we present an analysis methodology to analyze the evolution of API documentation. Based on the methodology, we conduct a quantitative study on API documentation evolution of five widely used real-world libraries. The results reveal various valuable findings, and these findings allow programmers and library developers to better understand API documentation evolution. © 2011 Springer-Verlag. |
| Content Type: | 会议论文
|
| URI: | http://ir.iscas.ac.cn/handle/311060/14363
|
| Appears in Collections: | 互联网软件技术实验室 _会议论文
|
| File Name/ File Size |
Content Type |
Version |
Access |
License |
|
|---|
| an empirical study on evolution of api documentation.pdf（275KB） | -- | -- | 限制开放 | -- | 联系获取全文 |
|
| Recommended Citation: | |
Shi Lin,Zhong Hao,Xie Tao,et al. an empirical study on evolution of api documentation[C]. 见:14th International Conference on Fundamental Approaches to Software Engineering, FASE 2011, Held as Part of the Joint European Conferences on Theory and Practice of Software, ETAPS 2011. Saarbrucken, Germany. March 26,.
|
|
|
