Title :
Using Association Metrics to Help Users Navigate API Documentation
Author :
Eisenberg, Daniel S. ; Stylos, Jeffrey ; Faulring, Andrew ; Myers, Brad A.
Author_Institution :
Sch. of Comput. Sci., Carnegie Mellon Univ., Pittsburgh, PA, USA
Abstract :
In the past decade there has been spectacular growth in the number and size of third-party libraries, frameworks, toolkits and other Application Programming Interfaces (APIs) available to modern software developers. However, the time-saving advantages of code re-use are commonly hampered by the difficulty in finding the correct methods for a given task among the thousands of irrelevant ones. We have developed a tool called Apatite that helps address this issue by letting programmers browse APIs by viewing associations between their components. Apatite indicates which items of an API are popular in different contexts and allows browsing by initially selecting verbs (methods and actions) in addition to classes and packages. The associations are calculated by leveraging existing search engine data and source code, and verbs are identified by parsing the documentation descriptions. Apatite is available on the web and is being used by developers worldwide on a regular basis.
Keywords :
application program interfaces; search engines; software engineering; system documentation; API documentation; application programming interface; association metric; documentation descriptions; search engine; software developer; third party library; Context; Data mining; Documentation; Google; Java; Measurement; Search engines; API Documentation; Browsing; Search tool; Visualizations; Web applications;
Conference_Titel :
Visual Languages and Human-Centric Computing (VL/HCC), 2010 IEEE Symposium on
Conference_Location :
Leganes
Print_ISBN :
978-1-4244-8485-0
DOI :
10.1109/VLHCC.2010.13