You
can reach this dialog box by selecting the ‘Generate HLP item’ in the
‘Utils’ menu bar.
This utility proceeds in several steps. The first is to
decide which files should be included in the technical documentation. Use only
.C files.
|
|
You
can reach this dialog box by selecting the ‘Generate HLP item’ in the
‘Utils’ menu bar. |
The 'Title' entry field should contain the title that will appear in the help file being generated.
The 'Help file name' field should contain a file name with the .HLP extension. The result from compiling an intermediate RTF file (for Windows) or IPF file (for OS2) generated by Wedit will be stored here.
To add a file to the list, click on the 'Add' button; to delete a file from the list, use the 'Remove' button.
The generated file has two main levels:
A file level, where the index will show all the C sources included during the compilation. If the file, as is often the case, begins with a commentary, this comment will be included here. At this level, you will find all of this file’s global variables, as well as all variables declared as 'extern'. In general, all symbol definitions (excluding preprocessor symbols) appearing at global level will be here.
A function level, where each function defined in the file is listed, with any comment that immediately precedes the function. This includes, of course, the special editor maintained commentaries.
A 'data structures' level, where all structures defined in the source files and their associated include files are listed. Wedit assumes that the files are related and does not list two structures that have the same name.