markwatkinson / luminous

Accurate and powerful syntax highlighting library
http://luminous.asgaard.co.uk
GNU Lesser General Public License v2.1
50 stars 5 forks source link

options/settings documentation #8

Closed markwatkinson closed 13 years ago

markwatkinson commented 13 years ago

The options/settings model (luminous::set() and luminous::setting()) is hard to document properly because it's all dynamic and Doxygen can't pick out the valid options from the options array's keys.

Solution: implement a new class (struct) with hard each valid option coded as an attribute name which can be documented inline.

This won't change the external API or calling procedure as it is all hidden behind set() and setting() anyway.