File Docs

File Docs are a way of commenting a file to provide metadata to the system. This metadata will be used by XJDeveloper when adding this file as an additional code file.

A File Doc entry is defined by a block of text in double-slash-exclamation comments anywhere in an XJEase file and is made up of a series of tags. To aid with files' layout, empty lines may be included (and will be ignored except in @copy tags). The first tag in any file may be preceded by any desired explanatory text (which will also be ignored) as per the example below.

The following tags can be used:

@bus

Defines a bus to create in the test device file.

@configvariable

Defines a configuration variable to create in the test device file.

@copy

Specifies a block of text to copy as code into the test device file.

@requires

Specifies another additional code file that should be assigned to the test device file.

Example

//! This is the start of some example File Docs.
//!
//! @bus SCL
//! @bus SDA
//!
//! @configvariable MyVariable @type integer @defaultvalue 42 @displayname My Variable 
//!   @description Demonstration variable
//!
//! @copy Some text
//!