summaryrefslogtreecommitdiff
path: root/navit/graphics.c
diff options
context:
space:
mode:
authorSebastian Leske <sebastian.leske@sleske.name>2015-09-28 22:16:33 +0200
committerSebastian Leske <sebastian.leske@sleske.name>2015-10-05 22:33:37 +0200
commit940cfe058571e655c933b92681396b589b80a307 (patch)
tree8f38f3ee5ed56ad77c2fd9fe9c911e2101038b31 /navit/graphics.c
parentc3b122a788247f4d93c24d60fa915eb9482710c6 (diff)
downloadnavit-940cfe058571e655c933b92681396b589b80a307.tar.gz
Add Doxygen comments, remove unused struct members
Add Doxygen comments for font/freetype and graphics.c, and move comment from static function to freetype.h, where Doxygen will read it. Remove unused members from struct font_freetype_text.
Diffstat (limited to 'navit/graphics.c')
-rw-r--r--navit/graphics.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/navit/graphics.c b/navit/graphics.c
index 44993b3e3..e27794382 100644
--- a/navit/graphics.c
+++ b/navit/graphics.c
@@ -868,7 +868,12 @@ void graphics_image_free(struct graphics *gra, struct graphics_image *img)
}
/**
- * Report the beginning or the end of a set of drawing operations.
+ * @brief Start or finish a set of drawing operations.
+ *
+ * graphics_draw_mode(draw_mode_begin) must be invoked before performing any drawing
+ * operations; this allows the graphics driver to perform any necessary setup.
+ * graphics_draw_mode(draw_mode_end) must be invoked to finish a set of drawing operations;
+ * this will typically clean up drawing resources and display the drawing result.
* @param this_ graphics object that is being drawn to
* @param mode specify beginning or end of drawing
* @author Martin Schaller (04/2008)