diff options
| author | Philippe Langlais <philippe.langlais@linaro.org> | 2012-01-13 10:56:08 +0100 |
|---|---|---|
| committer | Philippe Langlais <philippe.langlais@stericsson.com> | 2012-05-22 11:03:38 +0200 |
| commit | b0fe67b7a7cd0645c43bbca20ea31c8db049db8f (patch) | |
| tree | e4e81081de80997d56d308780fd2767fa3b2480f /Documentation | |
| parent | 8c858cdc4a363b7c9b4989125db01d914fa8fc5d (diff) | |
Documentation:add kernel-doc for keypad
Add kernel docs for keypad
Signed-off-by: Naga Radhesh <naga.radheshy@stericsson.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/DocBook/ske_keypad.tmpl | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/Documentation/DocBook/ske_keypad.tmpl b/Documentation/DocBook/ske_keypad.tmpl new file mode 100644 index 00000000000..030d5201990 --- /dev/null +++ b/Documentation/DocBook/ske_keypad.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="keypad-API-Guide"> + <bookinfo> + <title>SKE Keypad</title> + + <authorgroup> + <author> + <firstname>NaveenKumar</firstname> + <surname>Gaddipati</surname> + <affiliation> + <address> + <email>naveen.gaddipati@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 API provided by the keypad driver for internal keypad. + </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 keypad driver. + </para> +!Iarch/arm/plat-nomadik/include/plat/ske.h + </chapter> + + <chapter id="pubfunctions"> + <title>Public Functions Provided</title> + <para> + This ske keypad driver doesn'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/keyboard/nomadik-ske-keypad.c + </chapter> + + </book> |