Commit Graph

318 Commits

Author SHA1 Message Date
Matthias Melcher
026632d781 Small formatting updates for Intor.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8257 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-11 13:07:10 +00:00
Ian MacArthur
41a64c5012 Attempt to update doxygen description of building under winXX as it was out of date
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8238 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-10 11:37:22 +00:00
Matthias Melcher
d6bffb20a3 STR 2511: some minor doc changes. I did some extensive changes just after releasing RC2
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8203 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-06 21:48:37 +00:00
Matthias Melcher
cf95f8d261 Some minor doc changes to avoid doxygen warning.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8184 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-04 18:28:01 +00:00
Matthias Melcher
523a2ed9b7 Recompiled pdf with newest versions of doxygen and epstopdf, generating a much smaller yet complete pdf
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8174 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-03 20:47:16 +00:00
Albrecht Schlosser
09d7842f86 Documentation: fixed copying of tiny.png to documentation directory.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8158 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-01 14:12:10 +00:00
Albrecht Schlosser
01d966c835 Two more adjustments to basics.dox.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8156 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-01 13:28:52 +00:00
Albrecht Schlosser
a506811400 Adjusted test/hello.cxx for potentially wider XFT fonts and changed the
code to match the documentation in basics.dox.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8154 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-01 13:23:25 +00:00
Albrecht Schlosser
5d0d810183 Minor documentation fixes (typos).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8153 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-01 12:21:31 +00:00
Manolo Gouy
60e67f75b7 OS X: minor doc change.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8152 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-01 10:29:01 +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
Matthias Melcher
1d7be18b0d Added missing FL_ALIGN_... documentation.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8147 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-31 22:33:32 +00:00
Manolo Gouy
51ff20b053 Added doc of fl_open_display() and fl_gc under OS X.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8114 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-23 16:11:29 +00:00
Greg Ercolano
180b4b289b Image fixes; font, higher color index.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8094 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-21 09:49:55 +00:00
Greg Ercolano
f0f5dd5c13 Added doc screenshot for Fl_Native_File_Chooser.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8091 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-21 09:09:15 +00:00
Albrecht Schlosser
e1887bf09c Fixed documentation errors (typos and formatting) in chapter
chapter "Advanced FLTK" (Multithreading) and added a short
explanation to sending and retrieving messages.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8047 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-16 10:28:27 +00:00
Albrecht Schlosser
ff9c9ed973 Updated image name in html_footer.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7985 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-09 00:25:34 +00:00
Greg Ercolano
9e2d044caa As per thread on fltk.development: "RFC: Docs - getting rid of .eps files"
Summary:
    Get rid of eps files, 
    change all doxygen '\image latex' references to eps files to png/jpeg instead,
    convert doxygen images from gif -> png (to support html+latex).

Actual operations:

		1) svn remove *.eps
		2) convert all gifs ->  png
		3) svn remove *.gif
		4) svn add *.png
		5) For jpeg/png images, change all \image latex foo.eps .. ->  \image latex foo.[jpg,png] ..
		6) For gif images, change all \image html foo.gif .. ->  \image html foo.png
		   and (harder to do): change \image latex foo.eps .. ->  \image latex foo.png ..
		7) Remove EPSFILES macro from documentation/Makefile 
		   and remove eps related dependencies that were added recently



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7981 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-08 23:53:04 +00:00
Manolo Gouy
3105ab9de5 Added reference to Fl::dnd() in documentation of Drag and Drop events.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7974 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-08 11:42:47 +00:00
Manolo Gouy
a0af2510b6 Rephrased statement for international readership.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7972 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-08 09:24:02 +00:00
Greg Ercolano
81dd665b46 Removed unused FL.eps (see today's thread on fltk.development: "RFC docs")
Adjusted documentation/Makefile: in IMAGEFILES and EPSFILES: removed duplicates, added missing, sorted all.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7957 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-06 02:47:27 +00:00
Greg Ercolano
7d6e83aab6 Fixing zero sized eps files, as per Albrecht's request on fltk.dev today.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7956 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-05 17:52:00 +00:00
Greg Ercolano
d527040121 Adding a few widget images and eps equivs for Fl_Table and Fl_Tree
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7951 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-05 09:48:02 +00:00
Manolo Gouy
1dca5f900a Added the device demo program to the examples documentation section.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7916 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-11-29 21:48:14 +00:00
Manolo Gouy
90a10d3bb2 Added description of new --enable-cp936 configure option
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7915 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-11-29 21:30:26 +00:00
Matthias Melcher
903107bca9 Fixed yet more Copyright to 2010.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7905 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-11-28 21:22:55 +00:00
Manolo Gouy
dcfdf8be20 Removed FLTK own character composition rules --> left to OSs. Closes STR #2421.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7901 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-11-28 09:12:36 +00:00
Manolo Gouy
7eb27fa4bd Mac OS X: introduced global variable fl_mac_os_version and cleaned a few unused variables.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7892 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-11-25 18:21:21 +00:00
Albrecht Schlosser
d1a09ad73c Fixed documentation (ws2_32.lib linked dynamically)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7799 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-11-06 13:14:47 +00:00
Greg Ercolano
e811ef7138 Doc for arg to Fl_Window::icon(arg) changed to match actual prototype.
(char* -> const void*)

Noticed this because docs for this method under OS issues 
wasn't showing up with html highlights.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7786 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-31 18:58:58 +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
engelsman
2cad6d4004 removed unnecessary(?) date from examples.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7732 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-24 13:57:38 +00:00
engelsman
7e2590ddea reworked doxygen comments for Fl::arg() and Fl::args() - part 2
added a note to examples.dox about the 'examples' directory

updated Fl_arg.cxx to move the description of standard FLTK options
to Fl::arg() and simplified/rationalized the Fl::args() description.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7731 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-24 12:53:53 +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
Manolo Gouy
3e52876736 Removed obsolete Quickdraw information and Mac OS bugs
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7664 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-07-01 16:52:47 +00:00
engelsman
f0be902828 documentation/unicode.dox: added to the Unicode and UTF-8 Support chapter
added references to RFC 3629 as the source of the 21-bit U+10FFFF limit,
outlined the illegal character strategy of fl_utf8decode(), and
added warnings that fl_utf8len() is unsafe



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7610 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-05-17 20:16:51 +00:00
Greg Ercolano
5f01490449 Doxygen HTML formatting fix.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7565 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-04-28 07:29:01 +00:00
Greg Ercolano
7cf83d7e0f Finished up changes for references to fltk-bugs@fltk.org -> STR form.
Should solve STR #2352.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7564 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-04-28 07:21:41 +00:00
Greg Ercolano
4fd11eba88 Changed references to fltk-bugs@fltk.org -> STR form.
Todo: LGPL license file references (COPYING, license.dox, etc)



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7563 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-04-28 03:15:47 +00:00
Albrecht Schlosser
0fe65e94c9 Fixed typos and added a \todo paragraph about some more events. This probably
needs some more corrections ...


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7468 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-04-07 22:35:48 +00:00
Matthias Melcher
efd09a5a70 Added some more information on event delivery (STR 1983)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7466 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-04-07 19:24:49 +00:00
Albrecht Schlosser
369366f2ae Copyright updates in docs.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7324 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-03-23 21:47:18 +00:00
Manolo Gouy
8c67992b53 Updating the Mac OS Interface section
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7318 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-03-22 18:51:56 +00:00
Greg Ercolano
f190582fea Added a \ref for proper doc linking.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7158 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-02-26 17:50:51 +00:00
Greg Ercolano
6168f6fd4b doc mods to support fl_eventnames[].
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7157 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-02-26 17:49:19 +00:00
Albrecht Schlosser
1ea4b45735 Fixed some typos in examples.dox.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6948 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-11-29 17:26:26 +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
Matthias Melcher
07a18370ad Added Fl_Tree source code, demo files, and documentation. Thanks, Greg!
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6934 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-11-14 15:49:12 +00:00
Matthias Melcher
e649ce327e Added doxygenified documentation for Fl_Table
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6931 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-11-14 14:34:29 +00:00
Matthias Melcher
517fb60eb5 Updated mirror sites in documentation (STR #2220)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6866 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-09-13 10:57:38 +00:00
Albrecht Schlosser
7e8ba419c6 Fixed a few typos.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6837 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-07-29 16:29:26 +00:00
engelsman
61261c2917 added html_stylesheet.css for control over doxygen generated html
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6810 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-30 18:51:09 +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
fa331cc910 minor changes and typo corrections in migration_1_3.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6797 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-27 16:22:27 +00:00
engelsman
4d326ad1bf converted old html tags to doxygen in osissues.dox
plus minor tidying in forms.dox and subclassing.dox



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6796 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-27 15:19:04 +00:00
Albrecht Schlosser
85dc567187 Fixed a typo.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6792 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-05 08:47:44 +00:00
engelsman
5faf83c027 added warning to forms.dox that Forms compatibility in not maintained
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6791 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-05-30 11:44:08 +00:00
engelsman
d38399f72f converted old html tags to doxygen in forms.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6790 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-05-25 19:49:40 +00:00
engelsman
d1816513ed converted old html tags to doxygen in glut.dox
removed old <a name="anchor"> lines
removed redundant methods list and corresponding doxygen \anchors



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6789 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-05-25 18:49:47 +00:00
engelsman
1266c587b9 converted old html tags to doxygen in enumerations.dox
removed old <a name="anchor"> lines
replaced old <a href="anchor"> lines with doxygen \ref
replaced dead link to "Appendix B - Function Reference" to generated page



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6788 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-05-25 18:19:46 +00:00
engelsman
78da588135 grouped similar functions and added summary information in unicode.dox
corrected mismatched parameter names and typos on fl_utf8.h and fl_utf8.cxx



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6769 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-18 11:51:32 +00:00
engelsman
9029199cd8 added list of unicode and utf8 related functions to unicode.dox
this is the first stage in putting tutorial type info together.
next stage is to put the functions into related groups for explanation.

corrected minor typo in Fl.H



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6766 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-16 21:10:49 +00:00
engelsman
d1593df45b fleshed out the background information in unicode.dox
added more info and links on the Unicode Standard, ISO 10646, and UTF-8.
added bullet points about what FLTK will and won't do.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6752 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-11 20:46:06 +00:00
engelsman
01a6e197c2 removed dead html anchors, and minor rewording, in advanced.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6751 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-11 08:23:23 +00:00
engelsman
94a0f57bfa removed dead html anchors from, and improved layout of, fluid.dox
added a lot of \par commands to get indented paragraphs for the
reference section, basically because the paragraph titles stand
out more than the \subsection titles. Do we need to rethink this?



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6750 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-10 19:28:55 +00:00
engelsman
20775caf08 converted html tags to doxygen commands in opengl.dox
also corrected function signatures in opengl.dox
added doxygen comments to FL/gl.h, src/gl_start.cxx, src/gl_draw.cxx



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6749 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-09 20:44:31 +00:00
engelsman
8dd0abe3f2 converted more html tags to doxygen commands in subclassing.dox
removed a lot of old html name anchors (unused, or superseded by \ref)
added draw_childred() text
corrected signatures for draw_child(), draw_outside_label(), update_child()



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6748 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-09 19:00:16 +00:00
engelsman
08d9455858 suppress spurious doxygen hyperlink to file:// in events.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6747 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-09 17:25:55 +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
c34d7585ee minor formatting tweaks to documentation/src/editor.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6734 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-01 16:24:51 +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
165eed565c updated document conventions for doxygen recognised entities,
removed links to class/function reference from index/preface



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6728 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-28 16:40:06 +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
Albrecht Schlosser
2fb4b11e91 Fixed garbage pdf/html resulting from glut.dox.
The problem was the '~' character in a (maybe osolete?) html anchor.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6715 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-23 17:38:24 +00:00
Albrecht Schlosser
441af681d1 TEMPORARY fix garbage pages in the pdf docs, introduced with svn -r 6704.
This creates garbage at the end of the html page :-(

Needs to be fixed ASAP.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6714 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-23 09:31:54 +00:00
Albrecht Schlosser
6dd3466ef7 More html to doxygen conversions.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6713 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22 23:28:04 +00:00
Albrecht Schlosser
d75f9a6b93 changed more html tags to doxygen commands in documentation/src/subclassing.dox,
changed a few ones back to <tt>...</tt>, and fixed some typos.

Todo: Document missing function draw_children(). 


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6711 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22 18:19:37 +00:00
engelsman
094da5dafa changed html tags to doxygen commands in documentation/src/glut.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6710 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22 17:35:02 +00:00
engelsman
8fbaa8bafc changed html tags to doxygen commands in documentation/src/enumerations.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6709 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22 17:08:06 +00:00
engelsman
27c7dc9056 converted html tags to doxygen commands in documentation/src/advanced.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6708 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22 16:41:18 +00:00
engelsman
84332f1150 converted html tags to doxygen commands in documentation/src/fluid.dox
Note: could not convert <tt>.fl</tt> to \p .fl because it did not
      seem to give the desired format. similarly for .h .cxx and .fd



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6707 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22 16:20:42 +00:00
engelsman
e13df9275c converted html tags to doxygen commands in documentation/src/opengl.dox
This was just the first round. A lot more work will be needed here
because none of the gl_* functions are doxygenated, and there are
a lot of html links to other pages to be tidied up!



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6706 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-21 20:57:29 +00:00
engelsman
ced863d334 converted html tags to doxygen commands in documentation/src/subclassing.dox
this also required tweaking parameter names and doxygen comments in
Fl_Widget.H, Fl_Group.H, Fl_Widget.cxx and fl_boxtype.cxx 




git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6705 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-21 17:08:23 +00:00
Albrecht Schlosser
13bbc8a0c6 Reworked navigation links.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6704 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-21 13:38:11 +00:00
Albrecht Schlosser
cc57cbd17c Changed html tags to doxygen commands and fixed navigation links.
migration_1_1.dox: removed navigation element proposals, rewrote this part.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6703 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-21 13:36:04 +00:00
engelsman
4f47dbe6bb reworked handle(), MyClass::handle() and Fl_Widget::handle() in events.dox
to avoid further confusion, changed handle() to be plain \p handle(),
and made explicit reference to MyClass::handle() and Fl_Widget::handle()



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6700 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-19 22:33:07 +00:00
engelsman
39c83e370e converted html tags to doxygen commands in documentation/src/events.dox
required adding \anchor to FL/Fl_Input.H as well



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6699 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-18 22:58:12 +00:00
engelsman
5d601837b9 converted html tags to doxygen commands in documentation/src/editor.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6697 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-17 21:50:37 +00:00
engelsman
acef469350 doxygen comments for fl_box(), fl_down(), fl_frame() and converted html tags
FL/Enumerations.H: doxygen comments for fl_box(), fl_down(), fl_frame()
documentation/src/common.dox: converted html tags to doxyge commands
documentation/src/preface.dox: corrected footer link
documentation/src/index.dox: corrected footer link



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6694 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-16 22:38:32 +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
engelsman
21b6692476 basics.dox: added example Makefile using fltk-config (STR #2149)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6673 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-09 20:58:27 +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
Albrecht Schlosser
c0717aa18e STR 2147: new configure option --enable-x11 for building on cygwin with X11
support. 


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6657 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-02-14 14:34:32 +00:00
Fabien Costantini
1a297e1947 STR#2127:
- Applied third version of greg patch adding new external link functionality.
 - Corrected it so that it can compile under linux (minor include problem)
 - Corrected old documentation link to new one (toc.hmmtl is now index.html)
Tested succesfully on linux and mac os x 10.5



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6648 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-01-29 21:14:42 +00:00
Fabien Costantini
d7e4bfe777 Doxygen Documentation:
updated more copyright date info to 2009 in html and tex headers/footers


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6620 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-01-03 10:00:41 +00:00
Fabien Costantini
cdf64d9a84 Doxygen documentation:
Updated fltk pdf reference manual
  Updated copyright date (2008) to 2009


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6619 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-01-02 10:21:22 +00:00
Fabien Costantini
4d837faff1 Doxygen pdf manual:
+ 'Oxygenized' the frontpage by adding some more spaces between paragraphs
+ Added punctation and more cosmetics to make it look good.
+ Updated the fltk.pdf manual so that it reflects all recent fltk-book.tex changes.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6572 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07 23:03:29 +00:00
Fabien Costantini
b141ac03a7 fltk-book.tex : Reduced ToC to depth 1 thus limiting the number of pages to 9.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6571 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07 22:31:40 +00:00
Fabien Costantini
be06414346 Enhanced fltk-book.tex to feature automatic date update at each generation by adding a today keyword after doxygen version.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6570 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07 22:24:32 +00:00
Fabien Costantini
df0d8a8102 Enhanced fltk-book.tex to feature automatic date update at each generation by adding a today keyword after doxygen version.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6569 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07 22:21:37 +00:00
Fabien Costantini
ec5c06aeea Updated fltk-book.tex to match recent revision change and contributors update in html files.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6568 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07 22:03:01 +00:00
Albrecht Schlosser
a96dec61e1 Correct previous mod. of index.dox (function ref. was okay).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6556 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07 13:01:51 +00:00
Albrecht Schlosser
9d67f8a624 Fixed broken (html) links on documentation index page.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6554 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07 11:45:25 +00:00
Fabien Costantini
73a2fa5b99 Doxygen documentation:
- Fixed recent documentation update problems in fl_draw.cxx : \ and @ char must be doubled otherwise interpreted as doxygen keywords
- Fixed some doxygenized parameters problems in Fl_Preferences.cxx
- Added the treeview mode, now featuring a vertical left tree browser in html doc
- Splitted html configuration file from pdf configuration file, now a new Doxybook config file permits to customize independtly both html and pdf modes without risking side effects and also without assuming an fltk user will have the Tex tools installed to generate the html doc. Now only pdf generation will need LaTex tools.
- Updated the doxygen based documentation to revison 9 and added new significant contributors to index.dox in alphabetical order.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6539 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-03 01:02:10 +00:00
Albrecht Schlosser
9c7af9b2cf Added missing dependency (COMCTRL32.LIB) to documentation/src/basics.dox
(reported in fltk.general).


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6528 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-11-16 19:44:58 +00:00
Albrecht Schlosser
68c34f9ec9 documented the major code changes in migration_1_3.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6470 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-19 14:24:35 +00:00
Fabien Costantini
6ff84799a3 Moved latex related files to src, man files to src, updated Makefile and Doxyfile accordingly.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6453 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 12:42:28 +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
5a71578b1b Doxygen pdf documentation: Changed pdf mime type to application/pdf. Removed all Widget class headers from file section as they already are in the class section, this saves many pages. Also disabled the referenced by/from systematic inserts for each functions as this is more a core developer documentation feature than a fltk user manual feature, also saves many pages. Didn't use the LATEX_COMPACT feature yet, not happy with its result, will comment it later.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6439 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 13:46:06 +00:00
Fabien Costantini
19ca3c6edd Doxygen pdf documentation: Fixed missing dox files images in latex. Fixed license info would not show completely in pdf.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6438 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 12:13:43 +00:00
Fabien Costantini
d272c1b43f Doxygen PDF Documentation: Added image latex tags, added missing eps corresponding images (most of them in B/W) for the widget classes.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6437 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 11:27:29 +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