clarify that flags is unused in selector/multiselect #2642

This commit is contained in:
nick black 2022-04-10 07:39:37 -04:00
parent 8dbfe858d9
commit 63a8573cef
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
3 changed files with 6 additions and 2 deletions

View File

@ -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

View File

@ -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

View File

@ -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)