diff options
| author |   Romain Forlot <romain.forlot@iot.bzh> | 2017-08-15 15:58:09 +0200 |
|---|---|---|
| committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-08-15 15:58:09 +0200 |
| commit | 20c82ee40b442e5b64079155e2eafaf22440d1fb (patch) | |
| tree | d942b5479d219d22e638c8a4c8ea55c45d247d62 /docs/dev_guide | |
| parent | 35e2d30757ec154f14dd2a44a2146bf71be02063 (diff) | |
Update documentation about properties
Change-Id: Id5f3349889d0b26ebec7e3a90a549b0ceb4fb493
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/dev_guide')
| -rw-r--r-- | docs/dev_guide/1_Quickstart.md | 14 | ||||
| -rw-r--r-- | docs/dev_guide/3_advanced_usage.md | 6 |
2 files changed, 16 insertions, 4 deletions
diff --git a/docs/dev_guide/1_Quickstart.md b/docs/dev_guide/1_Quickstart.md index fe11970..baf70ae 100644 --- a/docs/dev_guide/1_Quickstart.md +++ b/docs/dev_guide/1_Quickstart.md @@ -55,8 +55,18 @@ widget package with the property **LABELS**: Choose between: - **BINDING**: Shared library that be loaded by the AGL Application Framework -- **HTDOCS**: Root directory of a web app -- **DATA**: Resources used by your application +- **BINDINGV2**: Shared library that be loaded by the AGL Application Framework. + This has to be accompagnied with a JSON file named like the *${OUTPUT_NAME}-apidef* of + the target that describe the API with OpenAPI syntax (e.g: *mybinding-apidef*). + Or you can choose the name by setting the *CACHE* cmake variable *OPENAPI_DEF* + (***CAUTION***: setting a CACHE variable is needed, or set a normal variable + with the *PARENT_SCOPE* option to make it visible for the parent scope + where the target is defined) JSON file will be used to generate header file + using `afb-genskel` tool. +- **HTDOCS**: Root directory of a web app. This target has to build its + directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} +- **DATA**: Resources used by your application. This target has to build its + directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} - **EXECUTABLE**: Entry point of your application executed by the AGL Application Framework diff --git a/docs/dev_guide/3_advanced_usage.md b/docs/dev_guide/3_advanced_usage.md index cc58bb0..cf85986 100644 --- a/docs/dev_guide/3_advanced_usage.md +++ b/docs/dev_guide/3_advanced_usage.md @@ -38,8 +38,10 @@ Choose between: with the *PARENT_SCOPE* option to make it visible for the parent scope where the target is defined) JSON file will be used to generate header file using `afb-genskel` tool. -- **HTDOCS**: Root directory of a web app -- **DATA**: Resources used by your application +- **HTDOCS**: Root directory of a web app. This target has to build its + directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} +- **DATA**: Resources used by your application. This target has to build its + directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} - **EXECUTABLE**: Entry point of your application executed by the AGL Application Framework |