Diff: GPS_INT.h

Revision:

1:fbe835e114bb

Parent:

0:4b6c377342d9

Child:

2:0af5025cd632

--- a/GPS_INT.h	Sun Jul 08 02:30:46 2018 +0000
+++ b/GPS_INT.h	Sun Jul 08 03:30:42 2018 +0000
@@ -1,27 +1,44 @@
-/*
-Copyright (c) 2018 @j_rocket_boy(Twitter)
-
-UART接続のGPSを割り込み処理で受信するライブラリ
-このライブラリはMITライセンスです．
-
-Receive GPS of UART connection by interrupt processing
-This library is released under the MIT License.
-
-About MIT license
-https://opensource.org/licenses/mit-license.php
+// -*- coding: utf-8 -*-
+/**
+ @file      GPS_INT.h
+ @brief     Recieve GPS using Interrupt
+ 
+ @author    D.Nakayama
+ @version   1.0
+ @date      2018-07-08  D.Nakayama  Written for C++/mbed.
+ 
+ 
+ @see 
+ Copyright (C) 2017 T.Kawamura.
+ Released under the MIT license.
+ http://opensource.org/licenses/mit-license.php
+ 
 */
 
 #ifndef INCLUDED_GPS_INT_h_
 #define INCLUDED_GPS_INT_h_
 #include "mbed.h"
 
+/**
+    @class  GPS_INT
+  @brief    "Recieve GPS class" using Interrupt
+*/
 class GPS_INT{
-
 public:
 
     //コンストラクタ
+    /**
+         @brief Create a new gps(UART).
+         @param txpin   Tx pin name (Defined in PinName.h)
+         @param rxpin   Rx pin name (Defined in PinName.h)
+         @param baudrate    Baudrate (ex: 4800). Default value is 9600.
+    */
     GPS_INT(PinName tx, PinName rx, int baud = 9600);
     //デストラクタ
+    /**
+         @brief Disable the gps Port.
+         @param No parameters.
+    */
     virtual ~GPS_INT();
 
     bool location_is_update(void);      //位置情報が更新されたか(緯度，経度，DOP)