20. DocExporter

This chapter may be outdated.

The DocExporter exports JavaDoc from source files to adoc files. In particular it combines information about methods with tests in order to create specification documents.

20.1. Specification Exporter

The specification exporter creates and merges artifacts. Fig. API Test Spec sketches the relation between API (i.e., n4jsd files with classifiers), tests (i.e., N4JS test classes and methods), and specification (Documentation with JSDOC markers).

api test spec
Figure 52. Component/Class pseudo diagram: Relation API, Tests and Specification

Fig. Exporter shows the classes that read and analyze Java source documentation.

cd jsdocreader
Figure 53. Java reader classes

Fig. Exporter shows the content classes of the exporter that contain the generated documentation contents.

cd adocexporter
Figure 54. Exporter content classes

Fig. DocExporter Model shows the model, which may be used for other doc exporters as well.

cd docexporter model
Figure 55. Exporter model classes