Towards Crowd-Sourced API Documentation

被引:0
|
作者
Uddin, Gias [1 ]
Khomh, Foutse [1 ]
Roy, Chanchal K. [2 ]
机构
[1] Polytech Montreal, SWAT Lab, Montreal, PQ, Canada
[2] Univ Saskatchewan, Dept Comp Sci, Saskatoon, SK, Canada
关键词
API; Mining; Usage; Documentation;
D O I
10.1109/ICSE-Companion.2019.00129
中图分类号
TP31 [计算机软件];
学科分类号
081202 ; 0835 ;
摘要
The learnability of an API suffers when the official documentation of the API is incomplete. Developers discuss usage scenarios of APIs in the online developer forums. As such, by automatically mining such crowd-sourced documentation of APIs, we can address the shortcomings of API official documentation. We present a framework to automatically mine usage scenarios about APIs from online developer forums. Each usage scenario of an API consists of a code example, a summary description, and the reactions (i.e., positive and negative opinions) of other developers towards the code example. We evaluate our API usage mining framework by producing a benchmark dataset. We observed a precision of 0.947 and a recall of 1.0 with the linking of a code example to an API mention in the forum.
引用
收藏
页码:310 / 311
页数:2
相关论文
共 50 条
  • [1] Towards building a Crowd-Sourced Sky Map
    Lang, Dustin
    Hogg, David W.
    Schoelkopf, Bernhard
    [J]. ARTIFICIAL INTELLIGENCE AND STATISTICS, VOL 33, 2014, 33 : 549 - 557
  • [2] Towards building a Crowd-Sourced Sky Map
    20160501867012
    [J]. (1) McWilliams Center for Cosmology, Carnegie Mellon University, 5000 Forbes Ave, Pittsburgh; PA; 15213, United States; (2) Center for Cosmology and Particle Physics, New York University, 4 Washington Place, New York; NY; 10003, United States; (3) Max Planck Institute for Intelligent Systems, Spemannstrasse 38, Tübingen; 72076, Germany, 1600, Amazon; Digile; Facebook; Google; Springer (Microtome Publishing):
  • [3] Towards Crowd-Sourced Parameter Optimisation for Procedural Animation
    Henshall, Gareth I.
    Headleand, Christopher J.
    Teahan, William J.
    Ap Cenydd, Llyr
    [J]. 2015 INTERNATIONAL CONFERENCE ON CYBERWORLDS (CW), 2015, : 379 - 381
  • [4] Crowd-sourced career wisdom
    Schmidt, Bela Z.
    [J]. NATURE, 2019, 567 (7747) : 273 - 275
  • [5] Coordinating Crowd-Sourced Services
    Moamen, Ahmed Abdel
    Jamali, Nadeem
    [J]. 2014 IEEE INTERNATIONAL CONFERENCE ON MOBILE SERVICES (MS), 2014, : 92 - 99
  • [6] Inferring Crowd-Sourced Venues for Tweets
    Cao, Bokai
    Chen, Francine
    Joshi, Dhiraj
    Yu, Philip S.
    [J]. PROCEEDINGS 2015 IEEE INTERNATIONAL CONFERENCE ON BIG DATA, 2015, : 639 - 648
  • [7] CROWD-SOURCED FUNDING - WAS TAX CONSIDERED?
    Graw, Stephen
    [J]. JOURNAL OF THE AUSTRALASIAN TAX TEACHERS ASSOCIATION, 2018, 13 (01): : 85 - 113
  • [8] Crowd-sourced soil data for Europe
    Shelley, Wayne
    Lawley, Russell
    Robinson, David A.
    [J]. NATURE, 2013, 496 (7445) : 300 - 300
  • [9] Towards Community-Centric Integrity Management in Crowd-Sourced Systems
    Ranjbar, Amin
    Maheswaran, Muthucumaru
    [J]. 2011 IEEE GLOBECOM WORKSHOPS (GC WKSHPS), 2011, : 100 - 104
  • [10] Follow the Pioneers: Towards Personalized Crowd-sourced Route Generation for Mountaineers
    Daiber, Florian
    Wiehr, Frederik
    Kosmalla, Felix
    Krueger, Antonio
    [J]. PROCEEDINGS OF THE 2017 ACM INTERNATIONAL JOINT CONFERENCE ON PERVASIVE AND UBIQUITOUS COMPUTING AND PROCEEDINGS OF THE 2017 ACM INTERNATIONAL SYMPOSIUM ON WEARABLE COMPUTERS (UBICOMP/ISWC '17 ADJUNCT), 2017, : 1051 - 1055