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

Improve documentation #13

Merged
merged 9 commits into from
Sep 1, 2021
Merged

Improve documentation #13

merged 9 commits into from
Sep 1, 2021

Conversation

madsmtm
Copy link
Owner

@madsmtm madsmtm commented Sep 1, 2021

  • Fix examples
  • Update cargo metadata
  • Add README to each crate
  • Doctest README
  • Changed libexception.a to librustobjcexception.a to ensure we don't name-conflict with something else
  • Various other improvements

Replaces SSheldon/rust-objc-encode#2.

Mostly adds noteworthy links and renamed compile library to `librustobjcexception.a`
Important to showcase how to implement Encode for Objective-C objects that we don't know the internal representation of.
- Move documentation to docs.rs
- Update repository links
- Add myself to the authors field
- Update keywords and categories
- Add #![warn(missing_docs)]
- Link to types from lib.rs
- Document all enum variants of `Encoding`
- Small fixes
- Add missing READMEs
- Add headers
- Fix whitespace
- Add badges
- Make a few `where` clauses simpler
- Remove unnecessary `fn main` from doctests
- Fix a bunch of item links
- Document `objc::Message` better
- Refactor `Object` impl a bit
@madsmtm madsmtm added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 1, 2021
@madsmtm madsmtm merged commit 66c7ddf into master Sep 1, 2021
@madsmtm madsmtm deleted the documentation branch September 1, 2021 00:44
@madsmtm madsmtm mentioned this pull request Sep 5, 2021
80 tasks
@madsmtm madsmtm added this to the objc2 v0.3 milestone Apr 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant