Doctest README examples as well

Author: madsmtm

objc/README.md

@@ -11,13 +11,18 @@ Objective-C Runtime bindings and wrapper for Rust.
 
 Objective-C objects can be messaged using the `msg_send!` macro:
 
-```rust
+```rust , no_run
+use objc::{class, msg_send};
+use objc::runtime::{BOOL, Object};
+
 let cls = class!(NSObject);
-let obj: *mut Object = msg_send![cls, new];
-let hash: usize = msg_send![obj, hash];
-let is_kind: BOOL = msg_send![obj, isKindOfClass:cls];
-// Even void methods must have their return type annotated
-let _: () = msg_send![obj, release];
+unsafe {
+    let obj: *mut Object = msg_send![cls, new];
+    let hash: usize = msg_send![obj, hash];
+    let is_kind: BOOL = msg_send![obj, isKindOfClass:cls];
+    // Even void methods must have their return type annotated
+    let _: () = msg_send![obj, release];
+}
 ```
 
 ## Reference counting
@@ -28,7 +33,10 @@ A `StrongPtr` retains an object and releases the object when dropped.
 A `WeakPtr` will not retain the object, but can be upgraded to a `StrongPtr`
 and safely fails if the object has been deallocated.
 
-```rust
+```rust , no_run
+use objc::{class, msg_send};
+use objc::rc::{autoreleasepool, StrongPtr};
+
 // StrongPtr will release the object when dropped
 let obj = unsafe {
     StrongPtr::new(msg_send![class!(NSObject), new])
@@ -56,7 +64,11 @@ methods can then be added before the class is ultimately registered.
 The following example demonstrates declaring a class named `MyNumber` that has
 one ivar, a `u32` named `_number` and a `number` method that returns it:
 
-```rust
+```rust , no_run
+use objc::{class, sel};
+use objc::declare::ClassDecl;
+use objc::runtime::{Object, Sel};
+
 let superclass = class!(NSObject);
 let mut decl = ClassDecl::new("MyNumber", superclass).unwrap();
 

objc/src/lib.rs

@@ -69,6 +69,14 @@ The bindings can be used on Linux or *BSD utilizing the
 extern crate alloc;
 extern crate std;
 
+#[cfg(doctest)]
+#[doc = include_str!("../README.md")]
+extern "C" {}
+
+#[cfg(doctest)]
+#[doc = include_str!("../../README.md")]
+extern "C" {}
+
 pub use objc_encode::{Encode, Encoding};
 
 pub use crate::encode::EncodeArguments;

objc_encode/Cargo.toml

@@ -16,3 +16,6 @@ readme = "README.md"
 repository = "https://github.com/madsmtm/objc"
 documentation = "https://docs.rs/objc-encode/"
 license = "MIT"
+
+[dev-dependencies]
+objc = { path = "../objc", version = "0.2.7" }

objc_encode/README.md

@@ -18,9 +18,23 @@ This crate declares an `Encode` trait that can be implemented for types that
 the Objective-C compiler can encode. Implementing this trait looks like:
 
 ```rust
+use objc::{Encode, Encoding};
+
+#[cfg(target_pointer_width = "32")]
+type CGFloat = f32;
+
+#[cfg(target_pointer_width = "64")]
+type CGFloat = f64;
+
+#[repr(C)]
+struct CGPoint {
+    x: CGFloat,
+    y: CGFloat,
+}
+
 unsafe impl Encode for CGPoint {
     const ENCODING: Encoding<'static> =
-        Encoding::Struct("CGPoint", &[CGFloat::ENCODING, CGFLOAT::ENCODING]);
+        Encoding::Struct("CGPoint", &[CGFloat::ENCODING, CGFloat::ENCODING]);
 }
 ```
 
@@ -33,6 +47,8 @@ An `Encoding` can be compared with an encoding string from the Objective-C
 runtime:
 
 ```rust
+use objc::Encode;
+
 assert!(&i32::ENCODING == "i");
 ```
 
@@ -42,5 +58,7 @@ Every `Encoding` implements `Display` as its string representation.
 This can be generated conveniently through the `to_string` method:
 
 ```rust
+use objc::Encode;
+
 assert_eq!(i32::ENCODING.to_string(), "i");
 ```

objc_encode/src/lib.rs

@@ -47,6 +47,10 @@ assert_eq!(i32::ENCODING.to_string(), "i");
 // Update in Cargo.toml as well.
 #![doc(html_root_url = "https://docs.rs/objc-encode/1.1.0")]
 
+#[cfg(doctest)]
+#[doc = include_str!("../README.md")]
+extern "C" {}
+
 #[cfg(any(test, doc))]
 extern crate alloc;
 

objc_exception/src/lib.rs

@@ -6,15 +6,18 @@
 //! - <https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Exceptions/Exceptions.html>
 //! - <https://llvm.org/docs/ExceptionHandling.html>
 
+#![no_std]
 #![warn(missing_docs)]
 // Update in Cargo.toml as well.
 #![doc(html_root_url = "https://docs.rs/objc_exception/0.1.2")]
 
-#![no_std]
-
 #[cfg(test)]
 extern crate alloc;
 
+#[cfg(doctest)]
+#[doc = include_str!("../README.md")]
+extern "C" {}
+
 use core::ffi::c_void;
 use core::mem;
 use core::ptr;

objc_foundation/src/lib.rs

@@ -6,6 +6,10 @@
 extern crate alloc;
 extern crate std;
 
+#[cfg(doctest)]
+#[doc = include_str!("../README.md")]
+extern "C" {}
+
 pub use self::array::{
     INSArray, INSMutableArray, NSArray, NSComparisonResult, NSMutableArray, NSMutableSharedArray,
     NSRange, NSSharedArray,

objc_foundation_derive/src/lib.rs

@@ -1,6 +1,10 @@
 // Update in Cargo.toml as well.
 #![doc(html_root_url = "https://docs.rs/objc-foundation-derive/0.0.1")]
 
+#[cfg(doctest)]
+#[doc = include_str!("../README.md")]
+extern "C" {}
+
 extern crate proc_macro;
 #[macro_use]
 extern crate quote;