Description of the diagnostic files.

dHelp outputs different diagnostic information during generation of the help file. This information is categorized and saved to the files with LOG extension.

These project file fields customize the diagnostic information generation:

1. Field CreateLogFiles defines whether diagnostic information will be generated. By default dHelp generates all diagnostic files. If CreateLogFiles flag is set, dHelp clears the contents of all log files before compiling the project.
2. Field LogFolder specifies folder where files with diagnostic information will be created.

dHelp creates the following report files:

• dh_BadLinks contains information about references that cannot be solved.
• dh_Compiler contains messages generated by HTML Help Workshop during compilation of the CHM help file.
• dh_NoBodyDesc contains topics that have empty brief description part.
• dh_NoBriefDesc contains topics that have empty primary description part.
• dh_NoDescTopic contains the list of not described topics.
• dh_ValidSize contains the effective size of the topic descriptions.

Bad links report (dh_BadLinks.log)

The possible messages are:

1. "<ref_topic>" not found
      (referenced by "<topic>")

This message alerts about errors in the topic aliases. Error occurs when the right part of the '<topic1=topic2>' expression was not found. Message has the following parameters:

• <ref_topic> indicates unknown topic (topic2).
• <topic> contains name of the topic where error occurs (topic1).

Example:

"TDCWeekDay" not found (referenced by "TDCFirstDayOfWeek")

Solution:

• First, you must check whether the referenced topic exists in the source code units. If you can't find it, change the reference to the right one.
• If topic exists in the source code units, you must check whether this topic is described in the description file. If referenced topic is not described, change the reference to the described topic or write new description for that topic.

2. "<ref_topic>" topic not found in source
      (referenced by see also of "<topic>")

This message reports about errors with items listed in the See Also section. Error message is included when referenced item cannot be found among source code topics. Message has the following parameters:

• <ref_topic> indicates name of the failed topic.
• <topic> marks the topic name where bad reference was found.

Example:

"TDCFltBld.OnSaveToStream" topic not found in source (referenced by "TDCPrmListBox.OnSaveToStream")

Solution:

• You must check whether referenced topic exists in the source code units. If you can't find it, change reference to the right topic name or exclude it from the See Also section

3. "<ref_topic>" description not found
      (referenced by see also of "<topic>",
       found as topic "<ref_found_topic>"

This message reports about errors with items listed in the See Also section. This error message is reported when referenced topic cannot be found among described topics but it is an element of the parsed source code units (class, property, procedure, etc.). If topic is a class member (property, method or event) dHelp always tries to fix failed topic link by searching it among members of all parent classes. Message has the following parameters:

• <ref_topic> indicates name of the failed topic.
• <topic> marks the topic name where bad reference was found.
• <ref_found_topic> contains the full name of the topic as it was found in the source code.

Example:

"OnGetLookupDef" description not found (referenced by see also of "TDCPrmListBox.GetParamLookupDef", found as topic "TDCPrmListBox.OnGetLookupDef")

Solution:

• Check whether referenced topic has valid description. It is possible that referenced topic is not described.
• If reference topic has description you must check whether this topic is mentioned in the IgnoreTopics section of the project file. If you find it there then you can remove all references to it.

Compiler output report (dh_Compiler.log)

This file contains messages written by HTML Help Workshop during compilation of the CHM help file. Program intercepts all messages generated by compiler for the currently generated help project and stores them in the dhpFH_Compiler.log file. You can use this information to validate created help file.

Note: dhpFH_Compiler.log file is empty after generating help in the HLP format.

Example:

Not complete description report (dh_NoBodyDesc.log and dh_NoBriefDesc.log)

These files list topics that are partially described. In description section each topic must have brief and primary descriptions (see description files for the additional information). If one of the description parts is absent, dHelp notifies user about this error through dhpFH_NoBriefDesc.log and dhpFH_NoBodyDesc.log files. File dhpFH_NoBriefDesc collects topics that have empty brief description part. File dhpFH_NoBodyDesc collects topics that have empty primary description part.

Both files have the same structure:

<Description_file_name_1>
   <Failed_topic_11>

   <Failed_topic_12>

   ...

<Description_file_name_2>
   <Failed_topic_21>

   <Failed_topic_22>

   ...

where

• <Description_file_name> is a file with descriptions where partially described topic was found.
• <Failed_topic> - topic name that have incomplete description.

Note: Files where all topics have right and complete descriptions are not listed.

Example:

Solution:

• Fill in all parts of the description for all mentioned topics.

Not described report (dh_NoDescTopic.log)

This file contains the list of topics that are not described. By default program don't include topics without description. Project file has field IncludeEmptyTopics where you can specify whether to include empty topics in the help file or not.

Note: When IncludeEmptyTopic flag is set dhpFH_NoDescTopic.log file will not contain any items.

Topics in the not described report are listed in the alphabetical order using their full name:

• Global procedures and variables are preceded with the module name where they are declared.

• Members of the class are preceded with the class name.

Note: You can include topics from this file directly into the Topics section of the project file.

Example:

Solution:

• Fill in descriptions for all listed topics. If you have no description frames for these topics, copy topics list to the Topics section of the project file and run dHelp with command f to generate empty topic description frames.

Performance report (dh_ValidSize.log)

Contents of this file represents the effective size of the topic descriptions. dHelp calculates all valid characters (Latin letters and numbers) found in brief and primary description sections and stores this information in the dhpFH_ValidSize.log file. Only topics that were successfully imported are taken into account.

Program divides total size by files with descriptions and presents this information in the following format:

In module <description_file_name>
   useful symbols are: <total_module_size> (<total_module_size_in_KB> KB)

where

• <description_file_name> - contains full name of the file with topic descriptions.
• <total_module_size> - the effective size of descriptions for topics included into the mentioned file.
• <total_module_size_in_KB> - the effective size in KBytes of descriptions for topics included into the mentioned file.

At the end of the file dHelp inserts the total effective size for all included topic descriptions. The format of the message is:

In all files useful symbols are : <total_size> (<total_size_in_KB> KB)

where

• <total_size> - shows the effective size of descriptions for all successfully imported topics.
• <total_size_in_KB> - shows the effective size in KBytes of descriptions for all successfully imported topics.

Example: