diff options
| author | ruki <[email protected]> | 2017-02-04 21:15:28 +0800 |
|---|---|---|
| committer | ruki <[email protected]> | 2017-02-04 21:15:28 +0800 |
| commit | 150c46169b90eca734f65ca1f979cf291f5feeb0 (patch) | |
| tree | f30337744d005be45e3584b9b39e4b30250b7eb5 /docs | |
| parent | f05513b3f9725295f87b3a2959a80ad58c28fb48 (diff) | |
write manual apis for docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manual.md | 132 | ||||
| -rwxr-xr-x | docs/zh/manual.md | 132 |
2 files changed, 264 insertions, 0 deletions
diff --git a/docs/manual.md b/docs/manual.md index 616f7068c..4386fdf74 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -2,3 +2,135 @@ search: english --- +## Condition + +#### is_os +#### is_arch +#### is_plat +#### is_mode +#### is_kind +#### is_option + +## Root Scope + +#### set_project +#### set_version +#### add_subdirs +#### add_subfiles +#### add_plugindirs +#### add_packagedirs + +## Target Scope + +#### target +#### set_kind +#### set_strip +#### set_options +#### set_symbols +#### set_warnings +#### set_optimize +#### set_languages +#### set_headerdir +#### set_targetdir +#### set_objectdir +#### on_build +#### on_clean +#### on_package +#### on_install +#### on_uninstall +#### on_run +#### before_build +#### before_clean +#### before_package +#### before_install +#### before_uninstall +#### before_run +#### after_build +#### after_clean +#### after_package +#### after_install +#### after_uninstall +#### after_run +#### set_config_h +#### set_config_h_prefix +#### add_deps +#### add_links +#### add_files +#### add_headers +#### add_linkdirs +#### add_includedirs +#### add_defines +#### add_undefines +#### add_defines_h +#### add_undefines_h +#### add_cflags +#### add_cxflags +#### add_cxxflags +#### add_mflags +#### add_mxflags +#### add_mxxflags +#### add_ldflags +#### add_arflags +#### add_shflags +#### add_cfuncs +#### add_cxxfuncs +#### add_options +#### add_languages +#### add_vectorexts + +## Option Scope + +#### option +#### set_enable +#### set_showmenu +#### set_category +#### set_warnings +#### set_optimize +#### set_languages +#### set_description +#### add_bindings +#### add_rbindings +#### add_links +#### add_linkdirs +#### add_includedirs +#### add_cincludes +#### add_cxxincludes +#### add_cfuncs +#### add_cxxfuncs +#### add_ctypes +#### add_cxxtypes +#### add_cflags +#### add_cxflags +#### add_cxxflags +#### add_ldflags +#### add_vectorexts +#### add_defines +#### add_defines_if_ok +#### add_defines_h_if_ok +#### add_undefines +#### add_undefines_if_ok +#### add_undefines_h_if_ok + +## Task Scope + +#### set_menu +#### set_category +#### on_run + +## Platform Scope + +#### set_os +#### set_menu +#### set_hosts +#### set_archs +#### set_checker +#### set_tooldirs +#### on_load + +## Template Scope + +#### set_description +#### set_projectdir +#### add_macros +#### add_macrofiles + diff --git a/docs/zh/manual.md b/docs/zh/manual.md index 5f50a7401..9a415cd5a 100755 --- a/docs/zh/manual.md +++ b/docs/zh/manual.md @@ -3,3 +3,135 @@ nav: zh search: zh --- +## 条件判断 + +#### is_os +#### is_arch +#### is_plat +#### is_mode +#### is_kind +#### is_option + +## 根作用域 + +#### set_project +#### set_version +#### add_subdirs +#### add_subfiles +#### add_plugindirs +#### add_packagedirs + +## Target目标 + +#### target +#### set_kind +#### set_strip +#### set_options +#### set_symbols +#### set_warnings +#### set_optimize +#### set_languages +#### set_headerdir +#### set_targetdir +#### set_objectdir +#### on_build +#### on_clean +#### on_package +#### on_install +#### on_uninstall +#### on_run +#### before_build +#### before_clean +#### before_package +#### before_install +#### before_uninstall +#### before_run +#### after_build +#### after_clean +#### after_package +#### after_install +#### after_uninstall +#### after_run +#### set_config_h +#### set_config_h_prefix +#### add_deps +#### add_links +#### add_files +#### add_headers +#### add_linkdirs +#### add_includedirs +#### add_defines +#### add_undefines +#### add_defines_h +#### add_undefines_h +#### add_cflags +#### add_cxflags +#### add_cxxflags +#### add_mflags +#### add_mxflags +#### add_mxxflags +#### add_ldflags +#### add_arflags +#### add_shflags +#### add_cfuncs +#### add_cxxfuncs +#### add_options +#### add_languages +#### add_vectorexts + +## Option选项 + +#### option +#### set_enable +#### set_showmenu +#### set_category +#### set_warnings +#### set_optimize +#### set_languages +#### set_description +#### add_bindings +#### add_rbindings +#### add_links +#### add_linkdirs +#### add_includedirs +#### add_cincludes +#### add_cxxincludes +#### add_cfuncs +#### add_cxxfuncs +#### add_ctypes +#### add_cxxtypes +#### add_cflags +#### add_cxflags +#### add_cxxflags +#### add_ldflags +#### add_vectorexts +#### add_defines +#### add_defines_if_ok +#### add_defines_h_if_ok +#### add_undefines +#### add_undefines_if_ok +#### add_undefines_h_if_ok + +## Task任务 + +#### set_menu +#### set_category +#### on_run + +## Platform平台 + +#### set_os +#### set_menu +#### set_hosts +#### set_archs +#### set_checker +#### set_tooldirs +#### on_load + +## Template模板 + +#### set_description +#### set_projectdir +#### add_macros +#### add_macrofiles + |
