Skip to content
Permalink
Browse files

Merge pull request #2942 from kodebach/codegen_doc

Minor documentation updates
  • Loading branch information...
markus2330 committed Sep 9, 2019
2 parents 95907d8 + 4168303 commit 8bef05c713f37600ea4a087ef2e05b9fc52612b2
Showing with 3 additions and 4 deletions.
  1. +1 −0 cmake/ElektraConfig.cmake.in
  2. +1 −3 doc/help/elektra-highlevel-gen.md
  3. +1 −1 doc/news/_preparation_next_release.md
@@ -66,6 +66,7 @@ set (Elektra_STATIC @BUILD_STATIC@)
# If <output_dir> is not set explicitly, it defaults to `CMAKE_CURRENT_BINARY_DIR`.
# `<params>...` and `<options>...` are omitted from the `kdb gen` call, if they aren't defined.
#
# Full examples can be found online: https://master.libelektra.org/examples/codegen
# ~~~
function (elektra_kdb_gen
template
@@ -7,11 +7,9 @@ with the basic features explained in [`kdb-gen-highlevel(1)`](kdb-gen-highlevel.

The parameters that are relevant to the concepts described here are (for the rest see [`kdb-gen-highlevel(1)](kdb-gen-highlevel.md)):

- `enumConv`: allowed values: `strcmp`, `switch`, `auto` (default)
- `embeddedSpec`: allowed values: `full` (default), `defaults`, `none`
- `specValidation`: allowed values: `none` (default), `minimal`

The `enumConv` option is described [below](#enums).
- `enumConv`: allowed values: `strcmp`, `switch`, `auto` (default)

Using `embeddedSpec` you can configure how much of the specification is embedded into your application. By default we use `full`. This means
the full specification is embedded into your application's binary. Since this can drastically increase the size of the binary, you can also
@@ -38,7 +38,7 @@ If you specifically want to use it with the High-Level API take a look at [this

We also created a new CMake function that will be available, if you include Elektra via CMake's
`find_package`. The function is called `elektra_kdb_gen` and can be used to tell CMake about files
that are generated via `kdb gen`. _(Klemens Böswirth)_
that are generated with `kdb gen`. _(Klemens Böswirth)_

### <<HIGHLIGHT2>>

0 comments on commit 8bef05c

Please sign in to comment.
You can’t perform that action at this time.