[PATCH 0/7] Xserver-spec: another batch of updates

[Alan Coopersmith]

Matt Dew wrote:
> On Mon, 2010-11-29 at 14:51 -0800, Alan Coopersmith wrote:
>> Jeremy Huddleston wrote:
>>> Series:
>>> Reviewed-by: Jeremy Huddleston <jeremyhu at apple.com>
>>>
>>> Does the documentation include reference for these from inputstr.h which I recall being added in the past year or two:
>>>
>>> #define BitIsOn(ptr, bit) (!!(((BYTE *) (ptr))[(bit)>>3] & (1 << ((bit) & 7))))
>>> #define SetBit(ptr, bit)  (((BYTE *) (ptr))[(bit)>>3] |= (1 << ((bit) & 7)))
>>> #define ClearBit(ptr, bit) (((BYTE *)(ptr))[(bit)>>3] &= ~(1 << ((bit) & 7)))
>>> extern _X_EXPORT int CountBits(const uint8_t *mask, int len);
>> Not yet.  But as the inputstr.h header has lots of doxygen comments already,
>> perhaps some should just be added for those?
>>
>> I have been wondering if the API reference material in the server should
>> move to just being generated from doxygen, and make the docbook docs be
>> more introduction/tutorial/overview type material.
> 
> I remember people at XDS saying that they liked doxygen so I'm in favor
> of this!  And yes, I say this knowing full well I'll very likely be
> involved in doing the work.
> 
> Eventually not just the server, but libraries, extensions and drivers as
> well?

xcb already uses doxygen, so we're certainly heading in that direction on
the library side.   I don't know of any code it wouldn't be appropriate for,
but the server tends to get the most attention.

(I've also not looked into man page generation from doxygen, since for most
 of our libraries, the man pages are our traditional go-to documentation.)

-- 
	-Alan Coopersmith-        alan.coopersmith at oracle.com
	 Oracle Solaris Platform Engineering: X Window System