[openrtm-commit:00038] r497 - branches/RELENG_1_0/jp.go.aist.rtm.RTC/src/jp/go/aist/rtm/RTC/port

[openrtm ＠ openrtm.org]

Author: fsi-katami
Date: 2011-05-09 11:00:39 +0900 (Mon, 09 May 2011)
New Revision: 497

Modified:
   branches/RELENG_1_0/jp.go.aist.rtm.RTC/src/jp/go/aist/rtm/RTC/port/OutPort.java
Log:
Documentation of setTimestamp() function has been added. refs 1868

Modified: branches/RELENG_1_0/jp.go.aist.rtm.RTC/src/jp/go/aist/rtm/RTC/port/OutPort.java
===================================================================
--- branches/RELENG_1_0/jp.go.aist.rtm.RTC/src/jp/go/aist/rtm/RTC/port/OutPort.java	2011-03-23 06:48:57 UTC (rev 496)
+++ branches/RELENG_1_0/jp.go.aist.rtm.RTC/src/jp/go/aist/rtm/RTC/port/OutPort.java	2011-05-09 02:00:39 UTC (rev 497)
@@ -71,12 +71,17 @@
      * {@.ja タイムスタンプを設定する。}
      * {@.en Sets timestamp.}
      * <p>
-     * {@.ja This function sets the timestamp.}
-     * {@.en This function sets the timestamp.}
+     * {@.ja データポートのデータに対してタイムスタンプをセットする。
+     * データポートのデータは構造体のメンバーとして 
+     * tm.sec, tm.nsec を持つ必要がある。}
+     * {@.en This function sets timestamp to data of data port. This data should
+     * have tm.sec, tm.nsec as members of the structure.}
      * </p>
      * @param data 
-     *   {@.ja 対象データ}
-     *   {@.en The target data}
+     *   {@.ja タイムスタンプをセットするデータ。実行後実行時のタイムス
+     *   タンプがセットされる}
+     *   {@.en Data to be set timestamp. After executing this
+     *   function, current timestamp is set to the data.}
      */
     public void setTimestamp(DataType data) {
         long nanotime = System.nanoTime();