Documentation not generated

Hi

Using Delphi 10.3.3 & RODA 10.0.0.1559

Created a code first service.
The documentation of the service is generated, but the documentation (and definition) of structs, enums, etc. is not.

[ROLibraryAttributes(TLibraryAttributes)]
[RODocumentation(‘Defines the type of export.’)]
TExportType = (etCSV, etJSON);

I’m missing something, but I can’t figure out exactly what’s missing…
Can someone point me in the right direction.

Thx.

Filip

Hi,

Unused types (enums, arrays, struct) aren’t included into auto-generated RODL and documentation.

workaround: try to use TExportType somewhere.

Hi Evgeny

Obviously types as TExportType are used in several methods in the service. This is even a parameter of a servicemethod.

But still this is not included in the documentation.

So, using that type somewhere is not suitable :wink:
Any other hints?

Grtz,
Filip

Hi,

check this simple testcase: CodeFirst_doc.zip (91.3 KB)

Hi Evgeny

I just got a step further…
Removing the [ROLibraryAttributes(TLibraryAttributes)] attribute generates the wanted documentation.

image

So, what’s the exact purpose of the ROLibraryAttributes? How to use this? (can’t find it in the docs)

Grtz,
Filip

Hi,

this class is used for storing RODL library attributes in autogenerated _Intf.

  [ROLibraryAttributes(TLibraryAttributes)]
  NewStruct = class(TROComplexType)

as a result our CodeFirst support can detect RODL attributes where NewStruct is put

this attribute is designed for _Intf that is created from RODL.

Also the TLibraryAttributes class allows to read RODL attributes on client-side:


it can be usable if you put RODL version to custom attributes.

1 Like