Documentation

[Arteneko]

Hey there !

I took a look but couldn't find any form of documentation, the only "guide" related to the project being the quick example.

Is a documentation in preparation or won't this library have any documentation ?

[mattgodbolt]

The documentation is the code and the examples I'm afraid. It's pretty straightforward though. Did you find the tutorial?

[Arteneko]

Well, I saw it, and it's a good place to start working with the library, but a lot of other modules and classes are staying undocumented, like for example the HybiPacketDecoder, the Connection or the PageRequest.

Individual documentation for modules would greatly help devs finding what they need, and with in-source comments it would be quite easy to generate, there's a lot of already-made tools to generate the javadoc-style documentation in multiple languages.

[mattgodbolt]

Cool; thanks for the feedback. To use Seasocks, you shouldn't need to know about too much other that the things exported in the headers in the seasocks directory.

Just to clarify:

• HybiPacketDecoder is an internal class and you shouldn't need to know about it :)
• The PageRequest is another internal class. It is used through its interface Request. It represents a request for a particular page. The Request class is fairly well documented in its header.
• The Connection is mostly only through its WebSocket interface (which extends Request) , both of which are documented in their respective header files.

I'd be happy to help some more, and I'd definitely take further suggestions on the kinds of documentation you'd find useful.

[szdytom]

3 years past already but I see no doc still

[hoytech]

@szdytom - You're lucky, the job is available.

Wiki is here: https://github.com/mattgodbolt/seasocks/wiki/Seasocks-quick-tutorial