phper_doc/
lib.rs

1// Copyright (c) 2022 PHPER Framework Team
2// PHPER is licensed under Mulan PSL v2.
3// You can use this software according to the terms and conditions of the Mulan
4// PSL v2. You may obtain a copy of Mulan PSL v2 at:
5//          http://license.coscl.org.cn/MulanPSL2
6// THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY
7// KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
8// NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
9// See the Mulan PSL v2 for more details.
10
11#![warn(rust_2018_idioms, missing_docs)]
12#![warn(clippy::dbg_macro, clippy::print_stdout)]
13#![doc = include_str!("../README.md")]
14#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/112468984?s=200&v=4")]
15#![cfg_attr(docsrs, feature(doc_auto_cfg))]
16
17pub use phper;
18
19#[doc = include_str!("../doc/_01_introduction/index.md")]
20pub mod _01_introduction {}
21
22#[doc = include_str!("../doc/_02_quick_start/index.md")]
23pub mod _02_quick_start {
24
25    #[doc = include_str!("../doc/_02_quick_start/_01_write_your_first_extension/index.md")]
26    pub mod _01_write_your_first_extension {}
27
28    #[doc = include_str!("../doc/_02_quick_start/_02_write_a_simple_http_client/index.md")]
29    pub mod _02_write_a_simple_http_client {}
30}
31
32#[doc = include_str!("../doc/_03_integrate_with_pecl/index.md")]
33pub mod _03_integrate_with_pecl {}
34
35#[doc = include_str!("../doc/_04_zval/index.md")]
36pub mod _04_zval {}
37
38#[doc = include_str!("../doc/_05_internal_types/index.md")]
39pub mod _05_internal_types {
40
41    #[doc = include_str!("../doc/_05_internal_types/_01_z_str/index.md")]
42    pub mod _01_z_str {}
43
44    #[doc = include_str!("../doc/_05_internal_types/_02_z_arr/index.md")]
45    pub mod _02_z_arr {}
46
47    #[doc = include_str!("../doc/_05_internal_types/_03_z_obj/index.md")]
48    pub mod _03_z_obj {}
49}
50
51#[doc = include_str!("../doc/_06_module/index.md")]
52pub mod _06_module {
53
54    #[doc = include_str!("../doc/_06_module/_01_hooks/index.md")]
55    pub mod _01_hooks {}
56
57    #[doc = include_str!("../doc/_06_module/_02_register_functions/index.md")]
58    pub mod _02_register_functions {}
59
60    #[doc = include_str!("../doc/_06_module/_03_register_constants/index.md")]
61    pub mod _03_register_constants {}
62
63    #[doc = include_str!("../doc/_06_module/_04_register_ini_settings/index.md")]
64    pub mod _04_register_ini_settings {}
65
66    #[doc = include_str!("../doc/_06_module/_05_extension_information/index.md")]
67    pub mod _05_extension_information {}
68
69    #[doc = include_str!("../doc/_06_module/_06_register_class/index.md")]
70    pub mod _06_register_class {}
71
72    #[doc = include_str!("../doc/_06_module/_07_register_interface/index.md")]
73    pub mod _07_register_interface {}
74
75    #[cfg(phper_enum_supported)]
76    #[doc = include_str!("../doc/_06_module/_08_register_enum/index.md")]
77    pub mod _08_register_enum {}
78}
79
80/// TODO
81pub mod _07_allocation {}
82
83/// TODO
84pub mod _08_handle_exception {}
85
86/// TODO
87pub mod _09_build_script {}
88
89/// TODO
90pub mod _10_integration_tests {}
91
92/// TODO
93pub mod _11_macros {}