Add missing_docs lints, and supplementary documents. (#96)

Author: jmjoy

phper-alloc/src/lib.rs

@@ -8,7 +8,8 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-#![warn(rust_2018_idioms, clippy::dbg_macro, clippy::print_stdout)]
+#![warn(rust_2018_idioms, missing_docs)]
+#![warn(clippy::dbg_macro, clippy::print_stdout)]
 #![doc = include_str!("../README.md")]
 
 #[macro_use]
@@ -51,7 +52,7 @@ impl<T> EBox<T> {
     ///
     /// # Safety
     ///
-    /// Make sure the pointer is created from `emalloc`.
+    /// Make sure the pointer is from `into_raw`, or created from `emalloc`.
     pub unsafe fn from_raw(raw: *mut T) -> Self {
         Self { ptr: raw }
     }
@@ -63,6 +64,7 @@ impl<T> EBox<T> {
         ManuallyDrop::new(b).ptr
     }
 
+    /// Consumes the `EBox`, returning the wrapped value.
     pub fn into_inner(self) -> T {
         unsafe { self.ptr.read() }
     }
@@ -94,13 +96,16 @@ impl<T> Drop for EBox<T> {
 /// Duplicate an object without deep copy, but to only add the refcount, for php
 /// refcount struct.
 pub trait ToRefOwned {
+    /// The resulting type after obtaining ownership.
     type Owned: Borrow<Self>;
 
+    /// Creates owned data from borrowed data, by increasing refcount.
     fn to_ref_owned(&mut self) -> Self::Owned;
 }
 
 /// Duplicate an object without deep copy, but to only add the refcount, for php
 /// refcount struct.
 pub trait RefClone {
+    /// Returns a refcount value with same reference of the value.
     fn ref_clone(&mut self) -> Self;
 }

phper-build/src/lib.rs

@@ -8,11 +8,13 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-#![warn(rust_2018_idioms, clippy::dbg_macro)]
+#![warn(rust_2018_idioms, missing_docs)]
+#![warn(clippy::dbg_macro)]
 #![doc = include_str!("../README.md")]
 
 use phper_sys::*;
 
+/// Register all php build relative configure parameters, used in `build.rs`.
 pub fn register_all() {
     register_link_args();
     register_configures();
@@ -43,6 +45,7 @@ pub fn register_configures() {
     }
 }
 
+/// Register link arguments for os-specified situation.
 pub fn register_link_args() {
     #[cfg(target_os = "macos")]
     {

phper-doc/doc/_04_zval/index.md

@@ -59,7 +59,6 @@ Now you can use `as_*` or `expect_*` methods to convert ZVal to Rust types.
   [phper::errors::ExpectTypeError] will be returned, with the message:
   `type error: must be of type {expect_type}, {actual_type} given")`.
 
-
 ### Example
 
 ```rust,no_run

phper-doc/doc/_06_class_and_object/index.md

@@ -8,7 +8,8 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-#![warn(rust_2018_idioms, clippy::dbg_macro)]
+#![warn(rust_2018_idioms, missing_docs)]
+#![warn(clippy::dbg_macro, clippy::print_stdout)]
 #![doc = include_str!("../README.md")]
 
 pub use phper;
@@ -45,11 +46,8 @@ pub mod _05_internal_types {
     pub mod _03_z_obj {}
 }
 
-#[doc = include_str!("../doc/_06_class_and_object/index.md")]
-pub mod _06_class_and_object {}
-
-#[doc = include_str!("../doc/_07_module/index.md")]
-pub mod _07_module {
+#[doc = include_str!("../doc/_06_module/index.md")]
+pub mod _06_module {
 
     /// TODO
     pub mod _01_hooks {}
@@ -65,19 +63,22 @@ pub mod _07_module {
 
     /// TODO
     pub mod _05_extension_information {}
+
+    /// TODO
+    pub mod _06_register_class {}
 }
 
 /// TODO
-pub mod _08_allocation {}
+pub mod _07_allocation {}
 
 /// TODO
-pub mod _09_handle_exception {}
+pub mod _08_handle_exception {}
 
 /// TODO
-pub mod _10_build_script {}
+pub mod _09_build_script {}
 
 /// TODO
-pub mod _11_integration_tests {}
+pub mod _10_integration_tests {}
 
 /// TODO
-pub mod _12_macros {}
+pub mod _11_macros {}

phper-doc/doc/_07_module/index.md renamed to phper-doc/doc/_06_module/index.md

@@ -8,7 +8,8 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-#![warn(rust_2018_idioms, clippy::dbg_macro, clippy::print_stdout)]
+#![warn(rust_2018_idioms, missing_docs)]
+#![warn(clippy::dbg_macro, clippy::print_stdout)]
 #![doc = include_str!("../README.md")]
 
 // TODO Write a bridge macro for easy usage about register functions and

phper-doc/src/lib.rs

@@ -8,7 +8,8 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-#![warn(rust_2018_idioms, clippy::dbg_macro, clippy::print_stdout)]
+#![warn(rust_2018_idioms)]
+#![warn(clippy::dbg_macro, clippy::print_stdout)]
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]

phper-macros/src/lib.rs

@@ -8,7 +8,8 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-#![warn(rust_2018_idioms, clippy::dbg_macro, clippy::print_stdout)]
+#![warn(rust_2018_idioms, missing_docs)]
+#![warn(clippy::dbg_macro, clippy::print_stdout)]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![doc = include_str!("../README.md")]
 

phper-sys/src/lib.rs

@@ -8,6 +8,8 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
+//! Utils for PHP test situation.
+
 use std::{
     ffi::{OsStr, OsString},
     fmt::Debug,
@@ -59,6 +61,7 @@ pub(crate) fn spawn_command<S: AsRef<OsStr> + Debug>(
     child
 }
 
+/// Get the dynamic link library path generated by `cargo build`.
 pub fn get_lib_path(target_path: impl AsRef<Path>, package_name: &str) -> PathBuf {
     let target_path = target_path.as_ref();
     let mut path = target_path.to_path_buf();