How do I specify a keyword for Dash with Doxygen?
I am using Doxygen to generate documentation for my project that generates docsets that work almost perfectly with dashes .
I want to know how to set a search keyword in a dash; the default is "unknown":
What do I need to change so that it reads something other than "unknown:". Can I change this in Doxygen?
source to share
I am a Dash developer. Dash uses the DocSetPlatformFamily key in the Info.plist file inside the docset to define the default keyword. Unfortunately, there is no way for Doxygen to set this value as far as I know. I will contact the Doxygen team and ask them to add this option. Feel free to do the same.
Currently my best recommendation would be to write a post-generation script that would add the required key to the Info.plist file (it's just a text file).
For example, this should work:
perl -pi -w -e "s/<\/dict>/<key>DocSetPlatformFamily<\/key><string>__DESIRED KEYWORD__<\/string><key>DashDocSetFamily<\/key><string>doxy<\/string><\/dict>/s" Info.plist
Note. I also added a "DashDocSetFamily" entry with the value "doxy". This will cause Dash to treat the docset as generated by Doxygen and display a filtered table of contents.
If you haven't found them yet, here are some recommended settings for generating a Docode docset for use in Dash:
SEARCHENGINE = NO
DISABLE_INDEX = YES
GENERATE_TREEVIEW = NO
source to share