Revision 12:438175c58b44, committed 2016-09-30

Comitter:

hirokimineshita

Date:

Fri Sep 30 04:14:43 2016 +0000

Parent:

11:11177c8a7915

Commit message:

+a

Changed in this revision

diff -r 11177c8a7915 -r 438175c58b44 l3gd20.h
--- a/l3gd20.h	Fri Sep 30 04:00:39 2016 +0000
+++ b/l3gd20.h	Fri Sep 30 04:14:43 2016 +0000
@@ -86,27 +86,99 @@
     /** function
      *
      * reset all register
-     * @return register number which return error 
+     * @return register number which return error (int)
      */
     int reg_reset();
     
     /** function
      *
      * send WHO_AM_I and return result
-     * @return 1:error 0:no error
+     * @return 1:error 0:no error (int)
      */
     int conect();
+    
+    /** function
+     *
+     * read 8bit register which set
+     * @param reg register number of what you want
+     * @return result (uint8_t)
+     */
     uint8_t read_8(uint8_t reg);
+    
+    /** function
+     *
+     * read 16bit register which set
+     * @param reg register number of what you want
+     * @return result (uint8_t)
+     */
     uint16_t read_16(uint8_t reg);
+    
+    /** function
+     *
+     * write 8bit to the register and check the register is realy set
+     * @param reg register number of what you want to write
+     * @param data register data what you want to write
+     * @return result 1:error 0:no error
+     */
     int write_8(uint8_t reg,uint8_t data);
+    
+    /** function
+     *
+     * only write 8bit to the register
+     * @param reg register number of what you want to write
+     * @param data register data what you want to write
+     */
     void s_write_8(uint8_t reg,uint8_t data);
+    
+    /** function
+     *
+     * write 16bit to the register and check the register is realy set
+     * @param reg register number of what you want to write
+     * @param data register data what you want to write
+     * @return result 1:error 0:no error
+     */
     int write_16(uint8_t reg,uint16_t data);
+    
+    /** function
+     *
+     * now writing
+     */
     int get_scale();
+    
+    /** function
+     *
+     * now writing
+     */
     int set_scale(int dps);
+    
+    /** function
+     *
+     * now writing
+     */
     int get_temp();
+    
+    /** function
+     *
+     * now writing
+     */
     int16_t get_rotate_by_bit(int axis);
+    
+    /** function
+     *
+     * now writing
+     */
     float get_rotate_by_rad(int axis);
+    
+    /** function
+     *
+     * now writing
+     */
     float get_rotate(int axis);
+    
+    /** function
+     *
+     * now writing
+     */
     float deg_to_rad(float deg);
 };