Document features, fix documentation links

Author: davidcole1340

.github/workflows/docs.yml

@@ -41,6 +41,7 @@ jobs:
         uses: actions-rs/cargo@v1
         env:
           LIBCLANG_PATH: ${{ runner.temp }}/llvm-${{ matrix.llvm }}/lib
+          RUSTDOCFLAGS: --cfg docs
         with:
           command: doc
           args: --release

src/lib.rs

@@ -3,6 +3,7 @@
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
+#![cfg_attr(docs, feature(doc_cfg))]
 
 #[macro_use]
 pub mod macros;
@@ -433,7 +434,8 @@ pub use ext_php_rs_derive::php_startup;
 pub mod prelude {
     pub use crate::php::module::ModuleBuilder;
     pub use crate::php::types::callable::Callable;
-    #[cfg(feature = "closure")]
+    #[cfg(any(docs, feature = "closure"))]
+    #[cfg_attr(docs, doc(cfg(feature = "closure")))]
     pub use crate::php::types::closure::Closure;
     pub use crate::php_class;
     pub use crate::php_const;

src/php/mod.rs

@@ -1,6 +1,7 @@
 //! Objects relating to PHP and the Zend engine.
 
-#[cfg(feature = "alloc")]
+#[cfg(any(docs, feature = "alloc"))]
+#[cfg_attr(docs, doc(cfg(feature = "alloc")))]
 pub mod alloc;
 
 pub mod args;

src/php/types/mod.rs

@@ -4,7 +4,8 @@
 pub mod array;
 pub mod binary;
 pub mod callable;
-#[cfg(feature = "closure")]
+#[cfg(any(docs, feature = "closure"))]
+#[cfg_attr(docs, doc(cfg(feature = "closure")))]
 pub mod closure;
 pub mod long;
 pub mod object;

src/php/types/object.rs

@@ -353,6 +353,8 @@ where
     ///
     /// This must be statically allocated, and is usually done through the [`macro@php_class`]
     /// macro.
+    ///
+    /// [`macro@php_class`]: crate::php_class
     fn get_metadata() -> &'static ClassMetadata<Self>;
 
     /// Attempts to retrieve a property from the class object.
@@ -369,7 +371,7 @@ where
     /// # Safety
     ///
     /// Caller must guarantee that the object the function is called on is immediately followed
-    /// by a [`zend_object`], which is true when the object was instantiated from  [`ZendClassObject`].
+    /// by a [`zend_object`], which is true when the object was instantiated by PHP.
     unsafe fn get_property<'a, T: FromZval<'a>>(&'a self, name: &str) -> Option<T> {
         let obj = ZendClassObject::<Self>::from_obj_ptr(self)?;
         let zv = obj.std.get_property(name).ok()?;
@@ -391,7 +393,7 @@ where
     /// # Safety
     ///
     /// Caller must guarantee that the object the function is called on is immediately followed
-    /// by a [`zend_object`], which is true when the object was instantiated from  [`ZendClassObject`].
+    /// by a [`zend_object`], which is true when the object was instantiated by PHP.
     unsafe fn set_property(&mut self, name: &str, value: impl IntoZval) -> Option<()> {
         let obj = ZendClassObject::<Self>::from_obj_ptr(self)?;
         obj.std.set_property(name, value).ok()?;