Nidium's WebIDL Specification

Nidium WebIDL spec

Status: first draft Date: 2016-12-22

This document defines the adaptation to the WebIDL spec as that is (going to be) used in nidium.

Specificion

The current WebIDL (Editor's Draft, 25 January 2017) from the W3C will be used as a guide line.

Deviations

For a good traceablity and understanding it is essential that these deviations are documented thoroughly. For each deviation the following entries are needed:

• The (short) description.
• The validity range (version/since from/to).
• The rational of why this deviation is needed and why it deviates from the spec.
• The impact that it might have on the code/generation.

Any deviation that are used will be documented in the following pages:

• None

Extended attributes

The specification forsees the use of extended attributes. For a good traceablity and understanding it is essential that these attributes are documented thoroughly. For each attribute the following entries are needed:

• The name.
• The validity range (version/since from/to)
• The scope of its usage ('Interface', 'Operation', 'Attribute', ...).
• The allowed values.
• The default value: (what happens what this attribute is not set).
• A reference to the documentation or the 'JSXXX' class where this is used in practise.
• A minimal of one example of the IDL code and how this will be transformed into cpp code and its usage in JS code. It must be clear from the examples what happens when this attribute is set to a certain value or is not set at all. In some situation it is wise to present a relavant piece of template code as well.

Any extended attributes that are used will be documented in the following pages:

• on Interface

  • classname
  • headerfile
  • exposed
  • implementedas

• on Attribute

  • None

• on Operation

  • alias