aboutsummaryrefslogtreecommitdiff
path: root/manual/specification.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2019-06-22 10:49:32 +0800
committerruki <waruqi@gmail.com>2019-06-22 10:49:32 +0800
commit2809e37a97e58c4920b4631052f9903af7a5a74e (patch)
treeafab38aa14e308a951a78912e0d2ab12fc9ec67d /manual/specification.md
parent0f4577a0a110c73796fd1e65c343bb9199da65d7 (diff)
downloadxmake-docs-2809e37a97e58c4920b4631052f9903af7a5a74e.tar.gz
xmake-docs-2809e37a97e58c4920b4631052f9903af7a5a74e.zip
add manual
Diffstat (limited to 'manual/specification.md')
-rw-r--r--manual/specification.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/manual/specification.md b/manual/specification.md
new file mode 100644
index 00000000..f3e89cac
--- /dev/null
+++ b/manual/specification.md
@@ -0,0 +1,18 @@
+## Naming conventions
+
+The interface is named according to some of the predefined specifications, which is more convenient to understand and easy to use.
+
+It's according to the following rules:
+
+| Interfaces | Description |
+| --------------------- | ---------------------------------------------------------------- |
+| `is_`/`has_` + xxx | Condition interfaces |
+| `set_` + xxx | Set and override the previous settings |
+| `add_` + xxx | Set and append settings |
+| `…s` + xxx *(plural)* | Support multi-parameters, .e.g:`add_files("*.c", "test.cpp")` |
+| `on_` + xxx | Set and override builtin script |
+| `before_` + xxx | Set and run this script before running builtin-script |
+| `after_` + xxx | Set and run this script after running builtin-script |
+| `scope("name")` | Define a description scope, .e.g `target("xxx")`, `option("xxx")`|
+| scope/settings | Indentation with spaces |
+