search

esa / mo-services-java

ESA's Java implementation of the CCSDS MO services
Other
11 stars 4 forks source link

[stub-generator] Document generator and COM object references #5

Closed CesarCoelho closed 2 months ago

CesarCoelho commented 3 years ago

From @SamCooper : Would be nice if the tables for related and source objects said Parameter::ParameterIdentity rather than Parameter::1

Reply from @CesarCoelho : Not for the related links because these can only link within the same service. This means that the information on the left hand side would be redundant (the service name): ThisServiceName::COMObject1 I believe that the number is enough for the related link because one can easily check the table and find it.

However, I think it is a good idea for the source link because it is able to link to "foreign" COM Objects (outside its service range) and therefore it could indeed be improved by following the conventions mentioned above: ServiceName::COMObjectName

In the XML files this value is represented as a numeric value and not as a string. Example:

This means that at the moment it would be impossible to "match" with the name of the respective COM object. The solution would be to exchange the number with a string name for the object, or support both the name and the number.

The source link table cell is generated here: https://github.com/esa/CCSDS_MO_StubGenerator/blob/master/GEN_DOCS/src/main/java/esa/mo/tools/stubgen/GeneratorDocx.java#L499

CesarCoelho commented 1 year ago

The COM Objects will be removed in the upcoming books, so this issue will become deprecated. Pending closure...

CesarCoelho commented 2 months ago

The new MAL book has been released and this issue is no longer relevant