Commit Graph

26 Commits

Author SHA1 Message Date
Manolo Gouy
2c5b268859 Fix for STR #2947: A couple of minor glitches in the 1.3.2 docs.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9868 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2013-04-09 15:10:25 +00:00
Greg Ercolano
5e2bdbdeef Followup: small color docs mod
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9857 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2013-04-02 16:51:56 +00:00
Greg Ercolano
ba0c61b961 Small color documentation clarification/improvements:
o Added some references to the FLTK colormap diagram in obvious places (Fl_Color docs)
    o Added info regarding the 'reserved' colors
    o Added quotes to clarify RGBI description: "RGB" and "I"



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9856 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2013-04-02 16:47:57 +00:00
Greg Ercolano
b879b0673a Added some descriptions to colors, switched jpg -> png.
(jpeg was 2x larger)


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9524 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2012-05-17 23:34:17 +00:00
Greg Ercolano
7dcf31ff36 Added colormap with index numbers in the legends to the "Colors"
section of the 'Drawing Things in FLTK' section. This should make it easy
to quickly identify the color numbers of the default FLTK colormap entries.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9521 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2012-05-17 22:42:26 +00:00
Greg Ercolano
ebf71d633b Documentation improvements:
o Added fl_text_extents() to the 'Drawing things in FLTK' section
	o Added 'see also' sections to all the text measuring functions in that section
	o Added detail to fl_text_extents() docs regarding it not handling FLTK symbols,
	  as non-public comment for that method indicates.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9463 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2012-05-08 16:15:34 +00:00
Albrecht Schlosser
86e58bc0d8 Fixed "Index" link on documentation pages.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8651 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-05-11 15:49:30 +00:00
Albrecht Schlosser
06e17886ed Documentation fixes and a few indent corrections.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8621 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-04-23 15:46:30 +00:00
Matthias Melcher
8074cb6f82 A bunch of documentation updates. Not sure if I found everything. The Unicode section needs some love.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8151 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-01 04:42:56 +00:00
engelsman
efd349ddce updated documentation for color handling - see STR #2226
- added text about color(0xRRGGBBII) call to common.dox and drawing.dox
- added doxygen comments for fl_show_chooser(), including image.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7770 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-29 22:14:59 +00:00
engelsman
fc1a878290 reworked color documentation as suggested in STR #2373
part of the confusion was the main page link to
Common Widgets and Attributes/Colors actually went to
Drawing Things in FLTK/Colors therefore making it harder
to find information.

Common Widgets and Attribute/Colors now simplified

Drawing Things in FLTK/Colors now expanded

FLTK Enumerations/Colors now simplified



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7762 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-27 22:07:55 +00:00
Manolo Gouy
5c55379301 Added Doxygen doc to offscreen drawing functions.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7720 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-12 12:34:19 +00:00
Albrecht Schlosser
06f5899980 Fix for documentation typos provided by Josef Vitu. Thanks.
Added Josef Vitu to CREDITS.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6946 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-11-29 11:14:42 +00:00
engelsman
7f18e1002f simplified old HTML anchors with name= and href= in all *.dox files.
removed "old html link" section from development.dox



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6799 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-27 20:40:48 +00:00
engelsman
8bb63644d2 converted more html tags to doxygen commands in drawing.dox
most of the function names used as indented paragraph titles
are now recognised properly and are shown as links. However,
I was forced to "downgrade" many function() references in the
text so that the unwary user isn't unexpectedly teleported off
the tutorial pages. It reduces the link spaghetti a lot,

tweaked Enumerations.H and fl_draw.cxx to get doxygen to recognise
more function names used in drawing.dox. only fl_scroll(...)
and the offscreen drawing functions still needed for drawing.dox



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6735 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-01 22:11:57 +00:00
engelsman
12318a5d25 started changing html href calls to doxygen \ref commands
in basics.dox, common.dox and drawing.dox, and other cleaning up



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6729 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-30 20:41:22 +00:00
engelsman
76e418dccd converted page footer navigation bars to three-cell tables in all *.dox
also relaxed table widths in intro.dox to use 100% instead of 700 pixels
to fit with doxygen header rule and new footer navigation bars



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6724 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-26 22:58:23 +00:00
engelsman
c95505b462 removed numbering from doxygen chapters and navigation bars,
moved class/function reference pages to end of index table,
swapped editor/drawing chapters in Doxybook for PDF version



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6721 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25 23:12:48 +00:00
Fabien Costantini
15489bda1b Major documentation update including: now html doc API is sorted, navigation problems/side effects fixed, html tags replaced by proper doxygen commands, parameters command switched from a to p. Includes a pdf update.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6716 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-24 01:40:44 +00:00
engelsman
4bcf3e5311 added doxygen comments for more functions in fl_draw.H
FL/fl_draw.H: see below
src/fl_cursor.cxx: fl_cursor()
src/fl_scroll_area.cxx: fl_scroll()
src/fl_overlay.cxx: fl_overlay_clear(), fl_overlay_rect()
documentation/src/drawing.dox: updated paragraph tag links



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6690 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-15 20:52:46 +00:00
engelsman
3c56a23ba1 added doxygen coments for more routines in fl_draw.H
FL/fl_draw.H: fl_rectf(), fl_read_image()
src/fl_draw_pixmap.cxx: fl_draw_pixmap(), fl_measure_pixmap()
documentation/src/drawing.dox: corrected paragraph link tags



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6689 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-15 19:38:13 +00:00
engelsman
9a7185384a doxygen comments for fl_draw_image(), fl_latin1_to_local() and friends
updated FL/fl_draw.H to avoid triplication in src/fl_draw_image*.cxx
and duplication in src/fl_encoding_latin1.cxx
rationalized some parameter names to match existing docs

updated documentation/src/drawing.dox to have section headers in order
and to enable paragraph tags to link to fl_draw_image*()
(can't work out how to link Fl_Draw_Image_Cb as paragraph tag :-( )



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6688 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-15 11:27:56 +00:00
Albrecht Schlosser
354701c6f6 Documentation updates for STR #2142 (protected draw methods).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6665 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-02-20 08:15:32 +00:00
Fabien Costantini
69dbe4ea9c now renaming restoring dir src_doc src.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6452 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 11:26:30 +00:00
Fabien Costantini
09cfc1a1ea Removing current broken history documentation/src dir.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6451 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 11:22:35 +00:00
Fabien Costantini
497afccb07 Doxygen pdf man: First version added in documentation/fltk.pdf, old doc removed, images, dox files moved to a new src directory.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6431 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14 22:12:25 +00:00