AcademySoftwareFoundation
Properties by object reference "outdated"?
Problem
The documentation for the "Properties by object reference" page (which lists which properties a given type of OFX object has) says:
This section is outdated and should be properly generated automatically from source code instead of maintaining it aside
That warning was added 7 years ago, and I can't see any existing tracking issues for implementing that automatic generation or bringing the section up-to-date.
This reference is not only important when implementing plugins, but also essential when implementing a host without using the existing C++ HostSupport library.
In general, documentation for the vast majority of software libraries is laid out such that the documentation for a given class/type contains a list of all its fields and methods. For OpenFX, where most classes take the form of property sets and their "fields" are the properties that can be accessed using the property suite, the "Properties by object reference" page is the closest thing available.
Yes, it's part of the solution to this doc issue. Thanks for connecting them -- it's work in progress but having the property defs machine-readable should give us enough info to update that doc section.
