When creating an AdeliaDoc project, a configuration file called "adeliadoc.ini", is automatically generated in the project root.

This file contains a certain number of parameters which are primarily intended for customizing the default generation rules applied by AdeliaDoc to produce the documentation.

These rules largely influence the way AdeliaDoc uses the annotations added to the 4GL source by the developers.

Therefore, and according to your requirements, by adjusting these configuration parameters, you can customize the way the documentation is generated on a project-by-project basis.

Notes

When it is created, the configuration file is initialized with all the sections and parameters supported by AdeliaDoc.
As standard, no value is assigned to these parameters, which corresponds to the default behavior as described below (see description tables below).
When the value entered for a parameter is invalid, the default value applies.
The configuration file is encoded in UTF-8 without BOM.
When making changes, ensure that the encoding is UTF-8 by using an appropriate text editor.

Summary table of configuration parameters

The AdeliaDoc configuration file is in the standard form of a Windows® .INI file.

Section	Parameter	Role
Rule	`exclude_annotations`	Exclusion rule to apply to certain annotations entered in the 4GL source.
	`date_annotation`	Interpretation rule for the annotation `*@date`
	`index_procedure`	Index generation rule for a procedure section
	`index_generation`	Index entry generation rule
	`default_filter`	Default filter definition
Substitution	`@desription`	Substitution rule to apply to the annotation`*@description`
	`@date`	Substitution rule to apply to the annotation `*@date`
	`@version`	Substitution rule to apply to the annotation `*@version`
	`@author`	Substitution rule to apply to the annotation `*@author`
Localization	`date_sep`	Date separator configuration
Localization	`date_format`	Date format configuration

↑ Top of page

Detailed description

Rules section

This section includes the parameters used to configure the main documentation generation rules.

exclude_annotations parameter

Description	List of annotations (separated by the "`;` character") to exclude from the documentation, even if these are explicitly presented in a 4GL source (program/procedure). For example, for documentation destined for the general public, this parameter can be used to not include the names of the software engineers in the generated documentation, without changing anything in the program source code.
Possible values	For programs and procedures: all supported annotations apart from `@adeliadoc`, `@param` and `@field` For classes: apply to the metadata corresponding to annotations `@description`, `@date`, `@version`, `@index` and `@author`
Default value	Empty (i.e. no exclusion)
Example	`exclude_annotations = @author;@since`

date_annotation parameter

Description	If the `*@date` parameter is present and contains a value, it forces the way the annotation is used by the generator. The aim is to force the substitution of the annotated date by the corresponding metadata stored in the database (i.e. last program modification date as defined in the program information).
Possible values	`meta` : forced metadata `default` : default behavior: the value associated with the annotation is used, or the defined substitution rule is applied.
Default value	`default`
Example	`date_annotation = meta`

index_procedure parameter

Description	Manages the way a procedure section index is generated if the `index_generation` parameter is set to entity, mixed or cumulative and the procedure does not contain an `*@index` annotation. In this configuration, the parameter is used to determine if the index must be defined hierarchically (in relation to its program) or have its own entry.
Possible values	`subentry` : the procedure index is defined hierarchically in relation to its program (subentry). The hierarchy is represented in 'program name/procedure name' form. `entry` : the procedure has its own index entry which has the procedure's name.
Default value	`subentry`
Example	`index_procedure = entry`

index_generation parameter

Description	Manages documentation index generation linked to the `@index` annotation. Depending on the parameter value, you can tell AdeliaDoc to: not generate an index page, generate and compile the index page based on the `@index` annotation, or automatically generate and create the index page based on the name of the sections (i.e. program/procedure).
Possible values	`annotation` : the index is exclusively created from `@index` annotations. Entities without an `@index` annotation are not, therefore, included in the index page. If the annotation is present but has no value entered, the section name is used as an index code. `entity` : even if the `@index` annotations are entered, the index is automatically created based on the name of the sections. All the sections are included in the index page. `mixed` : the index is created from `@index` annotations or based on the name of the sections if the `@index` is not entered. All the entities are included in the index page. `cumulative` : multiple index entries, accumulating the name of the corresponding section and the `@index` annotations (if present). `none` : the index page is not generated.
Default value	`mixed`
Example	`index_generation = cumulative`

default_filter parameter

Description	Configures the behavior of the documentation generator when AdeliaDoc is started without the `filter` command line being completed. In this case, the parameter forces an implicit filter. If the `filter` command line parameter is entered and valid, this configuration parameter is ignored.
Possible values	The possible values are the same as those in the `filter` command line parameter.
Default value	No filter: all the sections are generated without taking into account the presence and content of the `*@adeliadoc` annotation.
Example	`default_filter = *NONE`

Substitution section

This section is used to configure the substitution rules to apply for annotations which have not been entered or which do not contain a value, meaning that usage standards can be established for these annotations.

It includes one parameter per annotation concerned by the substitution rules, namely:

@description for the annotation *@description
@date for the annotation *@date
@version for the annotation *@version
@author for the annotation *@author

The description table below applies to all the parameters in this section.

Substitution rules

Description	Defines the way substitution by the corresponding metadata is performed when the annotation in question is not present or has no value entered.
Possible values	`empty` : substitution by the metadata is only performed when the annotation is present but has no value entered. `default` : substitution by the metadata is only performed when the annotation is absent or has no value entered.
Default value	`default`
Note	Metadata comes from program information as it is stored in the database.
Examples	`@date = empty` `@author = default`

Localization section

This section includes all the parameters relating to customizing regional options.

date_sep parameter

Description	Date separator to use
Possible values	A single character of the user's choice
Default value	Value defined in the Windows® session's regional options.
Example	`date_sep = \|`

date_format parameter

Description	Date retrieval format for dates from metadata stored in the database
Possible values	`DMY` : day, month, year `MDY` : month, day, year `YDM` : year, month, day
Default value	Value defined in the Windows® session's regional options.
Example	`date_format = MDY`