[PATCH v2] doc: two patches

Bill Spitzak spitzak at gmail.com
Thu Dec 18 14:00:29 PST 2014



On 12/18/2014 05:56 AM, Pekka Paalanen wrote:
> On Tue, 16 Dec 2014 19:23:01 -0800
> Bill Spitzak <spitzak at gmail.com> wrote:
>
>> These supersede my previous patches for this.
>>
>> The first bug fix has been updated to use macros like $(MKDIR_P)
>>
>> The second one, which is a makefile cleanup, not a bug fix, has
>> been updated so that make distcheck works.
>>
>
> Hi,
>
> one of these patches causes one more warning to appear during build:
>
>    GEN      en-US/ClientAPI.xml
> warning: failed to load external entity "../../doc/doxygen/xml/Client/wayland-client_8h.xml"
> warning: failed to load external entity "../../doc/doxygen/xml/Client/wayland-util_8h.xml"
>    GEN      en-US/ServerAPI.xml
> warning: failed to load external entity "../../doc/doxygen/xml/Server/wayland-server_8h.xml"
> warning: failed to load external entity "../../doc/doxygen/xml/Server/wayland-util_8h.xml"
>
>
> The warnings about wayland-client and wayland-server are old, the
> warning about wayland-util is new.
>
> When I diff the resulting (installed) HTML directories, the difference
> is that after the patches, wl_list_*() and wl_array_*() functions are
> no longer listed (undocumented) in the client or server appendices.
> These are the functions that would be listed after wl_log().
>
> We're not really losing anything there, I just wanted to let you know,
> since I'm not sure this was intentional.

I think you are right, the older version only moved client_8h and 
server_8h out of the way, my version moves *_8h and thus also moves util_8h.

However I did not lose the documentation for the wl_list and wl_array 
functions, and in fact I am working on some more modifications that move 
these next to the objects and I added a lot of \memberof comments to fix 
this. May depend on Doxygen version? I am running 1.7.6, but can test 
1.8.6 as well, I will try this next.


More information about the wayland-devel mailing list