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#![cfg_attr(docsrs, feature(doc_auto_cfg))]
15
16pub use phper;
17
18#[doc = include_str!("../doc/_01_introduction/index.md")]
19pub mod _01_introduction {}
20
21#[doc = include_str!("../doc/_02_quick_start/index.md")]
22pub mod _02_quick_start {
23
24    #[doc = include_str!("../doc/_02_quick_start/_01_write_your_first_extension/index.md")]
25    pub mod _01_write_your_first_extension {}
26
27    #[doc = include_str!("../doc/_02_quick_start/_02_write_a_simple_http_client/index.md")]
28    pub mod _02_write_a_simple_http_client {}
29}
30
31#[doc = include_str!("../doc/_03_integrate_with_pecl/index.md")]
32pub mod _03_integrate_with_pecl {}
33
34#[doc = include_str!("../doc/_04_zval/index.md")]
35pub mod _04_zval {}
36
37#[doc = include_str!("../doc/_05_internal_types/index.md")]
38pub mod _05_internal_types {
39
40    #[doc = include_str!("../doc/_05_internal_types/_01_z_str/index.md")]
41    pub mod _01_z_str {}
42
43    #[doc = include_str!("../doc/_05_internal_types/_02_z_arr/index.md")]
44    pub mod _02_z_arr {}
45
46    #[doc = include_str!("../doc/_05_internal_types/_03_z_obj/index.md")]
47    pub mod _03_z_obj {}
48}
49
50#[doc = include_str!("../doc/_06_module/index.md")]
51pub mod _06_module {
52
53    #[doc = include_str!("../doc/_06_module/_01_hooks/index.md")]
54    pub mod _01_hooks {}
55
56    #[doc = include_str!("../doc/_06_module/_02_register_functions/index.md")]
57    pub mod _02_register_functions {}
58
59    #[doc = include_str!("../doc/_06_module/_03_register_constants/index.md")]
60    pub mod _03_register_constants {}
61
62    #[doc = include_str!("../doc/_06_module/_04_register_ini_settings/index.md")]
63    pub mod _04_register_ini_settings {}
64
65    #[doc = include_str!("../doc/_06_module/_05_extension_information/index.md")]
66    pub mod _05_extension_information {}
67
68    #[doc = include_str!("../doc/_06_module/_06_register_class/index.md")]
69    pub mod _06_register_class {}
70
71    #[doc = include_str!("../doc/_06_module/_07_register_interface/index.md")]
72    pub mod _07_register_interface {}
73
74    #[cfg(phper_enum_supported)]
75    #[doc = include_str!("../doc/_06_module/_08_register_enum/index.md")]
76    pub mod _08_register_enum {}
77}
78
79/// TODO
80pub mod _07_allocation {}
81
82/// TODO
83pub mod _08_handle_exception {}
84
85/// TODO
86pub mod _09_build_script {}
87
88/// TODO
89pub mod _10_integration_tests {}
90
91/// TODO
92pub mod _11_macros {}