Top Document Structure

Top Structure

DocJet generates documentation from source code. It is convenient to have an overview description that summarizes the project/product/APIs you document. The top page also refers to all the generated source code documentation. Normally, the top page is located at the top of your development structure.

Figure blow shows an example of a top structure file, to be used from a web browser.

You can generate these pages using the TopJet application and templates placed in WinSDE_HOME/Forms/TopDoc directory. By using TopJet you avoid manual creation and updating of the top page.

The figure below shows the TopJet application:

TopJet.gif (11109 bytes)

Using TopJet you can: