Re: Documentation Process

Uli Schlachter <[email protected]>
Newsgroups gmane.comp.freedesktop.xcb
Message-ID <[email protected]>
Hi,

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"?

Cheers,
Uli
-- 
Q: Because it reverses the logical flow of conversation.
A: Why is putting a reply at the top of the message frowned upon?
_______________________________________________
Xcb mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/xcb
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.