Creating enriched documentation

It is possible to enrich the model with relevant documentation, which will be used to produce the documentation associated with your model in the md file generated by opcua-modeler.

Each node added to the model can have a description attribute to contain a description as detailed as you wish.

• description can be a simple sentence that will appear in the description attribute of the OPCUA node created in the address space.
• description can also be a long text in markdown format. In this case, the first line of text will be used to populate the description attribute of the OPCUA node and the following text will be added to the auto-generated online documentation in the markdown file produced by the generator.

    browseName: Calibrate
    description: |
        Initiate the calibration of the sensor. This line will go into the `description` attribute of the OPCUA node.
        The rest of this document is a markdown 
        text that contains the long description of the node in question.

        The Calibrate method initiate the calibration of 
        the **temperature sensor** on the physical device.
        This method takes __two__ arguments that define 
        the linear interpolation `T = A*x + B`.
        |key  | value|
        |-----|------|
        | A   | B    |