summaryrefslogtreecommitdiff
path: root/navit/vehicle/android
diff options
context:
space:
mode:
authormvglasow <mvglasow@ffa7fe5e-494d-0410-b361-a75ebd5db220>2014-11-15 16:50:21 +0000
committermvglasow <mvglasow@ffa7fe5e-494d-0410-b361-a75ebd5db220>2014-11-15 16:50:21 +0000
commitbab28ff2c621410fdc7ea08e8ac444b660d9b539 (patch)
treeec89aeb02a56d632789e690b30f68acfab094177 /navit/vehicle/android
parente23cc5b467250b9098ee41455675789f51bdfa85 (diff)
downloadnavit-bab28ff2c621410fdc7ea08e8ac444b660d9b539.tar.gz
Refactoring:core:Add some more documentation
Signed-off-by: mvglasow <michael -at- vonglasow.com> git-svn-id: http://svn.code.sf.net/p/navit/code/trunk/navit@5948 ffa7fe5e-494d-0410-b361-a75ebd5db220
Diffstat (limited to 'navit/vehicle/android')
-rw-r--r--navit/vehicle/android/vehicle_android.c14
1 files changed, 7 insertions, 7 deletions
diff --git a/navit/vehicle/android/vehicle_android.c b/navit/vehicle/android/vehicle_android.c
index 758ea913b..166786906 100644
--- a/navit/vehicle/android/vehicle_android.c
+++ b/navit/vehicle/android/vehicle_android.c
@@ -59,7 +59,7 @@ struct vehicle_priv {
/**
* @brief Free the android_vehicle
*
- * @param priv
+ * @param priv vehicle_priv structure for the vehicle
* @returns nothing
*/
static void
@@ -70,12 +70,12 @@ vehicle_android_destroy(struct vehicle_priv *priv)
}
/**
- * @brief Provide the outside with information
- *
- * @param priv
- * @param type TODO: What can this be?
- * @param attr
- * @returns true/false
+ * @brief Retrieves a vehicle attribute.
+ *
+ * @param priv vehicle_priv structure for the vehicle
+ * @param type The attribute type to retrieve
+ * @param attr Points to an attr structure that will receive the attribute data
+ * @returns True for success, false for failure
*/
static int
vehicle_android_position_attr_get(struct vehicle_priv *priv,