[GRASS-SVN] r47074 - grass/trunk/lib/display

Sat Jul 9 10:19:39 EDT 2011

Author: martinl
Date: 2011-07-09 07:19:39 -0700 (Sat, 09 Jul 2011)
New Revision: 47074

Modified:
   grass/trunk/lib/display/displaylib.dox
Log:
displaylib: doxygen main page update


Modified: grass/trunk/lib/display/displaylib.dox
===================================================================

--- grass/trunk/lib/display/displaylib.dox	2011-07-09 14:06:44 UTC (rev 47073)
+++ grass/trunk/lib/display/displaylib.dox	2011-07-09 14:19:39 UTC (rev 47074)
@@ -3,9 +3,9 @@
 by GRASS Development Team (http://grass.osgeo.org)
 
 This library provides a wide assortment of higher level graphics
-commands which in turn use the graphics raster library primitives. It
-is highly recommended that this section be used to understand how some
-of the GRASS graphics commands operate. Such modules like
+commands which in turn use the graphics library primitives. It is
+highly recommended that this section be used to understand how some of
+the GRASS graphics commands operate. Such modules like
 <tt>d.vect</tt>, <tt>d.graph</tt>, and <tt>d.rast</tt> demonstrate how
 these routines work together.
 
@@ -16,271 +16,262 @@
 -# assorted miscellaneous routines like pop-up menus and line clipping.
 
 Note: All routines and global variables in this library, documented or
-undocumented, start with the prefix <b>D_</b>. To avoid name
+undocumented, start with <em>D_</em> prefix. To avoid name
 conflicts, programmers should not create variables or routines in
 their own modules which use this prefix.
 
-\section Loading_the_Display_Library Loading the Display Library
+\section displayLibFns List of functions
 
-The library is loaded by specifying
+The library functions are defined in <tt>display.h</tt> header:
 
-\verbatim
-$(DISPLAYLIB)
-\endverbatim
-
-in the <tt>Makefile</tt>.
-
-\section ListOfFns List of functions
-
-The library functions are defined in <tt>display.h</tt> header.
-
 \code
 #include <grass/display.h>
 \endcode
 
-TODO: Order the list
+- D_a_to_d_col()
 
-- D_update_conversions()
+- D_a_to_d_row()
 
-- D_fit_d_to_u()
+- D_a_to_u_col()
 
-- D_fit_u_to_d()
+- D_a_to_u_row()
 
-- D_show_conversions()
+- D_begin()
 
-- D_do_conversions()
+- D_box_abs()
 
-- D_is_lat_lon()
+- D_box_rel()
 
-- D_get_d_to_a_xconv()
+- D_c_color()
 
-- D_get_d_to_a_yconv()
+- D_cell_draw_begin()
 
-- D_get_d_to_u_xconv()
+- D_cell_draw_end()
 
-- D_get_d_to_u_yconv()
+- D_clip_to_map()
 
-- D_get_a_to_u_xconv()
+- D_close()
 
-- D_get_a_to_u_yconv()
+- D_close_driver()
 
-- D_get_a_to_d_xconv()
+- D_color()
 
-- D_get_a_to_d_yconv()
+- D_color_number_to_RGB()
 
-- D_get_u_to_d_xconv()
+- D_color_of_type()
 
-- D_get_u_to_d_yconv()
+- D_cont_abs()
 
-- D_get_u_to_a_xconv()
+- D_cont_rel()
 
-- D_get_u_to_a_yconv()
+- D_d_color()
 
-- D_get_ns_resolution()
+- D_do_conversions()
 
-- D_get_ew_resolution()
+- D_dots()
 
-- D_get_u_west()
+- D_draw_cell()
 
-- D_get_u_east()
+- D_draw_c_raster()
 
-- D_get_u_north()
+- D_draw_d_raster()
 
-- D_get_u_south()
+- D_draw_f_raster()
 
-- D_get_a_west()
+- D_draw_raster()
 
-- D_get_a_east()
+- D_draw_raster_RGB()
 
-- D_get_a_north()
+- D_d_to_a_col()
 
-- D_get_a_south()
+- D_d_to_a_row()
 
-- D_get_d_west()
+- D_d_to_u_col()
 
-- D_get_d_east()
+- D_d_to_u_row()
 
-- D_get_d_north()
+- D_encoding()
 
-- D_get_d_south()
+- D_end()
 
-- D_set_region()
+- D_erase()
 
-- D_set_src()
+- D__erase()
 
-- D_get_src()
+- D_f_color()
 
-- D_set_grid()
+- D_fill()
 
-- D_get_grid()
+- D_fit_d_to_u()
 
-- D_set_dst()
+- D_fit_u_to_d()
 
-- D_get_dst()
+- D_font()
 
-- D_get_u()
+- D_font_info()
 
+- D_font_list()
+
 - D_get_a()
 
-- D_get_d()
+- D_get_a_east()
 
-- D_d_to_a_row()
+- D_get_a_north()
 
-- D_d_to_a_col()
+- D_get_a_south()
 
-- D_d_to_u_row()
+- D_get_a_to_d_xconv()
 
-- D_d_to_u_col()
+- D_get_a_to_d_yconv()
 
-- D_a_to_u_row()
+- D_get_a_to_u_xconv()
 
-- D_a_to_u_col()
+- D_get_a_to_u_yconv()
 
-- D_a_to_d_row()
+- D_get_a_west()
 
-- D_a_to_d_col()
+- D_get_d()
 
-- D_u_to_d_row()
+- D_get_d_east()
 
-- D_u_to_d_col()
+- D_get_d_north()
 
-- D_u_to_a_row()
+- D_get_d_south()
 
-- D_u_to_a_col()
+- D_get_dst()
 
-- D_set_clip()
+- D_get_d_to_a_xconv()
 
-- D_clip_to_map()
+- D_get_d_to_a_yconv()
 
-- D_set_clip_mode()
+- D_get_d_to_u_xconv()
 
-- D_set_reduction()
+- D_get_d_to_u_yconv()
 
-- D_line_width()
+- D_get_d_west()
 
-- D_get_text_box()
+- D_get_ew_resolution()
 
-- D_pos_abs()
+- D_get_grid()
 
-- D_pos_rel()
+- D_get_ns_resolution()
 
-- D_move_abs()
+- D_get_src()
 
-- D_move_rel()
+- D_get_text_box()
 
-- D_cont_abs()
+- D_get_u()
 
-- D_cont_rel()
+- D_get_u_east()
 
-- D_line_abs()
+- D_get_u_north()
 
-- D_line_rel()
+- D_get_u_south()
 
-- D_polydots_abs()
+- D_get_u_to_a_xconv()
 
-- D_polydots_rel()
+- D_get_u_to_a_yconv()
 
-- D_polyline_abs()
+- D_get_u_to_d_xconv()
 
-- D_polyline_rel()
+- D_get_u_to_d_yconv()
 
-- D_polygon_abs()
+- D_get_u_west()
 
-- D_polygon_rel()
+- D_get_window()
 
-- D_box_abs()
+- D_is_lat_lon()
 
-- D_box_rel()
+- D_line_abs()
 
-- D_begin()
+- D_line_rel()
 
-- D_end()
+- D_line_width()
 
-- D_close()
+- D_move_abs()
 
-- D_stroke()
+- D_move_rel()
 
-- D_fill()
+- D_open_driver()
 
-- D_dots()
+- D_parse_color()
 
 - D_plot_icon()
 
-- D_draw_raster()
+- D_polydots_abs()
 
-- D_draw_d_raster()
+- D_polydots_rel()
 
-- D_draw_f_raster()
+- D_polygon_abs()
 
-- D_draw_c_raster()
+- D_polygon_rel()
 
-- D_draw_cell()
+- D_polyline_abs()
 
-- D_cell_draw_begin()
+- D_polyline_rel()
 
-- D_draw_raster_RGB()
+- D_pos_abs()
 
-- D_cell_draw_end()
+- D_pos_rel()
 
-- D_set_overlay_mode()
+- D_RGB_color()
 
-- D_color()
+- D_save_command()
 
-- D_c_color()
+- D_set_clip()
 
-- D_d_color()
+- D_set_clip_mode()
 
-- D_f_color()
+- D_set_dst()
 
-- D_color_of_type()
+- D_set_grid()
 
-- D_setup()
+- D_set_overlay_mode()
 
-- D_setup_unity()
+- D_set_reduction()
 
-- D_setup2()
+- D_set_region()
 
-- D_symbol()
+- D_set_src()
 
-- D_symbol2()
+- D_setup()
 
-- D_translate_color()
+- D_setup2()
 
-- D_parse_color()
+- D_setup_unity()
 
-- D_use_color()
+- D_show_conversions()
 
-- D_color_number_to_RGB()
+- D_stroke()
 
-- D_RGB_color()
+- D_symbol()
 
-- D_erase()
+- D_symbol2()
 
-- D_open_driver()
+- D_text()
 
-- D_close_driver()
+- D_text_rotation()
 
-- D_get_window()
-
-- D__erase()
-
 - D_text_size()
 
-- D_text_rotation()
+- D_translate_color()
 
-- D_text()
+- D_update_conversions()
 
-- D_font()
+- D_use_color()
 
-- D_encoding()
+- D_u_to_a_col()
 
-- D_font_list()
+- D_u_to_a_row()
 
-- D_font_info()
+- D_u_to_d_col()
 
+- D_u_to_d_row()
+
 \section Authors Authors
 
 - Original author CERL
 - Major rewrite by Glynn Clements (2008)
+- Minor updates by Martin Landa <landa.martin gmail.com> (2011)
 
 */

