From 63a8573cefed4f1cd210e82ea1d8cafe2782a49a Mon Sep 17 00:00:00 2001 From: nick black Date: Sun, 10 Apr 2022 07:39:37 -0400 Subject: [PATCH] clarify that flags is unused in selector/multiselect #2642 --- doc/man/man3/notcurses_multiselector.3.md | 2 ++ doc/man/man3/notcurses_selector.3.md | 2 ++ include/notcurses/notcurses.h | 4 ++-- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/man/man3/notcurses_multiselector.3.md b/doc/man/man3/notcurses_multiselector.3.md index d215ffd70..3be47ef37 100644 --- a/doc/man/man3/notcurses_multiselector.3.md +++ b/doc/man/man3/notcurses_multiselector.3.md @@ -76,6 +76,8 @@ on the scroll arrows will be handled. **ncmultiselector_destroy** destroys the backing **ncplane**, as does **ncmultiselector_create** in the event of any error. +As no flags exist, the **flags** option ought always be 0. + # RETURN VALUES **ncmultiselector_create** returns **NULL** on an error, in which case the diff --git a/doc/man/man3/notcurses_selector.3.md b/doc/man/man3/notcurses_selector.3.md index 8de6a2935..e3a09ee6b 100644 --- a/doc/man/man3/notcurses_selector.3.md +++ b/doc/man/man3/notcurses_selector.3.md @@ -89,6 +89,8 @@ on the scroll arrows will be handled. **ncselector_destroy** destroys the backing **ncplane**, as does **ncselector_create** in the event of any error. +As no flags exist, the **flags** option ought always be 0. + # RETURN VALUES **ncselector_create** returns **NULL** on an error, in which case the passed diff --git a/include/notcurses/notcurses.h b/include/notcurses/notcurses.h index 3c91c596d..7bbfaa360 100644 --- a/include/notcurses/notcurses.h +++ b/include/notcurses/notcurses.h @@ -3904,7 +3904,7 @@ typedef struct ncselector_options { uint64_t titlechannels;// title channels uint64_t footchannels; // secondary and footer channels uint64_t boxchannels; // border channels - uint64_t flags; // bitfield of NCSELECTOR_OPTION_* + uint64_t flags; // bitfield of NCSELECTOR_OPTION_*, currently unused } ncselector_options; API ALLOC struct ncselector* ncselector_create(struct ncplane* n, const ncselector_options* opts) @@ -3983,7 +3983,7 @@ typedef struct ncmultiselector_options { uint64_t titlechannels;// title channels uint64_t footchannels; // secondary and footer channels uint64_t boxchannels; // border channels - uint64_t flags; // bitfield of NCMULTISELECTOR_OPTION_* + uint64_t flags; // bitfield of NCMULTISELECTOR_OPTION_*, currently unused } ncmultiselector_options; API ALLOC struct ncmultiselector* ncmultiselector_create(struct ncplane* n, const ncmultiselector_options* opts)