AcademySoftwareFoundation / AcademySoftwareFoundation/openfx

Properties by object reference "outdated"?

Open
#173 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
570
Forks
152
PR merge metrics
No merged PRs in 30d

Description

### 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.

Contributor guide

Open the contributing guide

Research direction

Start with the “Properties by object reference” documentation page and inspect the OpenFX source code it describes. Determine how the property reference can be brought up to date or generated automatically, then verify that the page accurately lists properties for each OFX object type and no longer carries the outdated warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.