The New Project Wizard helps you creating a new project for your source documentation very quickly and sets up the basic options of your new project. The Wizard consists of 12 easy steps.
You can choose from several templates that follow Help styles of popular IDEs or you can select a template for writing the release notes for your software. To create a project using the factory default settings select Default.
This step allows you to add source and topic files to the project. You can add development projects (Developer Studio (.dsp file), VS.NET, Delphi (.dpk and .dpr files), C++Builder (.bpk and .bpr files) and Solution files) and individual files (C++, C++.NET; VB.NET, C#, Java, JavaScript, ASP.X, JSP, MATLAB and Delphi) and textfiles (.txt), HTML, XML and .dtx files.
Documentation options need to be set correctly so that Doc-O-Matic can successfully identify the source code documentation in your source files. When in doubt, do not change these options.
If you use XML C# comments or Javadoc tags (@@ or \) to describe your code turn on the support for these comment styles on this screen. Now, Doc-O-Matic understands most of the standard tags of these comment styles.
Usually your comments will consist of descriptions, remarks, see also links, parameter descriptions and summaries. In Doc-O-Matic these parts of your comments are called sections. In the list you find all predefined sections that Doc-O-Matic offers.
On this screen you can specify how the Doc-O-Matic Topic Editor inserts comments written in the Topic Editor into your source files. If you store your comments outside your code this option does not effect the behavior of the Topic Editor.
In the generated outputs Doc-O-Matic inserts several words to structure your documentation (for example member, methods, variables). Doc-O-Matic uses symbol names that are used in your source files. Describing your code in another language you probably would like to use native language words for symbols and use localized graphics for contents etc.
In Doc-O-Matic you can use link databases to link to other Doc-O-Matic projects easily. In addition, Doc-O-Matic includes several prepared link databases that allow cross linking to Help of popular libraries. On this screen you can add prepared link databases to your project. If these link databases are available in your project Doc-O-Matic automatically links to the corresponding Help topic of library Help systems each time you use the name of a symbol of this library.
This is the final step. It shows you an overview over the settings you have made. If you click Finish, Doc-O-Matic will close your current project (it has already been saved if it was modified) and create a new project with the settings and source files you have chosen. After this the source files will be parsed. This can take between seconds and minutes, depending on how many files you have added to your project and how many include files are included by these files.