You are here: Interface Components > File Menu
Other Interface Components
Doc-O-Matic Tools
Messages
> New Project Wizard
New Project Wizard
Close
Doc-O-Matic 10
New Project Wizard

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. 

 

Welcome
  • In the Title box, enter the name of your project. The project title appears in several locations of the generated documentations. It should be short (no longer than 128 characters) and meaningful.
  • In the Filename box, select a .dox file to save your new project. For making project paths independent of installation paths of other used files, see Path Macros.
  • To create a separate folder for your project, select the check box.
  • In the Create In box, enter an output folder for your created documentation.

 

Project Template

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

 

Project Files

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.

  • Click Add to add your files and Remove to omit them again. For more information about adding other types of files to your project, see Adding Other File Types.

 

Documentation Options

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.

  • Comments: The comment location option defines where the comments in your source code are located with respect to source code symbols (eg. function-, class- or member declarations). Comments can be located either before or after a symbol.
  • Tokens: Some documentation systems (such as Javadoc) use special tokens in front of each comment to distinguish documentation comments from ordinary comments. If you are using tokens enter them in the text field.
  • If your source is not described yet click Next.

 

XML Doc/Javadoc Support

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. 

 

Sections

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.

  • Select those sections that you use in your comments and make sure that in the Starters box the words you use to start these parts are listed.
  • If not already listed, enter your starters in the Starters box.
  • If you do not structure your comments select the section in which you want your comments to appear (for example remarks or description), and then click Set Default. For more information about setting up your own sections, see Editing and Creating Sections.
    Note: Doc-O-Matic recognizes starter strings only if they are the first string in a comment line (only walls and tokens can be placed in front of them). Starter strings have to be on a separate line or they have to be separated by the following section text by a section delimiter. To make Doc-O-Matic recognize your section delimiter or to allow also spaces as section delimiters set the options on the Section Delimiters page.

 

Editor

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.

Note: Only the plain text format (DTX) supports all Topic Editor features.
 

Translation Options

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 the Output Language list, select the output language that you want to use.
  • If you would like to use an other language, you need to create your own translation on the [General Settings] > General > Translation page.

 

Advanced Settings
  • The default template topic file contains template topics that you can use as template for your topics.
  • Doc-O-Matic supports C/C++ macro expansion and ships with a standard macro file that defines many of the commonly used macros in the ATL, MFC, OWL and VCL libraries. If you use one of these libraries we recommend to use the standard macro file because it makes Doc-O-Matic better understand the structure of your sources.

 

Link Databases

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.

Note: You can only link to these libraries from Help that is in the same format like the library Help system.
 

Finish

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.

Copyright © 2000-2020 toolsfactory software inc. All rights reserved.