Documentation Generator Messages

Documentation Generator can generate two types of messages:

Messages which appear while DG commands are carried out (run-time error messages), and error and warning messages generated by DGML functions for accessing DAC project data (run-time error and warning messages);

Messages generated by the documentation template analyzer (compile-time error and warning messages).

Run-Time Error Messages

Error messages which appear while DG commands are carried out are displayed in Message Boxes. The following error messages can be generated while DG commands are carried out:

Cannot save the template <Template Name>. The template exists and is marked Read-Only. Save the template under another name or in another location.

where <Template Name> is the name of the template.

The message is generated while the Documentation/New Template command is carried out if the name of the new DT is identical to the name of an existing DT whose status is "Read-Only". The message is displayed in the Message Box (OK).

Do you want to replace the existing <file name>?

where <file name> is the name of the file overwritten by DT.

The message is generated while the Documentation/New Template command is carried out if the name of the new DT is identical to the name of an existing file on the disk. The message is displayed in the Message Box (Yes, No, Cancel).

Wizard will add block inside other DGML script in active template.

The message is generated while the Documentation/Add to Template command is carried out if the insertion point in the active DT is positioned within the DGML script. The message is displayed in the Message Box (OK, Cancel).

Wizard will replace selection in active template with script block.

The message is generated while the Documentation/Add to Template command is carried out if a block is marked in the active DT. The message is displayed in the Message Box (OK, Cancel).

Active template does not exist.

The message is generated while the Documentation/Add to Template command is carried out if none of the DTEs has been started. The message is displayed in the Message Box (OK).

Cannot execute the function <Function Name>. - Invalid value of Options parameter.

where <Function Name> is the name of the function whose call has caused a break in documentation generation.

The message is generated while the Documentation/Generate command is carried out when the Options parameter of the function call script interpreted is found to have been illegally altered. The message is displayed in the Message Box (OK).

Cannot execute the function <FunctionName>. - Object <ObjectName> does not exist .

where <FunctionName> is the name of the function whose call has caused a break in documentation generation, and <ObjectName> is the name of an object which does not exist in the project.

The message is generated while the Documentation/Generate command is carried out when the function call script is interpreted, and the list of input parameters contains the name of an object which does not exist in the project. The message is displayed in the Message Box (OK).

Out of memory.

The message is generated if the computer has run out of RAM memory while documentation was generated. The message is displayed in the Message Box (OK).

Run-Time Error and Warning Messages

DGML functions for accessing DAC project data may be unable to arrive at the appropriate result and then, error messages are displayed in the generation phase. Functions that get pictures or insert text into the generated document most often report warnings – messages that do not stop generation, but do not result in any output in the generated document. Other functions usually stop generation – and report fatal error messages.

Warning 600: Error on opening file [...] The function has not been able to open the file because the file with the name specified has not been found, it could not be opened, or for some other reasons.

Warning 601: Function [...] not found The function [...] was not found during the project symbol analysis, therefore it was not found while being used in the DG.

Fatal 605: Symbol [...] not found. The symbol [...] was not found during the project symbol analysis, which is why it was not found while being used in DG.

Fatal 606: Symbol database not built.
Since updating symbol database is automatically carried out before every generation, this message is reported only in case symbol database could not have been built.

Fatal 607: File is not in the database: [...] Specified module is not in the database. The file does not exist or it is not in the project.

Fatal 608: Invalid File type : [...] Specified module is not of source type.

Fatal 610: Invalid file path: [...] Incorrectly specified file path.

Fatal 611: Invalid folder path: [...] Incorrectly specified folder path. 

Warning 620: Invalid ObjType parameter The ObjType parameter of the GetMetricsReport and GetAllMetricsReports functions can have only certain values. 

Fatal 625: Group [...] not exists The graph group [...] is not defined in the project specified.

Fatal 626: View [...] not exists The graph view [...] is not defined in the project specified.

Warning 627: Cannot restore Call-Hierarchy Graph of [...]
The Call hierarchy graph cannot be restored
on the basis of the parameters specified in the function GetCallGraph. This warning appears in case the object for which the Call Hierarchy graph (function, view, group) is being made is not defined in the project

Warning 628: Cannot restore Type-Hierarchy Graph of [...]
The Type hierarchy graph cannot be restored
on the basis of the parameters specified in the function GetTypeGraph. This warning appears in case the type for which the Type Hierarchy graph is being made is not defined in the project.

Warning 629: Error creating Call Hierarchy Graph of [...] - <Error description>
The Call Hierarchy graph cannot be created due to a system error - such as lack of memory or resources. The description of the error is given in the warning <Error description>.

Warning 630: Error creating Type Hierarchy Graph of [...] - <Error description>
The Type Hierarchy graph cannot be created due to a system error - such as lack of memory or resources. The description of the error is given in the warning <Error description>.

Warning 633: Cannot restore Flowchart for [...]

Warning 636: Version Control System is not selected

Fatal 637: Version Control System is not selected

Warning 638: Selected Version Control System doesn't support [...] function
Some VCS systems do not support the InsertVCSDifference functions, i.e. InsertVCSHistory, so, with them, these DGML functions do not produce results.

Compile-Time Error and Warning Messages

Error messages and warning messages generated by the documentation template analyzer are displayed in the Documentation Generation tab of the DAC Message dialog box. The messages contain the name of the DT in which the error has been found, the ordinal number of the script in the DT where the error is located, the error identifier and the message text. The error identifier is a three-digit constant beginning with the character "5". The message text provides a brief explanation of the nature of the error.

There are three types of errors detected by the DT analyzer:

Fatal errors - critical errors in DGML directives. Such errors make it impossible to proceed with the analysis of the current directive.
Errors - errors which prevent DT interpretation, but which do not obstruct further directive analysis.
Warnings - warnings point to problems in the DGML script which can be disregarded.

If the documentation template contains errors of the first or second type, you cannot start generating documentation.

The DT analyzer can generate the following error and warning messages:

Fatal 501: '(' expected The message is generated if the "(" character is missing from the DGML directive entry.

Fatal 502: ')' expected The message is generated if the ")" character is missing from the DGML directive entry.

Fatal 503: file name expected The message is generated if the name of the documentation template is missing from the Include directive, or the name of the output file is missing from the target_document directive.

Fatal 504: logical expression expected
The message is generated if there is no condition in the if or else_if directive.

Fatal 505: variable name expectedThe message is generated if:

1. The name of the cyclic variable has not been entered in the header of the for directive;

2. The name of the list according to which iteration is carried out has not been entered in the header of the for directive; or

3. The figure identifier has not been entered in the header of the image directive.

Fatal 506: 'in' keyword expected The message is generated if the keyword in is missing from the header of the for directive.

Fatal 507: expression error The message is generated if the second operand is missing from a binary operator expression or an operand is missing after the "!" operator.

Fatal 508: symbol [...] not expected The message is generated if the symbol assigned unexpectedly appears.

Fatal 509: '}' expected The message is generated if the "}" character is missing at the end of a constant collection.

Fatal 510: constant expected The message is generated if a constant is missing after a comma in a constant collection.

Fatal 511: collection expected The message is generated if the name of collection is missing from a for_each directive or a Count function call.

Fatal 512: color format specification expected
The message is generated if the image color specification ( COLOR or GRAYSCALE ) is missing from the ColorFormat function call.

Fatal 513: border format specification expected
The message is generated if the border format specification ( BORDER or NOBORDER ) is missing from the BorderFormat function call.

Fatal 514: ',' expected The message is generated if the "," character is missing.

Fatal 515: integer-type expression expected
The message is generated if segment width or height is missing from the FormatAsMosaic function.

Fatal 516: '}#' ( end-script marker ) expected
The message is generated if the end-script marker is missing.

Fatal 517: unexpected '}#' The message is generated if the end-script marker appears, and the marker indicating the beginning of the script has not been entered.

Fatal 518: DT [...] cannot be opened. The message is generated if the DT entered cannot be opened.

Fatal 519: invalid file name [...]The message is generated if the DT entered does not exist, or the GD path (in the target_document) directive has not been entered correctly.

Fatal 520: DT [...] is not in Rich Text Format
The message is generated if the DT entered is not in RTF format.

Fatal 521: unfinished comment The message is generated if the end of comment marker is missing in DGML script.

Fatal 522: unfinished string constant
The message is generated if the end of string constant marker is missing.

Error 523: Generated Documents Directory is not valid
The message is generated if the directory in which generated documents are written and which is defined in the DGOptions dialog box in the Directories tab does not exist on the disk.

Error 524: Documentation Templates Directory is not valid
The message is generated if the directory in which documentation templates are located, and which is defined in the DGOptions dialog box in the Directories tab does not exist on the disk.

Error 525: Options cannot be decrypted
The message is generated if the entry encrypted argument options has been incorrectly changed, in which case decrypting the argument is not possible.

Error 526: Recursive including is disabled
The message is generated if a DT is directly or indirectly included in the same DT.

Error 527: Structure required on left side of '.' operator
The message is generated if the variable entered to the left of the '.' operator is of the non composite type.

Error 528: Collection required in for directive
The message is generated if in the for directive header a variable of a type other than TCollection appears instead of the collection according to which iteration is carried out.

Error 529: Image-type variable required in image directive
The message is generated if a variable of a type other than image has been entered in the header of the image directive.

Error 530: Expression in the script is not of the simple type
The message is generated if an expression in the script is of a type other than simple ( string, int, float or date ) because only simple-type values can be built into GD.

Error 531: [...] is not a member of structure [...]
The message is generated if the structure to the left of the '.' operator does not contain a member entered on its right.

Error 532: invalid data type in expression The message is generated if invalid type operands appear in the expression.

Error 533: variable [...] is undefined The message is generated if a variable whose value has not been defined is used.

Error 534: no image in the image blockThe message is generated if there is no image within the image block (between the begin_image and end_image directives).

Error 535: more then one image in the image block
The message is generated if there are multiple images within the image block (between the begin_image and end_image directives).

Error 536: Directive [...] not expected The message is generated if any of the following appearsv:
1) the else, else_if or end_if directive, without a preceding if directive;
2) the end_for directive, without a preceding for directive;
3) the end_target_document directive, without a preceding target_document directive;
4) the end_image directive, without a preceding begin_image directive.

Error 537: [...] directive missing The message is generated if any of the following directives is missing: end_if, end_target_document, end_for, or end_image.

Error 538: collection cannot contain elements of different types
The message is generated if different type constants appear in the same constant collection.

Error 539: non-simple type expressions compared
The message is generated if structure type expressions are compared in a relational expression.

Error 540: invalid parameter <K> type The message is generated if the k-th parameter in the function call is of an invalid type.

Error 541: parameter <K> cannot take specified value
The message is generated if an invalid value has been entered in place of the k-th argument in the function call.

Error 542: [...] does not have <K> arguments
The message is generated if the number of arguments entered on function call does not correspond to the actual number of arguments of the function.

Error 543: function [...] does not exists The message is generated if the call of a function not defined in DGML has been entered.

Error 544: variable expected in place of <k>-th argument
The message is generated if no identifier has been entered in the function call in place of the output argument (the <k>-th function argument).

Error 545: opened image block already exists
The message is generated if a new begin_image directive appears within the image block (between the begin_image and end_image directives).

Error 546: SegmentRow and SegmentCol functions cannot be used outside of an image_block

The message is generated if either the SegmentCol or SegmentRow function is called outside the image block.

Error 547: SegmentRow and SegmentCol functions cannot be used if the image is not formatted as a mosaic

The message is generated if either the SegmentCol or SegmentRow function is called in the image block which defines that an image not formatted as a mosaic be built in.

Error 548: figure within the image-block is not in EMF format
The message is generated if an image of a format other than EMF appears within the image block (between the begin_image and end_image directives).

Error 549: error in date-type constant entry
The message is generated if an impossible date type constant appears.

Error 550: cycle variable cannot be changed within loop body
The message is generated if the value of a cycle variable is redefined within loop body.

Error 551: expression on the right side of assignment is not rvalue.
The error is reported if a function call which does not produce any result appears on the right side of an assignment.

Warning 552: variable [...] is assigned a value that is not used anywhere
The message is generated if value is assigned to a variable in the DT, and the value is not used anywhere.

Warning 553: not all files have been saved. Generated documents may not have been updated.
The message is generated if documentation generation is started, and some of the files opened in the editor have been changed but not saved.

Warning 554: database is not updated. Generated documents may contain old data.
The message is generated if documentation generation is started, and the option "Update database before generating" from the Generating tab of the Documentation Generator Options dialog box is disabled.


Copyright 1993-2017, RistanCASE GmbH