Sun Java Solaris Communities My SDN Account Join SDN
 
Documentation

API Specifications vs API Developer Documentation

 

API Specifications vs.
API Developer Documentation

Contents
A common question we get is: Why aren't the Java 2 platform API specifications written as more complete developer documentation? Why don't they include full working code examples, definitions of common programming terms, conceptual overviews, metaphors, illustrations, descriptions of implementation bugs and workarounds? We have chosen to put this information in the books listed below, and restrict the specifications to "assertions" necessary for conforming implementations.

  • For the API developer documentation, see:
    The Java Class Libraries, Second Edition - These books include more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terminology, workarounds for bugs, and working code examples for classes, interfaces and members in 15 basic packages.
 
Available in print only. Code samples are online.*
 
Browsable online and available as printed book.
  • For the API specification, see:
    The Java 2 Platform, Standard Edition API Specification - This defines the API specification and provides brief descriptions, with few examples and without lengthy or illustrative developer documentation. This documentation is generated by Javadoc from doc comments in the source code.
 
Available online only.*
  • For other developer documentation, see:
    Java 2 SDK SE Documentation - This is the documentation for a particular release of the Java 2 SDK. It includes the Java 2 Platform, Std. Ed. API Specification mentioned above.
 
Available online only.*
Available in print & online.*
Available in print only.
*Online docs are available as free downloads.