CLAS/INTF - descriptions

[larshp]

https://github.com/SAP/abap-file-formats/blob/main/file-formats/clas/examples/zcl_aff_example.clas.json

Suggest moving types + attributes + events + methods under a field named "descriptions", as eg. adding a type under types does not actually add a type in the class, but only sets a description, which will take effect if the code contains the type?

[larshp]

see https://github.com/SAP/abap-file-formats/pull/87

not looking at the abapdoc(note that below ABAP is close to how the JSON will look), its very obvious that some of these fields are descriptions,

  TYPES:
    BEGIN OF main,
      header     TYPE zif_aff_types_v1=>header,
      category   TYPE category,
      proxy      TYPE abap_bool,
      types      TYPE component_descriptions,
      attributes TYPE component_descriptions,
      events     TYPE events,
      methods    TYPE methods,
    END OF main.

one suggestion is to add a structure for the descriptions,

  TYPES:
    BEGIN OF main,
      header     TYPE zif_aff_types_v1=>header,
      category   TYPE category,
      proxy      TYPE abap_bool,
      BEGIN OF descriptions,
        types      TYPE component_descriptions,
        attributes TYPE component_descriptions,
        events     TYPE events,
        methods    TYPE methods,
      END OF descriptions,
    END OF main.

[larshp]

still relevant

[larshp]

it's only possible for SAP to implement this issue, as the code for JSON generation is proprietary