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.

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

Autogenerate documentation in framework crates #309

Open
madsmtm opened this issue Dec 23, 2022 · 1 comment
Open

Autogenerate documentation in framework crates #309

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

Comments

@madsmtm
Copy link
Owner

madsmtm commented Dec 23, 2022 •
edited
Loading

Opening this to track implementation work after #264.

Possibilities for having documentation in framework crates include:

  1. Links to https://developer.apple.com/
    • At least for classes.
  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
@silvanshade silvanshade mentioned this issue Jan 22, 2023
Closed
@madsmtm madsmtm added this to the icrate v0.2.0 milestone May 26, 2023
@madsmtm madsmtm mentioned this issue Feb 5, 2024
Merged
@madsmtm madsmtm modified the milestones: Polish frameworks, objc2 v0.6 May 23, 2024
@madsmtm madsmtm mentioned this issue May 23, 2024
Open
4 tasks
@madsmtm madsmtm changed the title Autogenerate documentation in icrate Autogenerate documentation in framework crates Sep 17, 2024
madsmtm added a commit that referenced this issue Nov 25, 2024
@madsmtm
Generate links to documentation
a8e99f6 
We don't currently have the ability to generate documentation from
Apple's documentation, so for now, let's just link to it instead.

Part of #309.
@madsmtm
Copy link
Owner Author

madsmtm commented Nov 25, 2024

Adding documentation for weak properties was done in 27ab005, and linking to Apple's documentation was done in a8e99f6.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-framework Affects the framework crates and the translator for them documentation Improvements or additions to documentation
Projects
None yet
Milestone
Polish frameworks
Development

No branches or pull requests
1 participant
@madsmtm