[PATCH 8/8] doc: Added % to remove some self-references from doxygen output

Bill Spitzak spitzak at gmail.com
Mon Nov 10 10:42:32 PST 2014


On 11/09/2014 02:14 PM, Peter Hutterer wrote:

> looks like there's a typo here ("avilable"), might be worth a follow-up
> patch.

I'll put in a new patch with this fixed, as well as the other typo 
somebody noticed.

> That aside: not a big fan of this patch, I'd prefer to see it
> highlighted. The linking is excessive but at least cursive or bold would be
> nice here. Then again, if it requires extra markup in the comments I'm not
> sure it's worthwhile.

This was a judgement call I made, but it may be best to just leave it 
as-is to see what other people think. It is possible to remove links to 
functions by removing the () from them, but any other possible change 
from a link requires more markup.

I agree it is not appealing to have to add text to remove unwanted 
markup. Also copy & paste of docs will require adjusting all the % signs 
for the pasted location. It would be nice if Doxygen did something like 
wikipedia does, where a link to self is replaced with bold text. Another 
helpful thing might be to not link the same thing more than once in a 
single subject.

I think I will remove this patch for now.

> Rest of the series: Acked-by: Peter Hutterer <peter.hutterer at who-t.net>

Okay I will post a new set with these few fixes soon.


More information about the wayland-devel mailing list