I added documentation for most of classes and methods available in TigaseSwift - equivalent of JavaDoc.

Still need to provide some development guide with some examples how to use library.

I created documentation in asciidoc format.

As I look at it in preview mode all looks good, however generated results using simple shell script are not so good.

%wojtek Could you look at this issue?

%kobit Where we should put generated documentation? For now project is not public.

We should put them where our rest documentation is: http://docs.tigase.org

I know the project is not public yet but it will be public.

Linked image files lacked width specification therefore weren't sized properly - I've added those.

In addition I've mavenized documentation section so it will be easier to build the whole documentation using jenkins and include on http://docs.tigase.org (v. http://docs.tigase.org/tigase-swift/snapshot/Tigase_Swift_Guide/html/).

Jenkins job were created as well: http://build.tigase.org/jenkins/job/private-tigase-swift-documentation/

%kobit Please check if all you expected is in documentation.

I've changed configuration to use native asciidoctor pdf creation instead of via docbook, which yield better results even though it's only alpha.

This looks good to me. It's a good starting point. I think we can add more content when we receive a specific questions from users/developers. So instead of answering questions you will simply add the information to the documentation. This way we will have documentation with content which is really useful to people.

By the way, is there a syntax coloring feature in the asciidoc?

Artur Hefczyc wrote:

By the way, is there a syntax coloring feature in the asciidoc?

Yes, it is supported - for the block sections it's possible it's a source code, for example

[source,java]
----
some code...
----

Source code blocks in this documentation files are already marked as

[source,swift]

so I suppose there is no support for coloring code in Swift - maybe no markup parser?

Andrzej Wójcik wrote:

so I suppose there is no support for coloring code in Swift - maybe no markup parser?

This depends on the highligher used, vide: http://asciidoctor.org/docs/user-manual/#source-code-blocks . Looking at documentations of source-highlighter only highlight.js seems to mention swift.

I followed this idea, checked available highlighters and used @prettify@. Now code highlighting works fine for single page HTML and for PDF, but it is not possible to add this to multipage HTML result as it is generated using docbook.