#55 Integrate program documentation into SASUnit

[Andreas Mangold]

Currently, program documentation is being generated with Doxygen in a completely separate process, although the look and feel of the reports is very similar (due to the fact that visual elements from Doxygen have been used in SASUnit reporting). Doxygen is used for comment extraction (see example) and formatting of source code listings for the report creation (see example).

To have source code documentation and test documentation in one report would help somebody who has to make himself familiar with a set of programs. Syntax highlighting should be added to the source code listings. On the other hand, it should still be possible to generate only source code documentation or only test documentation.

The use of Doxygen should be no longer necessary and comment extraction and formatting of source code listings should be accomplished by SAS programs.

The following is a rough outline of the necessary steps to integrate source code documentation into SASUnit:

• In order to adhere to the general design principles of SASUnit (see [#10] and [#11]), programs (test scenarios and test candidates) should be copied to a test case specific subdirectory of the tst folder during execution of the test scenario.
• A separate step in the reporting framework extracts comments from the programs in the tst folder, formats the code documentation elements and the source code listings.
• For rendering of the source code listings, a solution for syntax coloring would be very welcome.
• Rendering depends, as always, on report format. For HTML, an additional tab could be placed on top of the pages for the test scenario and the test candidate (for enhancement of HTML reports see also [#13], [#14]). For print oriented output formats, the source code has to be inserted as an additional section at an appropriate position of the document.

[Klaus Landwich]

Functionality is implemented and reveised in last SASUnit meeting