commit 2ed62fb2b61b9aed8876b3494217b23e47bb9fba
author Jeff Thompson <jefft0@gmail.com> Tue Jul 16 18:10:30 2013 -0700
committer Jeff Thompson <jefft0@gmail.com> Tue Jul 16 18:10:30 2013 -0700
tree 1b2a3841dfa766e055e39979a6a803124eb0884d
parent b002f900734f90e9b02530d1721feaa7577582e0

Added doc comment

ndn-cpp/transport/TcpTransport.hpp

diff --git a/ndn-cpp/transport/TcpTransport.hpp b/ndn-cpp/transport/TcpTransport.hpp
index 8be6a73..8b714e8 100644
--- a/ndn-cpp/transport/TcpTransport.hpp
+++ b/ndn-cpp/transport/TcpTransport.hpp
@@ -20,6 +20,10 @@
     ndn_ = 0;
   }
   
+  /**
+   * 
+   * @param ndn Not a shared_ptr because we assume that it will remain valid during the life of this Transport object.
+   */
   virtual void connect(NDN &ndn);
   
   virtual void send(unsigned char *data, unsigned int dataLength);

ndn-cpp/transport/Transport.hpp

diff --git a/ndn-cpp/transport/Transport.hpp b/ndn-cpp/transport/Transport.hpp
index 94e60ec..70f7dbc 100644
--- a/ndn-cpp/transport/Transport.hpp
+++ b/ndn-cpp/transport/Transport.hpp
@@ -11,6 +11,10 @@
 class NDN;  
 class Transport {
 public:
+  /**
+   * 
+   * @param ndn Not a shared_ptr because we assume that it will remain valid during the life of this Transport object.
+   */
   virtual void connect(NDN &ndn);
   
   virtual void send(unsigned char *data, unsigned int dataLength);