Applications

spy.doc is provided as three separate applications:

Main Application

This application is a .NET 2.0 Windows Forms application which does not display a window. Its purpose is to accept various command line parameters, and to execute either the Windows, or the Console application, depending on the specific command line parameters. Once this is done the application quits. It provides the function of a single entry-point launcher application for the selective execution of either the Windows or Console application. See the following section for more information:

• Operation - Main Application.

Windows Application

This application is a .NET 2.0 Windows Forms application and and provides a simple and intuitive user interface to enable you to load, configure and save spy.doc project files, and generate the documentation with a click of a few buttons. The application main window provides two tabbed views:

• Project Options Window, where you can modify project options, and the
• Generation Log Window, which logs the progress of documentation generation, and any errors or exceptions.

The application operation is detailed in this section:

• Operation - Windows Application.

Console Application

This application is a .NET 2.0 Console application that accepts a command line parameter specifying the spy.doc project to use to generate documentation. The application will then generate documentation using the settings in the specified project file. The spy.doc project can be configured using the Windows application, or it can be easily edited using a text editor.

The application operation is detailed in this section:

• Operation - Console Application.

Generation Log

The application generation process logs generation progress and generation errors. In the Windows application, this information is displayed in this section:

• Generation Log Window.

In the Console application, this information is displayed as standard console output.