Jadeite: Improving API documentation using usage information

Conference on Human Factors in Computing Systems - Proceedings

Volumn , Issue , 2009, Pages 4429-4434

  Stylos, Jeffrey ^a   Yang, Zizhuang ^a   Myers, Brad A ^a  

^a CARNEGIE MELLON UNIVERSITY   (United States)

Author keywords

Apis; Documentation; Javadoc

Indexed keywords

APIS; DOCUMENTATION; DOCUMENTATION SYSTEMS; JAVADOC; MULTIPLE USER; PLACEHOLDERS; USAGE STATISTICS;

ABSTRACTING; COMPUTER SCIENCE; HUMAN ENGINEERING;

APPLICATION PROGRAMMING INTERFACES (API);

EID: 70349191192     PISSN: None     EISSN: None     Source Type: Conference Proceeding    
DOI: 10.1145/1520340.1520678     Document Type: Conference Paper

References (9)

1. Bloch, J. 2001. Effective Java Programming Language Guide. Sun Microsystems, Inc.
2. Clarke, S. 2004. Measuring API Usability. Dr. Dobbs Journal, Windows/.NET Supplement. May 2004. 6-9.
3. Cwalina, K. and Abrams, B. 2005. Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable. Net Libraries. Addison-Wesley Professional.
4. Ellis, B., Stylos, J., and Myers, B. 2007. The Factory Pattern in API Design: A Usability Evaluation. International Conference on Software Engineering. ICSE '07. 302-312.
5. Forward, A. and Lethbridge, T. C. 2002. The relevance of software documentation, tools and technologies: a survey. Document Engineering. DocEng '02. 26-33.
6. Kramer, D. 1999. API documentation from source code comments: a case study of Javadoc. International Conf. on Computer Documentation. SIGDOC '99. 147-153.
7. Stylos, J. and Clarke, S. 2007. Usability Implications of Requiring Parameters in Objects' Constructors. International Conference on Software Engineering. ICSE '07. 529-539.
8. Stylos, J. and Myers, B. A. 2008. The Implications of Method Placement on API Learnability. Symp. on the Foundations of Software Engineering. FSE '08.
9. Stylos, J. and Myers, B. A. 2006. Mica: A Web-Search Tool for Finding API Components and Examples. Visual Languages and Human-Centric Computing. VL/HCC '06. 195-202.