diff options
author | Romain Forlot <romain.forlot@iot.bzh> | 2018-01-05 18:06:13 +0100 |
---|---|---|
committer | Romain Forlot <romain.forlot@iot.bzh> | 2018-01-05 18:06:13 +0100 |
commit | 66d0ca11fe7e3ba7959492729b1e0ae9bca98540 (patch) | |
tree | 15a1073b8b0f3cbea0ed59c52e7de16d07a3ccf4 /docs/dev_guide/3_advanced_usage.md | |
parent | 4b265031de2f405e44fe595e99c29ffe2cfd72b9 (diff) |
Update documentation
Better description to use BINDINGV2 labels.
Adding documentation for macros:
- add_input_files
- set_openapi_filename
Change-Id: I7eb685faf4a5d4f92343d826877066b54b0012f0
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/dev_guide/3_advanced_usage.md')
-rw-r--r-- | docs/dev_guide/3_advanced_usage.md | 45 |
1 files changed, 39 insertions, 6 deletions
diff --git a/docs/dev_guide/3_advanced_usage.md b/docs/dev_guide/3_advanced_usage.md index 3ea8344..2ee78ce 100644 --- a/docs/dev_guide/3_advanced_usage.md +++ b/docs/dev_guide/3_advanced_usage.md @@ -33,12 +33,10 @@ Choose between: - **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, without the - extension, 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. + syntax (e.g: *mybinding-apidef*). + Or Alternatively, you can choose the name, without the extension, using macro + **set_openapi_filename**. If you use C++, you have to set + **PROJECT_LANGUAGES** with *CXX*. - **PLUGIN**: Shared library meant to be used as a binding plugin. Binding would load it as a plugin to extend its functionnalities. It should be named with a special extension that you choose with SUFFIX cmake target property or @@ -197,3 +195,38 @@ anything: ```cmake project_subdirs_add("[0-9]-*") ``` + +### set_openapi_filename + +Used with a target labelized **BINDINGV2** to define the file name, and +possibly a relative path with the current *CMakeLists.txt*. + +If you don't use that macro to specify the name of your definition file +then the default one will be used, *${OUTPUT_NAME}-apidef* with +**OUTPUT_NAME** as the [target property]. + +> **CAUTION** you must only specify the name **WITHOUT** the extension. + +```cmake +set_openapi_filename('binding/mybinding_definition') +``` + +[target property]: https://cmake.org/cmake/help/v3.6/prop_tgt/OUTPUT_NAME.html "OUTPUT_NAME property documentation" + +### add_input_files + +Create custom target dedicated for HTML5 and data resource files. This macro +provides syntax and schema verification for differents languages which are +about now: LUA, JSON and XML. + +You could change the tools used to check files with the following variables: + +- XML_CHECKER: set to use **xmllint** provided with major linux distribution. +- LUA_CHECKER: set to use **luac** provided with major linux distribution. +- JSON_CHECKER: no tools found at the moment. + +```cmake +add_input_file("${MY_FILES_LIST}") +``` + +> **NOTE**: an issue at the check step on a file will stop at the build step. |