Where is the doc ?

[ghost]

Where is the doc ? The Wiki is empty, and there is no good example..

[tehnick]

@zadlg What is the problem with README?

[tehnick]

As for examples, you may look at projects which already use this library.

[ghost]

@zadlg What is the problem with README?

This is a README, not a doc.

As for examples, you may look at projects which already use this library.

Again, these are examples, not a doc.

[dkonigsberg]

This library is intended to be a C implementation of the libsignal-protocol-java library. If that library adds the sort of documentation you're asking for, then I'll certainly port it over and make a version that's relevant to this library. Until then, I have nothing specific to go on for this request.

[ghost]

So if we want the doc, we have to clone libsignal-protocol-java then (I guess) use javadoc and finally read the doc ?

[dkonigsberg]

How exactly do you define the term "doc" in the context of this ticket?

If you define "doc" as "HTML documentation generated from comment tags in the source code", then this is a valid request to add doc generation (via something like doxygen) to the library.

If you define "doc" as "documentation on the library, its components, development, and general usage in the context of an application implementing the Signal Protocol for messaging" then I'll defer to whether or not the Java library has something first.

I assumed the latter, but now I'm wondering if you meant the former.

[ghost]

I meant both ? ;)

[ghost]

Anyway, I can try writing the doxygen, if you want.

[kaushalyap]

@dkonigsberg , @drizt , @christophhagen
Please provide some docs with examples .

[vzaliva]

As for examples, you may look at projects which already use this library.

I am wondering what projects are using this library