alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-01 17:31:13 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: few touch ups and typos fixed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2015-03-04 11:22:56 -08:00
parent 9dcef6d7bb
commit b4c265005f
6 changed files with 23 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/documentation.md
View File

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