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

[Jon A. Cruz]

On 11/26/2014 10:22 AM, Bill Spitzak wrote:
> On 11/25/2014 11:52 PM, Pekka Paalanen wrote:
> 
>> 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.

I definitely think this sounds like an issue I should look into. One of
the projects I worked on was to figure out how to create design
documents from doxygen, and to coordinate design docs from multiple
teams working on multiple projects/features.

One key to getting overall documentation to work was to coordinate
identifiers to either end up with different ones or unified ones on a
case by case basis.

The *ideal* would be to get a single unified Doxygen pass working.
However, it does warrant investigation as to how close to that a
pragmatic solution appropriate to Wayland would get us. Two passes is
not that bad. Once I start to get details and options figured out it
definitely looks like Bill will be able to give feedback and guidance.


Jon A. Cruz