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

Autogenerate documentation in framework crates #309

Open
madsmtm opened this issue Dec 23, 2022 · 0 comments
Open

Autogenerate documentation in framework crates #309

madsmtm opened this issue Dec 23, 2022 · 0 comments
Labels
A-framework Affects the framework crates and the translator for them documentation Improvements or additions to documentation
Milestone

Comments

@madsmtm
Copy link
Owner

madsmtm commented Dec 23, 2022

Opening this to track implementation work after #264.

Possibilities for having documentation in framework crates include:

  1. Links to https://developer.apple.com/
  2. Grab documentation from the above and inline it
  3. Convert code comments in the headers to documentation comments
  4. Use Xamarin's
  5. ?

Or some combination of these.

Also: Add documentation on which properties are weak and copy (that's really nice to know when developing against such an API).

@madsmtm madsmtm added documentation Improvements or additions to documentation A-framework Affects the framework crates and the translator for them labels Dec 23, 2022
@madsmtm madsmtm added this to the icrate v0.2.0 milestone May 26, 2023
@madsmtm madsmtm modified the milestones: Polish frameworks, objc2 v0.6 May 23, 2024
@madsmtm madsmtm changed the title Autogenerate documentation in icrate Autogenerate documentation in framework crates Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-framework Affects the framework crates and the translator for them documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant