From: Bastien Nocera <hadess@hadess.net>
Date: Mon, 6 Jun 2011 18:05:20 +0000 (+0200)
Subject: accelerometer: add documentation
X-Git-Tag: 174~103
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=7236c6c40a730d053141d9fe797dc65dc2ecd1f1

accelerometer: add documentation
---

diff --git a/extras/accelerometer/accelerometer.c b/extras/accelerometer/accelerometer.c
index e06bf190e..59c2a4ece 100644
--- a/extras/accelerometer/accelerometer.c
+++ b/extras/accelerometer/accelerometer.c
@@ -1,10 +1,28 @@
 /*
  * accelerometer - exports device orientation through property
  *
+ * When an "change" event is received on an accelerometer,
+ * open its device node, and from the value, as well as the previous
+ * value of the property, calculate the device's new orientation,
+ * and export it as ID_INPUT_ACCELEROMETER_ORIENTATION.
+ *
+ * Possible values are:
+ * undefined
+ * * normal
+ * * bottom-up
+ * * left-up
+ * * right-up
+ *
+ * The property will be persistent across sessions, and the new
+ * orientations can be deducted from the previous one (it allows
+ * for a threshold for switching between opposite ends of the
+ * orientation).
+ *
  * Copyright (C) 2011 Red Hat, Inc.
- * Author: Bastien Nocera <hadess@hadess.net>
+ * Author:
+ *   Bastien Nocera <hadess@hadess.net>
  *
- * orientation_calc() from the sensorfw package:
+ * orientation_calc() from the sensorfw package
  * Copyright (C) 2009-2010 Nokia Corporation
  * Authors:
  *   Üstün Ergenoglu <ext-ustun.ergenoglu@nokia.com>