diff options
| author | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2017-03-25 19:40:02 +0100 |
|---|---|---|
| committer | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2017-03-25 19:40:02 +0100 |
| commit | b338a9dc265d7bc46a2528ffc45f7bf6fba96620 (patch) | |
| tree | cc19ab8533d51e3a9cceb707ee4065a4a0ca86ff /src/sciteco.h | |
| parent | 7a9328b4d66d746f815d190751a2e3ad75e397a0 (diff) | |
| download | sciteco-b338a9dc265d7bc46a2528ffc45f7bf6fba96620.tar.gz | |
some minor Doxygen documentation improvements
* avoid warnings
* make sure Doxygen finds RBEntryOwnString
* it would be nice to strip the top level `SciTECO` namespace
but this is not supported without some macro magic that
ommit the namespace declaration when processing with
Doxygen.
Diffstat (limited to 'src/sciteco.h')
| -rw-r--r-- | src/sciteco.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/sciteco.h b/src/sciteco.h index b856210..664b69d 100644 --- a/src/sciteco.h +++ b/src/sciteco.h @@ -69,7 +69,8 @@ extern sig_atomic_t sigint_occurred; #define CTL_KEY(C) ((C) & ~0x40) /** * Control character of the escape key. - * Equivalent to CTL_KEY('[') or '\e'. + * Equivalent to CTL_KEY('[') or '\\e', + * but more portable. */ #define CTL_KEY_ESC 27 /** |