diff options
| author | Naga Radhesh <naga.radheshy@stericsson.com> | 2011-12-16 17:14:44 +0530 |
|---|---|---|
| committer | Philippe Langlais <philippe.langlais@stericsson.com> | 2012-05-22 11:06:11 +0200 |
| commit | 9935c3921e48c015f5a4e71e565c1bd8ba0348a6 (patch) | |
| tree | 6b26449ae23d3f36c0a06e129bfcb6258a2bede7 /Documentation | |
| parent | 4b9870d69495c7f45991d858c73fd9228949a93d (diff) | |
Documentation:add kernel-doc for pressure sensor
add kernel-docs for the pressure sensor.
ST-Ericsson ID: 371766
ST-Ericsson Linux next: NA
ST-Ericsson FOSS-OUT ID: Trivial
Change-Id:I1977bdbc13dde20ca14f50e70f0f4746367a172b
Signed-off-by: Naga Radhesh <naga.radheshy@stericsson.com>
Reviewed-on: http://gerrit.lud.stericsson.com/gerrit/42897
Reviewed-by: QATOOLS
Reviewed-by: QABUILD
Reviewed-by: Srinidhi KASAGAR <srinidhi.kasagar@stericsson.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/DocBook/Makefile | 3 | ||||
| -rw-r--r-- | Documentation/DocBook/lps001wp_prs.tmpl | 89 |
2 files changed, 91 insertions, 1 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 66725a3d30d..851250c8400 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile @@ -14,7 +14,8 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \ genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ 80211.xml debugobjects.xml sh.xml regulator.xml \ alsa-driver-api.xml writing-an-alsa-driver.xml \ - tracepoint.xml drm.xml media_api.xml + tracepoint.xml drm.xml media_api.xml \ + lps001wp_prs.xml include $(srctree)/Documentation/DocBook/media/Makefile diff --git a/Documentation/DocBook/lps001wp_prs.tmpl b/Documentation/DocBook/lps001wp_prs.tmpl new file mode 100644 index 00000000000..4b3f69ab967 --- /dev/null +++ b/Documentation/DocBook/lps001wp_prs.tmpl @@ -0,0 +1,89 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> + +<book id="LPS001WP-API-Guide"> + <bookinfo> + <title>LPS001WP Pressure and temperature</title> + + <authorgroup> + <author> + <firstname> Matteo Dameno,Carmine Iascone </firstname> + <surname></surname> + <affiliation> + <address> + <email>matteo.dameno@st.com,carmine.iascone@st.com</email> + </address> + </affiliation> + </author> + </authorgroup> + + <copyright> + <year>2011</year> + <holder>ST-Ericsson</holder> + </copyright> + + <subjectset> + <subject> + <subjectterm>Linux standard functions</subjectterm> + </subject> + </subjectset> + + <legalnotice> + <para> + License terms: GNU General Public License (GPL) version 2. + </para> + + </legalnotice> + </bookinfo> + +<toc></toc> + + <chapter id="intro"> + <title>Introduction</title> + <para> + This documentation describes the pressure and temperature sensor driver for LPS001WP chip. + </para> + </chapter> + + <chapter id="bugs"> + <title>Known Bugs And Assumptions</title> + <para> + <variablelist> + <varlistentry> + <term>None</term> + <listitem> + <para> + None. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </chapter> + + <chapter id="structs"> + <title>Structures</title> + <para> + This chapter contains the autogenerated documentation of the structures which are + used in the pressure/temperature sensor driver. + </para> +!Iinclude/linux/input/lps001wp.h + </chapter> + + <chapter id="pubfunctions"> + <title>Public Functions Provided</title> + <para> + This pressure/temperature drivers don't export any functions. + </para> + </chapter> + + <chapter id="intfunctions"> + <title>Internal Functions Provided</title> + <para> + This chapter contains the autogenerated documentation of the internal functions. + </para> +!Idrivers/input/misc/lps001wp_prs.c + </chapter> + + </book> |