From fd1cfc19cbc2ff1adfbcce85a540914f2367c8df Mon Sep 17 00:00:00 2001
From: tho <tho@wiback.org>
Date: Tue, 13 Nov 2007 13:19:13 +0000
Subject: [PATCH] some doc fixing
---
Examples/Sniffer/Doxyfile | 4 ++-
Examples/Sniffer/Mainpage.dox | 4 +--
Socket/Protocols/INet/UDPSocketHandle.hh | 4 +--
Socket/Protocols/UN/UNDatagramSocketHandle.hh | 6 ++--
.../UN/UNDatagramSocketHandle.test.cc | 29 ++++++++++---------
5 files changed, 24 insertions(+), 23 deletions(-)
diff --git a/Examples/Sniffer/Doxyfile b/Examples/Sniffer/Doxyfile
index 1c41e3503..da7fce165 100644
--- a/Examples/Sniffer/Doxyfile
+++ b/Examples/Sniffer/Doxyfile
@@ -7,4 +7,6 @@ TAGFILES = \
"$(TOPDIR)/Scheduler/doc/Scheduler.tag" \
"$(TOPDIR)/Packets/doc/Packets.tag" \
"$(TOPDIR)/Socket/doc/Socket.tag" \
- "$(TOPDIR)/Utils/doc/Utils.tag"
+ "$(TOPDIR)/Utils/doc/Utils.tag" \
+ "$(TOPDIR)/doc/overview.tag"
+
\ No newline at end of file
diff --git a/Examples/Sniffer/Mainpage.dox b/Examples/Sniffer/Mainpage.dox
index ebd3c210f..7d443a4ad 100644
--- a/Examples/Sniffer/Mainpage.dox
+++ b/Examples/Sniffer/Mainpage.dox
@@ -175,8 +175,8 @@
This function is straight forward. The exception handling is the same as in \c loop_main(). The
code then just creates a \c Sniffer instance and calls it's \c run() member.
- \see \ref components \n
- \ref build \n
+ \see \ref senf_components \n
+ \ref senf_build \n
<a href="../../../../Socket/doc/html/index.html"><b>libSocket API reference</b></a> \n
<a href="../../../../Packets/doc/html/index.html"><b>libPackets API reference</b></a> \n
<a href="../../../../Utils/doc/html/index.html"><b>libUtils API reference</b></a>
diff --git a/Socket/Protocols/INet/UDPSocketHandle.hh b/Socket/Protocols/INet/UDPSocketHandle.hh
index 3a8535452..d114c3d6a 100644
--- a/Socket/Protocols/INet/UDPSocketHandle.hh
+++ b/Socket/Protocols/INet/UDPSocketHandle.hh
@@ -101,7 +101,7 @@ namespace senf {
///< Create client socket and bind
/**< Creates a new client socket and bind to the given
address.
- \param[in] local address to bind to */
+ \param[in] address local address to bind to */
/**< \note This member is implicitly called from the
ProtocolClientSocketHandle::ProtocolClientSocketHandle()
constructor */
@@ -165,7 +165,7 @@ namespace senf {
///< Create client socket and connect
/**< Creates a new client socket and bind to the given
address.
- \param[in] local address to bind to */
+ \param[in] address local address to bind to */
/**< \note This member is implicitly called from the
ProtocolClientSocketHandle::ProtocolClientSocketHandle()
constructor */
diff --git a/Socket/Protocols/UN/UNDatagramSocketHandle.hh b/Socket/Protocols/UN/UNDatagramSocketHandle.hh
index 20c9977dc..a8d709420 100644
--- a/Socket/Protocols/UN/UNDatagramSocketHandle.hh
+++ b/Socket/Protocols/UN/UNDatagramSocketHandle.hh
@@ -34,8 +34,6 @@
#include "../../../Socket/BufferingPolicy.hh"
#include "../../../Socket/ProtocolClientSocketHandle.hh"
-
-
//#include "UNDatagramSocketHandle.mpp"
///////////////////////////////hh.p////////////////////////////////////////
@@ -56,7 +54,7 @@ namespace senf {
/** \brief Unix Domain Datagram Socket Protocol
\par Socket Handle typedefs:
- \ref UNDatagramSocketHandle (ProtocolClientSocketHandle)
+ \ref UNDatagramClientSocketHandle (ProtocolClientSocketHandle)
\par Policy Interface: (to be checked)
ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
@@ -93,7 +91,7 @@ namespace senf {
///< Create client socket and bind
/**< Creates a new client socket and bind to the given
address.
- \param[in] local address to bind to */
+ \param[in] address local address to bind to */
/**< \note This member is implicitly called from the
ProtocolClientSocketHandle::ProtocolClientSocketHandle()
constructor */
diff --git a/Socket/Protocols/UN/UNDatagramSocketHandle.test.cc b/Socket/Protocols/UN/UNDatagramSocketHandle.test.cc
index 6eb446021..b39fd0ad4 100644
--- a/Socket/Protocols/UN/UNDatagramSocketHandle.test.cc
+++ b/Socket/Protocols/UN/UNDatagramSocketHandle.test.cc
@@ -35,23 +35,24 @@
BOOST_AUTO_UNIT_TEST(unDatagramSocketHandle)
{
- std::string hallo = "Hallo Welt.";
- std::string testS = ".socket-UNDatagramSocketHandle.test";
-
- unlink(testS.c_str());
+ std::string testString ("Hallo Welt.");
+ std::string socketPath (".socket-UNDatagramSocketHandle.test");
- senf::UNSocketAddress addr (testS) ;
- senf::UNDatagramClientSocketHandle inputSocket(addr);
- senf::UNDatagramClientSocketHandle outputSocket;
+ unlink(socketPath.c_str());
- outputSocket.writeto( addr, hallo);
+ senf::UNSocketAddress addr (socketPath);
+ senf::UNDatagramClientSocketHandle inputSocket(addr);
+ senf::UNDatagramClientSocketHandle outputSocket;
- BOOST_CHECK_EQUAL( inputSocket.read(), hallo);
- outputSocket.close();
- inputSocket.close();
-
- if( unlink(testS.c_str()) != 0)
- perror( "unlink failed");
+ outputSocket.writeto( addr, testString);
+
+ BOOST_CHECK_EQUAL( inputSocket.read(), testString);
+
+ outputSocket.close();
+ inputSocket.close();
+
+ if( unlink(socketPath.c_str()) != 0)
+ perror( "unlink failed");
}
--
GitLab