This parameter group controls the overall content of the generated WSDL/XSD documentation.
The "WSDLDoc" template set generates documentation built of large independent
documentation blocks.
In framed HTML, each of those blocks becomes a separate HTML file (or page) displayed in the "Detail Frame".
In case of single file (HTML or RTF) documentation, the blocks become separate sections that follow one after another.
Additionally, in RTF each of those sections may have its own page header/footer.
There are following types of documentation blocks:
-
Overview Summary: This block is generated only once for the whole documentation.
It includes:
- Summary of namespaces
- Summary of all WSDL files and XML schemas documented
-
All Component Summary: This block (also generated only once) contains summaries
of all WSDL definitions and XSD components throughout all WSDL files and XML schemas documented.
-
Namespace Overview: This block is generated for each documented namespace.
It includes:
- Summaries of all WSDL files and XML schemas targeting that namespace
- Summaries of all WSDL definitions and XSD components defined in that namespace
-
WSDL File Overview: It is generated for every documented WSDL file and includes:
- General information about the WSDL file (profile)
- Description
- Summary of XML schemas embedded in this WSDL file
- Summary of all WSDL definitions found in this WSDL file
-
Schema Overview: This block is generated for every documented XML schema (including embedded ones).
It contains:
- General information about this XML schema (profile)
- Description (collected by all annotations of <xs:schema> element)
- Summary of all XSD components found in this schema
-
WSDL Definition Documentation: This block is generated for particular WSDL definitions
(services, bindings, portTypes, messages).
It provides the detailed information about the given definition.
-
XSD Component Documentation: This block can be generated for global XSD components of any type
and local elements. It provides the detailed information about the given component.
-
XML Namespace Bindings: A special report, which can be generated only once.
-
Index: An alphabetic list of all documented components
(presented only by their local names without namespace prefixes)
with the links to the corresponding documentation.
With the parameters in this group you can specify which of those blocks will generated and,
in case of WSDL definitions/XSD components, for which types of them.
What exactly is included in every of those blocks you should specify in the "Details" parameter group.