[Xcb] Documentation Process

Uli Schlachter psychon at znc.in
Fri Jul 13 14:56:54 UTC 2018


On 08.07.2018 16:06, Thomas Fischer wrote:
> Hello,
> I wrote some documentation for a few functions. Every time I look through a
> man page and see "not yet documented" I add a todo. That way the functions
> that I use most often will be updated sooner, but I might add more after
> that.

Thanks, that's nice & good to hear.

> A lot of the error messages aren't yet documented, but it shouldn't be too
> hard to generate documentation from a default. I'm a little new to xml, is
> there a nice way / project specific way set up to do that? Specifically an
> Alloc error can potentially be thrown after most requests, but the reason
> is pretty standard.

Sorry, but I fail to understand the question. An XML file is just a text
file, so it can be edited with any text editor...? What do you mean with
"from a default"?

Q: Because it reverses the logical flow of conversation.
A: Why is putting a reply at the top of the message frowned upon?

More information about the Xcb mailing list