diff --git a/libraries/networking/src/AddressManager.h b/libraries/networking/src/AddressManager.h index e8793edc1d..74ec1c4266 100644 --- a/libraries/networking/src/AddressManager.h +++ b/libraries/networking/src/AddressManager.h @@ -252,8 +252,8 @@ public slots: * "127.0.0.1" or "localhost"), a file:/// address, a domain name, a named path * on a domain (starts with "/"), a position or position and orientation, or a user (starts with * "@"). - * @param {boolean} [fromSuggestions=false] - Set to true if the address is obtained from the "Goto" dialog. - * Helps ensure that user's location history is correctly maintained. + * @param {boolean} [fromSuggestions=false] - Set to true if the address is obtained from the "Explore" app. + * Helps ensure that the user's location history is correctly maintained. */ void handleLookupString(const QString& lookupString, bool fromSuggestions = false); @@ -390,10 +390,10 @@ signals: void lookupResultIsNotFound(); /*@jsdoc - * Triggered when a request is made to go to an IP address. + * Triggered when a request is made to go to a URL or IP address. * @function location.possibleDomainChangeRequired - * @param {Url} domainURL - URL for domain - * @param {Uuid} domainID - The UUID of the domain to go to. + * @param {string} domainURL - The URL of the domain. + * @param {Uuid} domainID - The UUID of the domain to go to. May be "{@link Uuid|Uuid.NULL} if not yet known. * @returns {Signal} */ // No example because this function isn't typically used in scripts. diff --git a/libraries/networking/src/DomainHandler.cpp b/libraries/networking/src/DomainHandler.cpp index a77cde4ecc..e30e046013 100644 --- a/libraries/networking/src/DomainHandler.cpp +++ b/libraries/networking/src/DomainHandler.cpp @@ -368,7 +368,7 @@ void DomainHandler::setIsConnected(bool isConnected) { emit connectedToDomain(_domainURL); // FIXME: Reinstate the requestDomainSettings() call here in version 2021.2.0 instead of having it in - // NodeList::processDomainServerList(). + // NodeList::processDomainList(). /* if (_domainURL.scheme() == URL_SCHEME_HIFI && !_domainURL.host().isEmpty()) { // we've connected to new domain - time to ask it for global settings diff --git a/libraries/networking/src/NodeList.cpp b/libraries/networking/src/NodeList.cpp index a660099199..15da4f6d43 100644 --- a/libraries/networking/src/NodeList.cpp +++ b/libraries/networking/src/NodeList.cpp @@ -147,7 +147,7 @@ NodeList::NodeList(char newOwnerType, int socketListenPort, int dtlsListenPort) auto& packetReceiver = getPacketReceiver(); packetReceiver.registerListener(PacketType::DomainList, - PacketReceiver::makeUnsourcedListenerReference(this, &NodeList::processDomainServerList)); + PacketReceiver::makeUnsourcedListenerReference(this, &NodeList::processDomainList)); packetReceiver.registerListener(PacketType::Ping, PacketReceiver::makeSourcedListenerReference(this, &NodeList::processPingPacket)); packetReceiver.registerListener(PacketType::PingReply, @@ -357,7 +357,7 @@ void NodeList::sendDomainServerCheckIn() { if (publicSockAddr.isNull()) { // we don't know our public socket and we need to send it to the domain server - qCDebug(networking_ice) << "Waiting for inital public socket from STUN. Will not send domain-server check in."; + qCDebug(networking_ice) << "Waiting for initial public socket from STUN. Will not send domain-server check in."; } else if (domainHandlerIp.isNull() && _domainHandler.requiresICE()) { qCDebug(networking_ice) << "Waiting for ICE discovered domain-server socket. Will not send domain-server check in."; handleICEConnectionToDomainServer(); @@ -401,6 +401,8 @@ void NodeList::sendDomainServerCheckIn() { return; } + // WEBRTC TODO: Move code into packet library. And update reference in DomainConnectRequest.js. + auto domainPacket = NLPacket::create(domainPacketType); QDataStream packetStream(domainPacket.get()); @@ -709,7 +711,9 @@ void NodeList::processDomainServerConnectionTokenPacket(QSharedPointer message) { +void NodeList::processDomainList(QSharedPointer message) { + + // WEBRTC TODO: Move code into packet library. And update reference in DomainServerList.js. // parse header information QDataStream packetStream(message->getMessage()); diff --git a/libraries/networking/src/NodeList.h b/libraries/networking/src/NodeList.h index 2ffac59702..9dea08c0a9 100644 --- a/libraries/networking/src/NodeList.h +++ b/libraries/networking/src/NodeList.h @@ -109,7 +109,7 @@ public slots: void sendDomainServerCheckIn(); void handleDSPathQuery(const QString& newPath); - void processDomainServerList(QSharedPointer message); + void processDomainList(QSharedPointer message); void processDomainServerAddedNode(QSharedPointer message); void processDomainServerRemovedNode(QSharedPointer message); void processDomainServerPathResponse(QSharedPointer message); diff --git a/libraries/networking/src/udt/BasePacket.cpp b/libraries/networking/src/udt/BasePacket.cpp index 12a174b7d3..777e7780a1 100644 --- a/libraries/networking/src/udt/BasePacket.cpp +++ b/libraries/networking/src/udt/BasePacket.cpp @@ -57,7 +57,7 @@ BasePacket::BasePacket(qint64 size) { } // Sanity check - Q_ASSERT(size >= 0 || size < maxPayload); + Q_ASSERT(size >= 0 && size <= maxPayload); _packetSize = size; _packet.reset(new char[_packetSize]()); diff --git a/libraries/networking/src/udt/NetworkSocket.h b/libraries/networking/src/udt/NetworkSocket.h index b946ab0bd0..dfd9fe5e72 100644 --- a/libraries/networking/src/udt/NetworkSocket.h +++ b/libraries/networking/src/udt/NetworkSocket.h @@ -79,7 +79,7 @@ public: qint64 writeDatagram(const QByteArray& datagram, const HifiSockAddr& sockAddr); /// @brief Gets the number of bytes waiting to be written. - /// @detail For UDP, there's a single buffer used for all destinations. For WebRTC, each destination has its own buffer. + /// @details For UDP, there's a single buffer used for all destinations. For WebRTC, each destination has its own buffer. /// @param socketType The type of socket for which to get the number of bytes waiting to be written. /// @param port If a WebRTC socket, the data channel for which to get the number of bytes waiting. /// @return The number of bytes waiting to be written. diff --git a/libraries/networking/src/udt/PacketHeaders.h b/libraries/networking/src/udt/PacketHeaders.h index 819551045a..d57fa9f663 100644 --- a/libraries/networking/src/udt/PacketHeaders.h +++ b/libraries/networking/src/udt/PacketHeaders.h @@ -10,6 +10,8 @@ // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html // +// WEBRTC TODO: Rename / split up into files with better names. + #ifndef hifi_PacketHeaders_h #define hifi_PacketHeaders_h diff --git a/libraries/networking/src/webrtc/WebRTCSocket.h b/libraries/networking/src/webrtc/WebRTCSocket.h index ed33608859..9b2011b620 100644 --- a/libraries/networking/src/webrtc/WebRTCSocket.h +++ b/libraries/networking/src/webrtc/WebRTCSocket.h @@ -124,9 +124,9 @@ public: public slots: /// @brief Handles the WebRTC data channel receiving a message. + /// @details Queues the message to be read via readDatagram. /// @param dataChannelID The data channel that the message was received on. /// @param message The message that was received. - /// @detail Queues the message to be read via readDatagram. void onDataChannelReceivedMessage(int dataChannelID, const QByteArray& message); signals: diff --git a/tools/doxygen/Doxyfile b/tools/doxygen/Doxyfile index ac8136a0c5..ee7ac1e2e1 100644 --- a/tools/doxygen/Doxyfile +++ b/tools/doxygen/Doxyfile @@ -509,7 +509,7 @@ EXTRACT_PACKAGE = NO # included in the documentation. # The default value is: NO. -EXTRACT_STATIC = NO +EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, @@ -794,7 +794,7 @@ CITE_BIB_FILES = # messages are off. # The default value is: NO. -QUIET = NO +QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES