I’m working on implementing support for the new dictionaries
, types
, and callbacks
arrays on entries in GroupData.json
. I’ve got some ideas and I’d like to get some other opinions on them as I work on macro changes.
Right now, I’m working on updates to APIRef
. What I’m doing is adding an optional second parameter which is a JSON object, options
, which lets you specify which items to include in the sidebar. What I’m wondering is a bit about both structure and a couple of ideas on other capabilities. The options I’m looking at are:
-
includeDictionaries
: Should the API’s dictionaries be listed? This could just be a binarytrue
orfalse
, or it could be something a little more flexible, like a string that takes values like"yes"
(include dictionaries),"no"
(don’t include dictionaries), or"important"
(include dictionaries which have a tagImportant
on them). That would give us all kinds of flexibility, such as being able to include dictionaries that are used from multiple interfaces but not the lesser ones. -
includeTypes
: Same as above, but for typedefs and enumerated types. -
includeCallbacks
: Same as above, but for callback types.
Question 1: Any opinions on the options
parameter as described above?
As for the default option configuration: right now, I’m defaulting to including dictionaries and types but not callbacks, but that can be changed easily enough. What I’m inclined to do is to implement the string form for options and default to "important"
for all three groups.
Question 2: Does the description of what I’m thinking of doing with the defaults make sense to you?
Since APIRef
is just listing “Related pages”, there’s no need to categorize; everything just goes into one long list. Other macros may sort things into groups; we’ll get to that in upcoming posts as I get to work on those macros.
Question 3: Any other thoughts on this?
I feel pretty good about this plan; things are coming along swimmingly. As soon as I get a some other opinions, I can finish things up pretty fast on APIRef
.