[pulseaudio-discuss] [PATCH] doxygen: Replace "\deprecated" with "\b Deprecated."
tanu.kaskinen at linux.intel.com
Mon Nov 11 03:43:39 PST 2013
On Fri, 2013-11-08 at 20:29 +0100, Thomas Martitz wrote:
> Am 08.11.2013 14:46, schrieb Tanu Kaskinen:
> > The effect of the \deprecated tag is (for a reason unknown to me) that
> > all documentation for the tagged entity is removed. That's not nice,
> > so this patch replaces the tag with plain text "Deprecated" with bold
> > formatting.
> Have you tried "GENERATE_DEPRECATEDLIST = YES" in doxygen.conf? It's
> seems to be set to NO.
No, I hadn't tried that. Now I have. The result was that in the summary
part of e.g. pa_card_port_info there was no text for the "profiles"
field, but the detailed documentation for "profiles" contained
everything it was supposed to, so setting GENERATE_DEPRECATEDLIST = YES
was a definite improvement. I still would prefer to make it easy to see
already in the summary section that the "profiles" field is deprecated,
so I'd prefer to merge this patch, but if I'm alone with that opinion,
I'm fine with just changing GENERATE_DEPRECATEDLIST to YES.
More information about the pulseaudio-discuss