[openrtm-commit:00019] r2073 - trunk/OpenRTM-aist/src/lib/rtm

[openrtm at openrtm.org]

Author: n-ando
Date: 2011-04-29 18:50:49 +0900 (Fri, 29 Apr 2011)
New Revision: 2073

Modified:
   trunk/OpenRTM-aist/src/lib/rtm/OutPort.h
Log:
Documentation of setTimestamp() function has been added.


Modified: trunk/OpenRTM-aist/src/lib/rtm/OutPort.h
===================================================================
--- trunk/OpenRTM-aist/src/lib/rtm/OutPort.h	2011-04-27 14:06:49 UTC (rev 2072)
+++ trunk/OpenRTM-aist/src/lib/rtm/OutPort.h	2011-04-29 09:50:49 UTC (rev 2073)
@@ -35,6 +35,27 @@
 #include <rtm/PortCallback.h>
 #include <rtm/OutPortConnector.h>
 
+/*!
+ * @if jp
+ * @brief ¥Ç¡¼¥¿¤Ë¥¿¥¤¥à¥¹¥¿¥ó¥×¤ò¥»¥Ã¥È¤¹¤ë
+ *
+ * ¥Ç¡¼¥¿¥Ý¡¼¥È¤Î¥Ç¡¼¥¿¤ËÂФ·¤Æ¥¿¥¤¥à¥¹¥¿¥ó¥×¤ò¥»¥Ã¥È¤¹¤ë¡£¥Ç¡¼¥¿¥Ý¡¼¥È
+ * ¤Î¥Ç¡¼¥¿¤Ï¹½Â¤ÂΤΥá¥ó¥Ð¡¼¤È¤·¤Æ tm.sec, tm.nsec ¤ò»ý¤ÄɬÍפ¬¤¢¤ë¡£
+ *
+ * @param data ¥¿¥¤¥à¥¹¥¿¥ó¥×¤ò¥»¥Ã¥È¤¹¤ë¥Ç¡¼¥¿¡£¼Â¹Ô¸å¼Â¹Ô»þ¤Î¥¿¥¤¥à¥¹
+ *             ¥¿¥ó¥×¤¬¥»¥Ã¥È¤µ¤ì¤ë
+ *
+ * @else
+ * @brief Setting timestamp to data
+ *
+ * This function sets timestamp to data of data port. This data should
+ * have tm.sec, tm.nsec as members of the structure.
+ *
+ * @param data Data to be set timestamp. After executing this
+ *             function, current timestamp is set to the data.
+ *
+ * @endif
+ */
 template <class DataType>
 void setTimestamp(DataType& data)
 {