[pulseaudio-discuss] [PATCH] doc: Mostly fixing up i.e. versus i.e.\ in doxygen documentation

Peter Meerwald pmeerw at pmeerw.net
Tue Apr 16 06:15:11 PDT 2013

> > same for e.g. versus e.g.\ and e.g. versus E.g.
> > this is ueber-nitpicking: will anybody ever notice?

> You did, apparently ;-)
> Anyway, why should there be a \ after "e.g."?

to be compliant with doxygen magic

doxygen assumes that the first sentence of a description (terminated by a 
'.') is kind-of a summary of the text; doxygen puts some extra space after 
the first sentence

if the first sentence reads
"Bla bla e.g. bla bla."
then doxygen detects the end of the first sentence after 'e.g.' (the first 
'.' followed by whitespace)

"Bla bla e.g.\ bla bla." fixes this; the end of the first sentence is now 
correctly detected after 'bla.'

regards, p.


Peter Meerwald
+43-664-2444418 (mobile)

More information about the pulseaudio-discuss mailing list