Improve the documentation

[diederik]

Throughout KMess, the most important things are documented with Doxygen comments. But many of those comments are outdated, and a lot of class still lack of Doxygen comments. We need to update the existing apidox and complete the missing ones.

Also, he new chat xsl styles should be documented, so users will be able to create more styles themselves.

The XSL's Wiki is on the [Creating chat styles] page. Currently it lacks examples, and guidance in the XSL/CSS areas. The explanation ends abruptly.

The documentation also needs to be updated for the final XML changes we've made before 1.5.

[richard]

I'd be happy to take this one on if i could have more information about what is needed. This documentation in the link seems to be pretty comprehensive to me. Also where is the kmess wiki?

[amroth]

Here's the Wiki: https://amroth.hopto.org/kmess/wiki

Only problem is that it's not on a public site, and I don't have enough upload bandwidth nor a server powerful enough to handle the traffic.

For now, let's just publish that page, with a link in the kmess.org site's left panel, "contribute", linking to the http://www.kmess.org/creating-chatstyles/ page.

Anyone with access to the site?

[richard]

think its just diederik

[diederik]

The tutorial has moved to the wiki here.

This documentation in the link seems to be pretty comprehensive to me.

Yes, but it lacks examples and guidance in the XSL / CSS area's. You'll notice the story ends abruptly. The documentation also needs to be updated for the final XML changes we've made before 1.5.

[diederik]

This can also be done in a 1.5.1 or 1.6 timeframe. Releasing is more important.

[amroth]

my point exactly: I'll move it to the 1.6 milestone, with reserve to finish it before 1.6