Browse Source

documentation.md: Add details of what code files to put sensor block comments

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
John Van Drasek 10 years ago
parent
commit
ff55f641a2
1 changed files with 4 additions and 3 deletions
  1. 4
    3
      docs/documentation.md

+ 4
- 3
docs/documentation.md View File

@@ -15,9 +15,10 @@ sensors that you want to add to UPM:
15 15
 
16 16
 ####The sensor block
17 17
 
18
-This is added just before your class definition and has mandatory fields. For
19
-single sensor libraries, this block will actually follow immediately after the
20
-library block. If you have multiple physical sensors, add this to every one.
18
+This is added just before the class declaration in your header(.h) file and has 
19
+mandatory fields. For single sensor libraries, this block will actually
20
+follow immediately after the library block. If you have multiple physical
21
+sensors, add this to every one.
21 22
 Here's an example (disregard the "@verbatim" tags in your actual code):
22 23
 
23 24
 ```