[PATCH 3/9] doc: preserve links produced by Doxygen

[Bill Spitzak]

On 11/25/2014 11:52 PM, Pekka Paalanen wrote:

> I'd be interested in hearing how we end up with
> a) missing targets, and b) duplicate targets.
>
> Could missing targets be fixed by documenting things that are not yet
> documented? If yes, that would probably be nice.

The missing targets are from portions of the doxygen output that is not 
copied to the final result, especially because only "classes" are copied 
and not other structures, but I think there was some other output that 
would require even more work to convert. I don't think it generates 
links to undocumented stuff, so a solution may be to remove the 
documentation (just change /** to /*) on things that do not want to be 
seen, and change the xslt to copy all the produced docs.

I think also doxygen does spuriously generate some links to non-existent 
targets.

> Or are duplicates perhaps due to us having, say, struct wl_display a
> different thing on server vs. client?

The duplicates are due mostly to wl_list (and similar things) being 
documented twice. But I think doxygen does generate some identical tags 
for the server and client documentation. The solution may be to edit one 
of these and add an extra letter to all the tags so there are no 
conflicts. Telling doxygen to document both in one pass caused it to mix 
all the calls together, probably a bad idea.