Parcourir la source

docs: few touch ups and typos fixed

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu il y a 10 ans
Parent
révision
b4c265005f
6 fichiers modifiés avec 23 ajouts et 19 suppressions
  1. 2
    2
      docs/contributions.md
  2. 4
    3
      docs/documentation.md
  3. 4
    4
      docs/max31855.md
  4. 6
    3
      docs/naming.md
  5. 6
    6
      docs/porting.md
  6. 1
    1
      src/upm.h

+ 2
- 2
docs/contributions.md Voir le fichier

@@ -11,8 +11,8 @@ Here are the rules of contribution:
11 11
   avoid GPL. (LGPL is fine). If your license is not MIT please include a
12 12
   LICENSE file in src/mymodule/.
13 13
 - Please test your module builds before contributing and make sure it works on
14
-  the latest version of mraa. If you tested on a specific board/platform please
15
-  tell us what this was in your PR.
14
+  the latest version of libmraa. If you tested on a specific board/platform
15
+  please tell us what this was in your PR.
16 16
 - Try not to break master. In any commit.
17 17
 - Attempt to have some decent API documentation as described in the the @ref
18 18
   documentation [guide](documentation.md).

+ 4
- 3
docs/documentation.md Voir le fichier

@@ -15,7 +15,7 @@ New libraries must have the "@brief", "@defgroup" and "@ingroup" tags in one
15 15
 block. This usually follows the namespace and it is common to have one sensor
16 16
 per library.
17 17
 
18
-Here's how this looks:
18
+Here's how this looks (disregard the "@verbatim" tags in your actual code):
19 19
 
20 20
 ```
21 21
 @verbatim
@@ -50,8 +50,9 @@ this example:
50 50
 ```
51 51
 
52 52
 Libraries with multiple sensors can add specific "@ingroup" tags here, but make
53
-sure that the first one is the "<name>" specified in the library "@defgroup"
54
-tag. An example of such a library for reference is our libupm-i2clcd.
53
+sure that the first one is the name specified in the library "@defgroup" tag.
54
+Also, add this block to every sensor. An example of such a library for
55
+reference is our libupm-i2clcd, which acts as a driver for multiple I2C LCDs.
55 56
 
56 57
 Optionally, a small representative image can be placed in the "docs/images"
57 58
 subfolder. **Please do not use existing, copyrighted images with your sensors!**

+ 4
- 4
docs/max31855.md Voir le fichier

@@ -2,7 +2,7 @@ Making a UPM module for MAX31855                         {#max31855}
2 2
 ================================
3 3
 
4 4
 The Maxim Integrated MAX31855 is a thermocouple amplifier allowing you to read
5
-from a K type themocouple. My board comes from the Pmod kit form Maxim
5
+from a K type thermocouple. My board comes from the Pmod kit form Maxim
6 6
 (MAX31855PMB1) but you can get this from many different sources. The adafruit
7 7
 people made arduino code already so we'll use that as a
8 8
 [reference](https://github.com/adafruit/Adafruit-MAX31855-library/blob/master/Adafruit_MAX31855.cpp).
@@ -69,7 +69,7 @@ the implementation of MAX31855::getTemp()
69 69
 
70 70
 Then using the arduino code as reference we simply reconstruct form the 4
71 71
 uint8_t values a 32bit int value and select only the valuable parts of
72
-information from that. The MAX31855 datahseet explains exactly which bits are
72
+information from that. The MAX31855 datasheet explains exactly which bits are
73 73
 useful, we will just do the same as the adafruit code, first checking the error
74 74
 bit and then scrapping everything but the 14bit of thermocouple data that are
75 75
 useful to us and converting it to a double.
@@ -78,7 +78,7 @@ useful to us and converting it to a double.
78 78
 
79 79
 ### Finalizing
80 80
 
81
-Our final example, very easy to use api!
81
+Our final example, very easy to use API!
82 82
 
83 83
 @snippet examples/max31855.cxx Interesting
84 84
 
@@ -92,6 +92,6 @@ include_directories (${PROJECT_SOURCE_DIR}/src/max31855)
92 92
 target_link_libraries (max31855-example max31855 ${CMAKE_THREAD_LIBS_INIT})
93 93
 ~~~~~~~~~~~
94 94
 
95
-Note you dont have to rebuild everything, cmake keeps target lists so if you
95
+Note you don't have to rebuild everything, cmake keeps target lists so if you
96 96
 named your example target modulename-example you can simply do make
97 97
 max31855-example and both the library & example will build.

+ 6
- 3
docs/naming.md Voir le fichier

@@ -1,7 +1,7 @@
1 1
 Naming a module                         {#naming}
2 2
 ===============
3 3
 
4
-UPM attemps to follow a clear naming pattern. Modules should be sensibly named
4
+UPM attempts to follow a clear naming pattern. Modules should be sensibly named
5 5
 and then placed in ${libdir}/upm and headers in ${includedir}/upm, all modules
6 6
 should be prefixed with libupm-<modulename>. The upm_module_init will
7 7
 automatically name python UPM modules as pyupm_<modulename> and javascript
@@ -24,6 +24,9 @@ sensor can inherit your class if they only have minor changes.
24 24
 
25 25
 ### Doubt
26 26
 
27
-If ever, give me a ping via email: brendan.le.foll@intel.com and I'll try
28
-suggest decent names for your module.
27
+If ever, give either of us a ping via email:
28
+ mihai.tudor.panu@intel.com
29
+ john.r.van.drasek@intel.com
30
+ brendan.le.foll@intel.com
31
+and we'll try suggest decent names for your module.
29 32
 

+ 6
- 6
docs/porting.md Voir le fichier

@@ -3,7 +3,7 @@ Porting a module from Arduino                         {#porting}
3 3
 
4 4
 Porting arduino libraries to libmraa as UPM libraries is usually fairly easy.
5 5
 The issues typically come from misunderstanding of how a non real time OS deals
6
-with interupts and timers. It also highly depends on the sensor. A concrete
6
+with interrupts and timers. It also highly depends on the sensor. A concrete
7 7
 example is explained in detail on @ref max31855
8 8
 
9 9
 ### Adding a new module to UPM
@@ -36,9 +36,9 @@ required to talk to the board's IO. An I2c sensor will create a
36 36
 mraa_i2c_context, keep it as a private member and require a bus number and slave
37 37
 address in it's constructor.
38 38
 
39
-Typically in sensors a simple object->read() function is prefered, depending on
40
-your sensor/actuaotr this may or may not be easy or not even make sense. Most
41
-UPM apis have a simple set of functions.
39
+Typically in sensors a simple object->read() function is preferred, depending on
40
+your sensor/actuator this may or may not be easy or not even make sense. Most
41
+UPM APIs have a simple set of functions.
42 42
 
43 43
 ### Mapping arduino API to libmraa
44 44
 
@@ -59,7 +59,7 @@ the UPM build system.
59 59
 The last step is when you're happy with your module and it works send us a pull
60 60
 request! We'd love to include your sensor in our repository.
61 61
 
62
-If you don't like github you can also send brendan.le.foll@intel.com a git
63
-formatted patch if your sensor. More details are on @ref contributions and on
62
+If you don't like github you can also send mihai.tudor.panu@intel.com a git
63
+formatted patch of your sensor. More details are on @ref contributions and on
64 64
 https://help.github.com/articles/creating-a-pull-request
65 65
 

+ 1
- 1
src/upm.h Voir le fichier

@@ -338,6 +338,6 @@
338 338
 
339 339
 /**
340 340
  * @brief Grove Starter Kit
341
- * @defgroup grovesk Grove Starter Kit
341
+ * @defgroup gsk Grove Starter Kit
342 342
  * @ingroup bykit
343 343
  */