[Xcb] [PATCH] Fill in some TODO bits for CreateWindow & InternAtom

Alan Coopersmith alan.coopersmith at oracle.com
Wed Nov 30 15:25:45 PST 2011


On 11/30/11 06:03, Peter Harris wrote:
> On 2011-11-30 00:57, Alan Coopersmith wrote:
>> +If `XCB_BACK_PIXMAP_NONE` is specified,
>
> I'd prefer to keep libxcb mangled names out of the shared XML files if
> possible. The other docs (eg. for MapWindow) use unmangled names.

There seems to be a mix in them already, with the mangled names used for
things like enum values.   That was part of the reason I sent the patch
to the list for people to look at instead of just doing a github pull
request (the other was to see if I overly mangled the technical details
of the parts I wrote).

> As an alternative, how difficult would it to be to generate the above from
>
> +If<enum name="BackPixmap" item="None" />  is specified,
>
> (or similar)? That way, in theory, the other language bindings can
> generate their own mangled name of choice for their docs. It means
> giving up on CDATA in most places, but I don't see any<  or&  used
> outside of the examples.

That makes sense to me, but doesn't fit with the current generator (I tried
something like that before realizing it couldn't work inside CDATA).

I'm also okay with getting the basic text fleshed out first and then fixing
this up, since it should be simple to do mass substitution later of the
mangled names with appropriate markup.

>  (Inside of the examples[1], they're clearly in
> C anyway, so CDATA and libxcb mangled names are fine).

And if someone wanted to generate docs for another language, we could wrap those
in something like <example lang="C"> and let them add <example lang="python">.

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



More information about the Xcb mailing list