Hi Petr,

I updated the docs in TcpSocketBuffer to use \param. The Doxygen output looks really nice!

//! Writes \a bytes to the write buffer.
/*!
\param bytes are the bytes that should be buffered in the write buffer.
\param flush is a tip for tryWriteTo() whether it should not write to socket
until a write() has been called with \a flush = true.
\returns true if all the bytes were buffered and false if none were
buffered. \a bytes are never buffered partially.
*/

I know that’s not a big deal actually, but I’m wondering whether or not add a blank line between \param paragraphs. Doxygen doesn’t really care:

//! Writes \a bytes to the write buffer.
/*!
\param bytes are the bytes that should be buffered in the write buffer.

\param flush is a tip for tryWriteTo() whether it should not write to socket
until a write() has been called with \a flush = true.

\returns true if all the bytes were buffered and false if none were
buffered. \a bytes are never buffered partially.
*/

The latter kind of looks nicer without syntax highlighting and the former look quite nice with syntax highlighting. Maybe we should prefer the most readable form that requires as little formatting as possible.

Another thing is how useful you do find the call graph, references, reference by in the docs? They are actually really nice if one wants to study the code by reading the docs but I don’t know if anybody is doing so. This information also distracts attention form the brief, detailed, params, returns descriptions. Maybe we should try to visually separate them (maybe with a line and a smaller font). Ideas?

Regards,

Peter