From RTSC-Pedia

[printable version]  [offline version]

offline version generated on 04-Aug-2010 21:08 UTC

XDCspec - @Opaque

This structure's fields are not publicly documented

This attribute is only applicable to structures. If this attribute is specified for a structure, the structure's fields are removed from documentation. The purpose of the attribute is to instruct clients of the module where the structure is defined not to reference the structure's fields directly.

The structure S defined in Mod.xdc as:

@Opaque
struct S {
    Int i;
    Float x;
}

appears in xdc.tools.cdoc generated documentation as:

typedef struct S S;

The actual generated header file is not affected by this attribute. Its impact is restricted to the generated documentation.

[printable version]  [offline version]

offline version generated on 04-Aug-2010 21:08 UTC