Current work in main OpenCPN aims to use GetShortDescription() and GetLongDescription() in the plugin API if the plugin becomes orphaned. This is basically about a plugin which is installed using a catalog entry where the catalog is updated in a way which makes this entry to disappear.
A typical example is a plugin installed using a Beta catalog and the catalog later is reverted to master.
We should make sure to be able to use the descriptions in Plugin.cmake for this. The short description is trivial, it's just a about adding a string constant. The long description is non-trivial, it's not clear to me how to transform a multi line Cmake variable to a usable C++ definition. Should be possible to solve somehow.
As it is now, these API functions are not really maintained and returns no so nice data. Eventually, the c++ code should be able to just refer to constants for the descriptions, constants derived from already existing definitions in Plugin.cmake which then will match the catalog data.
Current work in main OpenCPN aims to use GetShortDescription() and GetLongDescription() in the plugin API if the plugin becomes orphaned. This is basically about a plugin which is installed using a catalog entry where the catalog is updated in a way which makes this entry to disappear.
A typical example is a plugin installed using a Beta catalog and the catalog later is reverted to master.
We should make sure to be able to use the descriptions in Plugin.cmake for this. The short description is trivial, it's just a about adding a string constant. The long description is non-trivial, it's not clear to me how to transform a multi line Cmake variable to a usable C++ definition. Should be possible to solve somehow.
As it is now, these API functions are not really maintained and returns no so nice data. Eventually, the c++ code should be able to just refer to constants for the descriptions, constants derived from already existing definitions in Plugin.cmake which then will match the catalog data.