8000 Validate and generate doc for static const decls in api.json · Issue #105 · orca-app/orca · GitHub

More Web Proxy on the site http://driver.im/

Validate and generate doc for static const decls in api.json #105

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.

Sign up for GitHub

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

Jump to bottom

Open

3 tasks

martinfouilleul opened this issue Mar 6, 2025 · 0 comments

Open

3 tasks

Validate and generate doc for static const decls in api.json #105

martinfouilleul opened this issue Mar 6, 2025 · 0 comments

Labels

Collaborator

martinfouilleul commented

•

Non-enum constants (like the UI theme strings) are declared in api.json using a new schema:

{
    "kind": "const",
    "name": "OC_UI_THEME_PRIMARY",
    "type": {
        "kind": "namedType",
        "name": "oc_str8"
    },
    "init": {
        "kind": "string",
        "value": "primary"
    }
}

These have been added manually to api.json for now to unblock binding maintainers, but we still need to:

Generate templates for these declarations from source to ease adding new declarations in the future
Check those declarations against the source to validate that api.json is up to date when we push to master
Generate docs from these declarations

The text was updated successfully, but these errors were encountered:

martinfouilleul added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

0