Skip to content

Commit

Permalink
Refactor:core:Some doxygen additions and corrections (#406)
Browse files Browse the repository at this point in the history
Signed-off-by: mvglasow <michael -at- vonglasow.com>
  • Loading branch information
mvglasow authored and jkoan committed Feb 18, 2018
1 parent cd580e0 commit e40aa32
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
13 changes: 13 additions & 0 deletions navit/attr.c
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,19 @@ attr_generic_prepend_attr(struct attr **attrs, struct attr *attr)
return curr;
}

/**
* @brief Removes an attribute from an attribute list.
*
* If `attrs` contains `attr`, a new attribute list is created (which contains all attributes, except
* for `attr`) and both `attrs` (the original attribute list) and `attr` are freed.
*
* If `attrs` does not contain `attr`, this function is a no-op.
*
* @param attrs The attribute list
* @param attr The attribute to remove from the list
*
* @return The new attribute list
*/
struct attr **
attr_generic_remove_attr(struct attr **attrs, struct attr *attr)
{
Expand Down
13 changes: 7 additions & 6 deletions navit/binding/dbus/binding_dbus.c
Original file line number Diff line number Diff line change
Expand Up @@ -1350,12 +1350,6 @@ request_navit_zoom(DBusConnection *connection, DBusMessage *message)

}

/**
* @brief Exports the current route as a GPX file
* @param connection The DBusConnection object through which a message arrived
* @param message The DBusMessage including the 'filename' parameter
* @returns An empty reply if everything went right, otherwise DBUS_HANDLER_RESULT_NOT_YET_HANDLED
*/
static DBusHandlerResult
request_navit_zoom_to_route(DBusConnection *connection, DBusMessage *message)
{
Expand All @@ -1375,6 +1369,13 @@ request_navit_zoom_to_route(DBusConnection *connection, DBusMessage *message)

}

/**
* @brief Exports the current route as a GPX file.
*
* @param connection The DBusConnection object through which a message arrived
* @param message The DBusMessage including the `filename` parameter
* @returns An empty reply if everything went right, otherwise `DBUS_HANDLER_RESULT_NOT_YET_HANDLED`
*/
static DBusHandlerResult
request_navit_route_export_gpx(DBusConnection *connection, DBusMessage *message)
{
Expand Down

0 comments on commit e40aa32

Please sign in to comment.