On 04/04/2017 03:02 PM, Dave Thaler wrote:
> I wouldn?t want to force people to NOT use doxygen markup comment blocks on
> private internal APIs.
> So instead what I proposed was
> ?anything published to out/ and NOT marked as experimental/preview/whatever?
> which requires we invent some way to mark something as experimental/preview.
It's not that hard to add your own definitions to the Doxyfile.
Here's a very lightly tested example - it seems to work, but would need
cleanup and polish, and there might be better ways...
ALIASES += experimental="\n<dl compact><dt><b
style=\"color:#ff0000\">Experimental:</b></dt><dd
style=\"color:#ff0000\">This feature is <i>experimental</i>. API
stability is NOT to be assumed.</dd></dl>\n"
which means if a function's doxy markup includes @experimental, a
section is emitted (in red) showing it as experimental - pasted here,
but losing the html highlighting:
Experimental:
This feature is experimental. API stability is NOT to be assumed.
Parameters
precision based on this parameter, current time is returned in
milliseconds or microseconds
Warning
This function may be sensitive to system time changes on platforms
which do not support a monotonic clock.
Returns
Returns current time in milliseconds or microseconds.
