A tool to generate reference docs from the eBay SOAP API WSDL.
Author: Alan Lewis, John Darrow
License: MIT License
Downloads
Purpose
The InOutDoc class generates the Call Reference documentation for the call information that was extracted from the appinfo tags in the schema by the WSDLParser class.
History
A legal subtag of <xs:annotation> is the <xs:appinfo> tag.
Lisa Tesler and Alan Lewis envisioned how appinfo could be used by the
engineering and documentation teams to identify which calls used each
element of the WSDL/schema. Alan developed the proof-of-concept code,
Version 1.0 of the apireferencedocs codebase, that extracted these new
tags and developed call-specific documentation (think "javadoc"), a
significant step toward capturing call/field relationship information
not otherwise available in schema documentation. John Darrow then
restructured the classes, setting the foundation for the significant
expansion of the Call Reference documentation and the development of alternate output formats, such as the Field Index and Enumeration Index.
Subject to Change
Please note that appinfo names and values are quite stable, but they
are still subject to change. The Docs team is working diligently to add
pertinent appinfo details to the schema and present the information via
the Call Reference (requiring additional changes to this package).
