Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Properties by object reference "outdated"? #173

Open
valadaptive opened this issue Oct 25, 2024 · 2 comments
Open

Properties by object reference "outdated"? #173

valadaptive opened this issue Oct 25, 2024 · 2 comments

Comments

@valadaptive
Copy link
Contributor

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.

@valadaptive
Copy link
Contributor Author

Seems like #166 may address this

@garyo
Copy link
Contributor

garyo commented Oct 25, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants