How to Control ASCET-DEVELOPER Documentation

This page explains how to exclude packages and include nested class documentation in ASCET-DEVELOPER models.

Excluding Packages for ASCET-DEVELOPER

In the workspace of an ASCET-DEVELOPER project, block diagrams are organized by means of so-called packages. When the EHANDBOOK documentation is generated for such models, the content for certain Class Instance blocks should not be included in certain cases. Typical cases are:

  1. a Class Instance is of a library type Class where details are not required to understand the meaning of the block

  2. a Class Instance block contains details which are subject to know-how protection

In the corresponding interactive model, such Class Instances should then be non-expandable such that no details are exposed, and subsequently the textual documentation for the sub blocks of that Class Instance block need to be excluded from documentation as well.

Excluding packages also have s significant improvement on RAM consumption and generation time during the Container-Build.

In order to achieve this, EHANDBOOK Container-Build offers an optional command line argument -ascetdeveloperexcludepackages. The CLI argument must point to the path of a configuration file in JSON format that contains the list of ASCET-DEVELOPER packages to exclude from document generation.

{
	"packages": [
		"packageX",
		"packageA.packageB"
	]
}

See sample ExcludePackages.json in the sub folder .\examples\configuration of your EHB-CB installation directory.

In case of nested packages, fully qualified name of the package separated by "." (DOT) needs to be provided.

Documentation for Nested Classes in ASCET-DEVELOPER

In order to achieve this, EHANDBOOK Container-Build offers an optional command line argument -ascetdevelopernestedclasses.

Depending on the usage of nested classes, this option can lead to significant increase in EHANDBOOK generation time as each class instance gets documented at the place where it is used.