Update documents. (#127)

jmjoy · web-flow · commit 0bc5e6cb9581 · 2023-05-14T10:55:40.000+08:00
diff --git a/phper-doc/doc/_02_quick_start/_01_write_your_first_extension/index.md b/phper-doc/doc/_02_quick_start/_01_write_your_first_extension/index.md
@@ -26,7 +26,7 @@ Full example is <https://github.com/phper-framework/phper/tree/master/examples/h
 1. Add the metadata to the `Cargo.toml` to build the `.so` file.
 
    ```toml
-   ## Cargo.toml
+   # Cargo.toml
 
    [lib]
    crate-type = ["cdylib"]
@@ -88,12 +88,12 @@ Full example is <https://github.com/phper-framework/phper/tree/master/examples/h
 1. Build, if your php isn't installed globally, you should specify the path of `php-config`.
 
    ```bash
-   ## Optional, specify if php isn't installed globally,
-   ## this environment is used by `phper-sys`.
-   ##
-   ## export PHP_CONFIG=<Your path of php-config>
+   # Optional, specify if php isn't installed globally,
+   # this environment is used by `phper-sys`.
+   #
+   # export PHP_CONFIG=<Your path of php-config>
    
-   ## Build libhello.so.
+   # Build libhello.so.
    cargo build
    ```
 
diff --git a/phper-doc/doc/_02_quick_start/_02_write_a_simple_http_client/index.md b/phper-doc/doc/_02_quick_start/_02_write_a_simple_http_client/index.md
@@ -61,7 +61,7 @@ Before writing the code, we first prepare the dependency and startup code.
 1. Add the metadata to the `Cargo.toml` to build the `.so` file.
 
    ```toml
-   ## Cargo.toml
+   # Cargo.toml
 
    [lib]
    crate-type = ["cdylib"]
diff --git a/phper/src/arrays.rs b/phper/src/arrays.rs
@@ -8,7 +8,7 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_array].
+//! Apis relate to [zend_array](crate::sys::zend_array).
 
 use crate::{alloc::ToRefOwned, strings::ZStr, sys::*, values::ZVal};
 use derive_more::From;
@@ -61,7 +61,7 @@ impl<'a> From<Key<'a>> for InsertKey<'a> {
     }
 }
 
-/// Wrapper of [crate::sys::zend_array].
+/// Wrapper of [zend_array](crate::sys::zend_array).
 #[repr(transparent)]
 pub struct ZArr {
     inner: zend_array,
@@ -359,7 +359,7 @@ impl ToRefOwned for ZArr {
     }
 }
 
-/// Wrapper of [crate::sys::zend_array].
+/// Wrapper of [zend_array](crate::sys::zend_array).
 #[repr(transparent)]
 pub struct ZArray {
     inner: *mut ZArr,
diff --git a/phper/src/classes.rs b/phper/src/classes.rs
@@ -8,7 +8,7 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_class_entry].
+//! Apis relate to [zend_class_entry](crate::sys::zend_class_entry).
 
 use crate::{
     arrays::ZArr,
@@ -48,7 +48,7 @@ pub fn array_access_class<'a>() -> &'a ClassEntry {
     unsafe { ClassEntry::from_ptr(zend_ce_arrayaccess) }
 }
 
-/// Wrapper of [crate::sys::zend_class_entry].
+/// Wrapper of [zend_class_entry](crate::sys::zend_class_entry).
 #[repr(transparent)]
 pub struct ClassEntry {
     inner: zend_class_entry,
diff --git a/phper/src/constants.rs b/phper/src/constants.rs
@@ -8,7 +8,7 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_constant].
+//! Apis relate to [zend_constant](crate::sys::zend_constant).
 
 use crate::{sys::*, types::Scalar};
 use std::ffi::{c_char, c_int};
diff --git a/phper/src/functions.rs b/phper/src/functions.rs
@@ -8,7 +8,7 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_function_entry].
+//! Apis relate to [zend_function_entry](crate::sys::zend_function_entry).
 //!
 //! TODO Add lambda.
 
diff --git a/phper/src/ini.rs b/phper/src/ini.rs
@@ -8,7 +8,7 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_ini_entry_def].
+//! Apis relate to [zend_ini_entry_def](crate::sys::zend_ini_entry_def).
 
 use crate::{c_str, sys::*};
 use std::{
diff --git a/phper/src/modules.rs b/phper/src/modules.rs
@@ -8,7 +8,7 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_module_entry].
+//! Apis relate to [zend_module_entry](crate::sys::zend_module_entry).
 
 use crate::{
     c_str_ptr,
diff --git a/phper/src/objects.rs b/phper/src/objects.rs
@@ -8,7 +8,7 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_object].
+//! Apis relate to [zend_object](crate::sys::zend_object).
 
 use crate::{
     alloc::EBox,
@@ -30,7 +30,7 @@ use std::{
     ptr::null_mut,
 };
 
-/// Wrapper of [crate::sys::zend_object].
+/// Wrapper of [zend_object](crate::sys::zend_object).
 #[repr(transparent)]
 pub struct ZObj {
     inner: zend_object,
@@ -287,7 +287,7 @@ impl Debug for ZObj {
     }
 }
 
-/// Wrapper of [crate::sys::zend_object].
+/// Wrapper of [zend_object](crate::sys::zend_object).
 pub struct ZObject {
     inner: *mut ZObj,
 }
diff --git a/phper/src/references.rs b/phper/src/references.rs
@@ -8,12 +8,12 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_resource].
+//! Apis relate to [zend_resource](crate::sys::zend_resource).
 
 use crate::{sys::*, values::ZVal};
 use std::fmt::{self, Debug};
 
-/// Wrapper of [crate::sys::zend_resource].
+/// Wrapper of [zend_resource](crate::sys::zend_resource).
 #[repr(transparent)]
 pub struct ZRef {
     inner: zend_reference,
diff --git a/phper/src/resources.rs b/phper/src/resources.rs
@@ -8,12 +8,12 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_resource].
+//! Apis relate to [zend_resource](crate::sys::zend_resource).
 
 use crate::sys::*;
 use std::fmt::{self, Debug};
 
-/// Wrapper of [crate::sys::zend_resource].
+/// Wrapper of [zend_resource](crate::sys::zend_resource).
 #[repr(transparent)]
 pub struct ZRes {
     inner: zend_resource,
diff --git a/phper/src/strings.rs b/phper/src/strings.rs
@@ -8,7 +8,7 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zend_string].
+//! Apis relate to [zend_string](crate::sys::zend_string).
 
 use crate::sys::*;
 use phper_alloc::ToRefOwned;
@@ -26,7 +26,7 @@ use std::{
     str::Utf8Error,
 };
 
-/// Like str, CStr for [crate::sys::zend_string].
+/// Like str, CStr for [zend_string](crate::sys::zend_string).
 #[repr(transparent)]
 pub struct ZStr {
     inner: zend_string,
@@ -171,7 +171,7 @@ impl ToRefOwned for ZStr {
     }
 }
 
-/// Like String, CString for [crate::sys::zend_string].
+/// Like String, CString for [zend_string](crate::sys::zend_string).
 pub struct ZString {
     inner: *mut ZStr,
 }
diff --git a/phper/src/values.rs b/phper/src/values.rs
@@ -8,7 +8,7 @@
 // NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 // See the Mulan PSL v2 for more details.
 
-//! Apis relate to [crate::sys::zval].
+//! Apis relate to [zval](crate::sys::zval).
 
 use crate::{
     alloc::EBox,
@@ -33,7 +33,7 @@ use std::{
     str,
 };
 
-/// Wrapper of [crate::sys::zend_execute_data].
+/// Wrapper of [zend_execute_data](crate::sys::zend_execute_data).
 #[repr(transparent)]
 pub struct ExecuteData {
     inner: zend_execute_data,
@@ -177,7 +177,7 @@ impl ExecuteData {
     }
 }
 
-/// Wrapper of [crate::sys::zval].
+/// Wrapper of [zval](crate::sys::zval).
 #[repr(transparent)]
 pub struct ZVal {
     inner: zval,

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`// NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.`
`9`	`9`	`// See the Mulan PSL v2 for more details.`
`10`	`10`
`11`		`-//! Apis relate to [crate::sys::zend_array].`
	`11`	`+//! Apis relate to [zend_array](crate::sys::zend_array).`
`12`	`12`
`13`	`13`	`use crate::{alloc::ToRefOwned, strings::ZStr, sys::*, values::ZVal};`
`14`	`14`	`use derive_more::From;`
`@@ -61,7 +61,7 @@ impl<'a> From<Key<'a>> for InsertKey<'a> {`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`64`		`-/// Wrapper of [crate::sys::zend_array].`
	`64`	`+/// Wrapper of [zend_array](crate::sys::zend_array).`
`65`	`65`	`#[repr(transparent)]`
`66`	`66`	`pub struct ZArr {`
`67`	`67`	`inner: zend_array,`
`@@ -359,7 +359,7 @@ impl ToRefOwned for ZArr {`
`359`	`359`	`}`
`360`	`360`	`}`
`361`	`361`
`362`		`-/// Wrapper of [crate::sys::zend_array].`
	`362`	`+/// Wrapper of [zend_array](crate::sys::zend_array).`
`363`	`363`	`#[repr(transparent)]`
`364`	`364`	`pub struct ZArray {`
`365`	`365`	`inner: *mut ZArr,`