浏览代码

docs: fix warnings in doc creation

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
Brendan Le Foll 10 年前
父节点
当前提交
6d239b9f63
共有 3 个文件被更改,包括 7 次插入7 次删除
  1. 1
    1
      docs/contributions.md
  2. 1
    1
      docs/max31855.md
  3. 5
    5
      docs/porting.md

+ 1
- 1
docs/contributions.md 查看文件

@@ -9,7 +9,7 @@ Here are the rules of contribution:
9 9
   is MIT but any permissive license is fine. Please consider that people using
10 10
   UPM may want to write proprietary programs with your sensors so we like to
11 11
   avoid GPL. (LGPL is fine). If your license is not MIT please include a
12
-  LICENSE file in src/<mymodule>/
12
+  LICENSE file in src/mymodule/
13 13
 - Please test your module builds before contributing and make sure it works on
14 14
   the latest version of mraa. If you tested on a specific board/platform please
15 15
   tell us what this was in your PR.

+ 1
- 1
docs/max31855.md 查看文件

@@ -93,5 +93,5 @@ target_link_libraries (max31855-example max31855 ${CMAKE_THREAD_LIBS_INIT})
93 93
 ~~~~~~~~~~~
94 94
 
95 95
 Note you dont have to rebuild everything, cmake keeps target lists so if you
96
-named your example target <modulename>-example you can simply do make
96
+named your example target modulename-example you can simply do make
97 97
 max31855-example and both the library & example will build.

+ 5
- 5
docs/porting.md 查看文件

@@ -9,13 +9,13 @@ example is explained in detail on @ref max31855
9 9
 ### Adding a new module to UPM
10 10
 
11 11
 1. Choose a name for your module (see @ref naming)
12
-2. Make a new folder in src/<modulename>
13
-3. Create a CMakeLists.txt file inside src/<modulename>
12
+2. Make a new folder in src/modulename
13
+3. Create a CMakeLists.txt file inside src/modulename
14 14
 
15 15
 ### CmakeLists.txt
16 16
 
17
-By default you need a header called <modulename>.h and a C++ file called
18
-<modulename>.cxx. You can have multiple headers and source files. Only public
17
+By default you need a header called modulename.h and a C++ file called
18
+modulename.cxx. You can have multiple headers and source files. Only public
19 19
 headers need to be added to module_h and all source files need to be in
20 20
 module_src.
21 21
 
@@ -60,6 +60,6 @@ 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 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 contributing and on
63
+formatted patch if your sensor. More details are on @ref contributions and on
64 64
 https://help.github.com/articles/creating-a-pull-request
65 65