[openrtm-commit:00024] r405 - trunk/OpenRTM-aist-Python/OpenRTM_aist

[openrtm at openrtm.org]

Author: kurihara
Date: 2011-04-29 21:46:20 +0900 (Fri, 29 Apr 2011)
New Revision: 405

Modified:
   trunk/OpenRTM-aist-Python/OpenRTM_aist/OutPort.py
Log:
Documentation of setTimestamp() function has been added. refs 1869

Modified: trunk/OpenRTM-aist-Python/OpenRTM_aist/OutPort.py
===================================================================
--- trunk/OpenRTM-aist-Python/OpenRTM_aist/OutPort.py	2011-04-12 02:15:19 UTC (rev 404)
+++ trunk/OpenRTM-aist-Python/OpenRTM_aist/OutPort.py	2011-04-29 12:46:20 UTC (rev 405)
@@ -32,7 +32,27 @@
 
 import time
 
-# for C++
+
+##
+# @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)
 def setTimestamp(data):