search

qxmpp-project / qxmpp

Cross-platform C++ XMPP client and server library
412 stars 196 forks source link

Few methods without documentation #430

Closed tehnick closed 2 years ago

tehnick commented 2 years ago

You have done great job for documenting library interfaces. Only few undocumented methods are left:

qxmpp-devel-1.4.0+272+g66bcf88f/src/base/QXmppByteStreamIq.h:15: warning: Member Mode (enumeration) of class QXmppByteStreamIq is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/base/QXmppByteStreamIq.h:46: warning: Member sid() const (function) of class QXmppByteStreamIq is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/base/QXmppByteStreamIq.h:47: warning: Member setSid(const QString &sid) (function) of class QXmppByteStreamIq is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/base/QXmppByteStreamIq.h:49: warning: Member activate() const (function) of class QXmppByteStreamIq is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/base/QXmppByteStreamIq.h:50: warning: Member setActivate(const QString &activate) (function) of class QXmppByteStreamIq is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/base/QXmppByteStreamIq.h:58: warning: Member isByteStreamIq(const QDomElement &element) (function) of class QXmppByteStreamIq is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/base/QXmppByteStreamIq.h:33: warning: Member zeroconf() const (function) of class QXmppByteStreamIq::StreamHost is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/base/QXmppByteStreamIq.h:34: warning: Member setZeroconf(const QString &zeroconf) (function) of class QXmppByteStreamIq::StreamHost is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/client/QXmppCallStream.h:27: warning: Member creator() const (function) of class QXmppCallStream is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/client/QXmppCallStream.h:28: warning: Member media() const (function) of class QXmppCallStream is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/client/QXmppCallStream.h:29: warning: Member name() const (function) of class QXmppCallStream is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/client/QXmppCallStream.h:30: warning: Member id() const (function) of class QXmppCallStream is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/client/QXmppCallStream.h:31: warning: Member setReceivePadCallback(std::function< void(GstPad *)> cb) (function) of class QXmppCallStream is not documented.
qxmpp-devel-1.4.0+272+g66bcf88f/src/client/QXmppCallStream.h:32: warning: Member setSendPadCallback(std::function< void(GstPad *)> cb) (function) of class QXmppCallStream is not documented.

Please write their description to reach 100% covering of documentation.

lnjX commented 2 years ago

I was unsure about ByteStreamIq and CallStream and didn't want to write anything wrong. That's why they're still missing.