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

[Platform] Apply API review fixes to Darwin auto-generated APIs #22545

Closed
bzbarsky-apple opened this issue Sep 12, 2022 · 0 comments · Fixed by #22665
Closed

[Platform] Apply API review fixes to Darwin auto-generated APIs #22545

bzbarsky-apple opened this issue Sep 12, 2022 · 0 comments · Fixed by #22665
Assignees

Comments

@bzbarsky-apple
Copy link
Contributor

bzbarsky-apple commented Sep 12, 2022

Reproduction steps

  1. In MTRBaseClusters.h, see if we can generate any sort of basic documentation for the interfaces and/or their methods.
  2. In MTRBaseClusters.h, see if we can have "ACL" instead of "Acl" in things like readAttributeAclWithParams. The problem, I suspect, is that asUpperCamelCase does the latter, so we may need a different helper or something, and at this point a different helper needs the overhead of a trip through the ZAP repo.
  3. In MTRClusterConstants.h, see if we can have "ClusterOTA" not "ClusterOta" (similar to the ACL issue above.
  4. Make sure the prefixes on the enum names match the type. So instead of MTRClusterIdentifyID have MTRClusterIDTypeIdentifyID and so on.
  5. Think about the naming of the enum values for MTRClusterAttributeIDType and rename it to MTRAttributeIdType. Perhaps something like:
    [MTRAttributeIDType][(GlobalAttribute)(GeneratedCommandList)]
    [MTRAttributeIDType][(ClusterIdentify)(AttributeIdentifyTime)]
    
    but think if there is any way we can make this shorter but still unambiguous.
  6. Similar for command ids, which should become MTRCommandIDType:
    [MTRCommandIDType][(ClusterIdentify)(CommandIdentify)]
    
    and again think about whether it can be shorter.
  7. Similar for event ids.

Part of #22420 and independent of the other work going on in that issue.

Platform

darwin

Platform Version(s)

No response

Type

Manually tested with SDK

(Optional) If manually tested please explain why this is only manually tested

No response

Anything else?

No response

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