000151520 001__ 151520
000151520 005__ 20190316234851.0
000151520 037__ $$aCONF
000151520 245__ $$aImproving API Documentation for Java-like Languages
000151520 269__ $$a2010
000151520 260__ $$c2010
000151520 336__ $$aConference Papers
000151520 520__ $$aThe Javadoc paradigm for displaying API documentation to users is quite popular, with similar variants existing for many mainstream languages. However, two user interface design properties of Javadoc may reduce its utility when displaying documentation for APIs that make use of inheritance and parametric polymorphism. First, Javadoc does not show a flattened view of all members of a class or interface, but rather only those defined directly in the type. Second, and as a consequence, any methods whose types contain type parameters of a superclass will always be shown in the context of the superclass. That is, if the method C.m returns type T, subclasses of C will always see this parent signature, even if they instantiate T to a concrete type such as Integer. We show that this situation arises often in some libraries, and present the results of a study that measures the usability consequences of these two Javadoc design decisions. Our results show that a user interface that shows instantiated type parameters for members is preferred over one that presents type parameters in the Javadoc style.
000151520 6531_ $$aJavadoc
000151520 6531_ $$aScaladoc
000151520 6531_ $$aDocumentation
000151520 6531_ $$aJava
000151520 6531_ $$aScala
000151520 6531_ $$aProgramming language
000151520 6531_ $$aAPI
000151520 700__ $$0241948$$g139175$$aDubochet, Gilles
000151520 700__ $$aMalayeri, Donna
000151520 7112_ $$dOctober 18, 2010$$cReno, Nevada, USA$$aEvaluation and Usability of Programming Languages and Tools
000151520 8564_ $$uhttp://ecs.victoria.ac.nz/Events/PLATEAU$$zURL
000151520 8564_ $$uhttps://infoscience.epfl.ch/record/151520/files/plateau10-dubochet.pdf$$zn/a$$s517157$$yPublisher's version
000151520 909C0 $$xU10409$$0252187$$pLAMP
000151520 909C0 $$0252262$$pLBS$$xU10871
000151520 909CO $$qGLOBAL_SET$$pconf$$pIC$$pSB$$ooai:infoscience.tind.io:151520
000151520 917Z8 $$x139175
000151520 917Z8 $$x139175
000151520 917Z8 $$x139175
000151520 917Z8 $$x139175
000151520 917Z8 $$x139175
000151520 937__ $$aEPFL-CONF-151520
000151520 973__ $$rREVIEWED$$sPUBLISHED$$aEPFL
000151520 980__ $$aCONF