From 9b49ae3bed8dcc4caf10b249393a9dc212b131e3 Mon Sep 17 00:00:00 2001
From: Chethan Krishna N <chethan.krishna@stericsson.com>
Date: Wed, 25 May 2011 12:44:00 +0530
Subject: lsm303dlh: add DocBook documentation

Adding DocBook documentation for lsm303dlh accelerometer
and magnetometer drivers.

ST-Ericsson ID: 277198
Change-Id: Idfca43aa6ffaa39b7f73d0135dc6d2b01a0a44c6
Signed-off-by: Chethan Krishna N <chethan.krishna@stericsson.com>
Reviewed-on: http://gerrit.lud.stericsson.com/gerrit/23784
Reviewed-by: Srinidhi KASAGAR <srinidhi.kasagar@stericsson.com>
---
 Documentation/DocBook/Makefile       |  3 +-
 Documentation/DocBook/lsm303dlh.tmpl | 90 ++++++++++++++++++++++++++++++++++++
 2 files changed, 92 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/DocBook/lsm303dlh.tmpl

(limited to 'Documentation')

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index 5eceb6d3112..a7201295310 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -18,7 +18,8 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
 	    i2s.xml msp.xml shrm.xml stmpe.xml touchp.xml \
 	    tc_keypad.xml prcmu-fw-api.xml cg2900_fm_radio.xml \
 	    synaptics_rmi4_touchp.xml db5500_keypad.xml \
-	    u5500_LogicalMailbox.xml
+	    u5500_LogicalMailbox.xml \
+		lsm303dlh.xml
 
 ###
 # The build process is as follows (targets):
diff --git a/Documentation/DocBook/lsm303dlh.tmpl b/Documentation/DocBook/lsm303dlh.tmpl
new file mode 100644
index 00000000000..3b1c6afa65f
--- /dev/null
+++ b/Documentation/DocBook/lsm303dlh.tmpl
@@ -0,0 +1,90 @@
+<?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="LSM303DLH-API-Guide">
+ <bookinfo>
+  <title>LSM303DLH Accelerometer and Magnetometer</title>
+
+  <authorgroup>
+   <author>
+    <firstname>Chethan Krishna</firstname>
+    <surname>N</surname>
+    <affiliation>
+     <address>
+      <email>chethan.krishna@stericsson.com</email>
+     </address>
+    </affiliation>
+   </author>
+   </authorgroup>
+
+  <copyright>
+   <year>2010</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 accelerometer and magnetometer drivers for lsm303dlh sensor 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="pubfunctions">
+     <title>Public Functions Provided</title>
+     <para>
+	This accelerometer/magnetometer drivers don't export any functions.
+     </para>
+  </chapter>
+
+  <chapter id="structs">
+     <title>Structures</title>
+     <para>
+     This chapter contains the autogenerated documentation of the structures which are
+     used in the accelerometer/magnetometer drivers.
+     </para>
+!Iinclude/linux/lsm303dlh.h
+  </chapter>
+
+  <chapter id="intfunctions">
+     <title>Internal Functions Provided</title>
+     <para>
+     This chapter contains the autogenerated documentation of the internal functions.
+     </para>
+!Idrivers/hwmon/lsm303dlh_a.c
+!Idrivers/hwmon/lsm303dlh_m.c
+  </chapter>
+
+  </book>
-- 
cgit v1.2.3