Browse Source

grove: improve docstrings

Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
Sarah Knepper 10 years ago
parent
commit
751b0f1fe0
2 changed files with 6 additions and 5 deletions
  1. 1
    1
      src/grove/grove.cxx
  2. 5
    4
      src/grove/grove.h

+ 1
- 1
src/grove/grove.cxx View File

@@ -105,7 +105,7 @@ GroveLight::~GroveLight()
105 105
     mraa_aio_close(m_aio);
106 106
 }
107 107
 
108
-int GroveLight::value ()
108
+int GroveLight::value()
109 109
 {
110 110
     // rough conversion to lux, using formula from Grove Starter Kit booklet
111 111
     float a = (float) mraa_aio_read(m_aio);

+ 5
- 4
src/grove/grove.h View File

@@ -1,6 +1,7 @@
1 1
 /*
2 2
  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
3 3
  * Contributions: Mihai Tudor Panu <mihai.t.panu@intel.com>
4
+ * Contributions: Sarah Knepper <sarah.knepper@intel.com>
4 5
  * Copyright (c) 2014 Intel Corporation.
5 6
  *
6 7
  * Permission is hereby granted, free of charge, to any person obtaining
@@ -103,7 +104,7 @@ class GroveTemp: public Grove {
103 104
 /**
104 105
  * @brief C++ API for Grove light sensor
105 106
  *
106
- * Very basic UPM module for grove Light sensor on analog
107
+ * Very basic UPM module for Grove light sensor on analog
107 108
  *
108 109
  * @ingroup grove analog
109 110
  * @snippet grovelight.cxx Interesting
@@ -113,7 +114,7 @@ class GroveLight: public Grove {
113 114
         /**
114 115
          * Grove analog light sensor constructor
115 116
          *
116
-         * @param analog pin to use
117
+         * @param pin analog pin to use
117 118
          */
118 119
         GroveLight(unsigned int pin);
119 120
         /**
@@ -127,9 +128,9 @@ class GroveLight: public Grove {
127 128
          */
128 129
         float raw_value();
129 130
         /**
130
-         * Get the light value from the sensor
131
+         * Get the approximate light value, in lux, from the sensor
131 132
          *
132
-         * @return the normalised light reading
133
+         * @return the normalized light reading in lux
133 134
          */
134 135
         int value();
135 136
     private: