← Back to branch summary

~oif-team/geis/2.1.2

« back to all changes in this revision

Viewing changes to doc/api.dox

  • Committer: Stephen M. Webb
  • Date: 2011-03-17 04:06:04 UTC
  • mto: This revision was merged to the branch mainline in revision 117.
  • Revision ID: stephen.webb@canonical.com-20110317040604-ro1xq4wm6elg903c
Refined the API documentation and added an examples directory.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api.dox
 
1
/**
 
2
 * @mainpage The GEIS API
 
3
 *
 
4
 * @section sec_intro Introduction
 
5
 *
 
6
 * The GEIS API provides a defined, stable, portable interface for receiving
 
7
 * gestural input.
 
8
 *
 
9
 * GEIS actually provides two APIs:
 
10
 * the @ref using_geis_v1 "simplified interface"
 
11
 * and the @ref using_geis_v2 "advanced interface".
 
12
 *
 
13
 * @page  using_geis_v1 Using The Simplified Interface
 
14
 *
 
15
 * @section using_geis_v1_intro Introduction to the Simplified GEIS Interface
 
16
 *
 
17
 * The goal of the simplified GEIS interface is to minimize the work required to
 
18
 * receive gestures from the gesture recognition engine.  It is designed around
 
19
 * the idea of creating a set of callback functions and installing them to
 
20
 * receive gesture events on a selected window.
 
21
 */