Commit Graph

727 Commits

Author SHA1 Message Date
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
Albrecht Schlosser 825f33c05a Moved the stripping of date comments (strip_tags) to its own target
"html-dist", just like it has been done for pdf-dist.

Stripping the date comments roughly doubled the time of html generation
for daily use, although it is only needed before a web update.

*** Please use "make html-dist" before updating the web docs. ***

Just for reference: Measurement values on my Windows system with cygwin:
 - make html	1:01 minutes
 - strip_tags	1:05 minutes
 - strip_tags	0:49 minutes after removal of cat

Todo:
 - Why do we need the external script strip_tags, are there reasons not to
   integrate it in the Makefile?
 - If it would be in the Makefile, should we use ${RM} instead of literally
   using "rm" ?


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6702 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-21 10:29:42 +00:00
Albrecht Schlosser 6b410fd4c5 changed brief docs sort order, as discussed in fltk.general
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6701 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-20 16:11:34 +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
Fabien Costantini 3ed30905a9 Updated the make html process, adding a new strip functionality that removes the date in each and every html autogenerated files. Now a constant message is displayed thus reducing drastically the size of future web updates.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6686 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-14 20:29:11 +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 b00d2bfa42 Doxygen documentation
+ Added a new Module section named : File names and URI utility funtions
+ updated the pdf file adequately



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6641 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-01-20 11:10:29 +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
Matthias Melcher 167d767e0f Changed the copyright to 2009 for header files. Still todo: src and test directory.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6614 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-01-01 16:11:32 +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
Fabien Costantini 47a9e9e22d Generated a new version of the fltk reference manual (fltk.pdf)
I had to revert the last r6557 change for now to make it work again, 
(on mac os x 10.5.5, doxygen 1.5.7, latest fltk 1.3)
which is strange as I would also have expected
it to work independtly from html ...



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6566 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07 19:35:26 +00:00
Albrecht Schlosser 609f519533 Fixed documentation dependencies and changed Doxybook (for latex/pdf gen.)
to _not_ generate the html files.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6557 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07 13:35:10 +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
Albrecht Schlosser 587a23b3bb Minor documentation Makefile tweaks.
Removed fltk.pdf from svn:ignore and make distclean.
Added svn:ignore for man pages in documentation/src.
Added *.log to make clean in documentation.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6465 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-19 09:46:08 +00:00
Fabien Costantini fd13aabd19 Enabled Xcode docset makefile generation as it is transparent for non xcode users.
More precisely this option only adds a new hmtl/Makefile target and will permit 
to make and install fltk doc to be incorporated to XCode 3, 
but it is not automatically generated, even on the mac platform; 
as you still have to run manually make install from the html directory to activate that one. 
Works Great, FLTK documentation side by side with Apple Documentation in your XCode environment !!!



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6457 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-18 16:23:26 +00:00
Fabien Costantini b047ee943f Doxygen documentation:updated README
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6456 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-18 07:52:26 +00:00
Fabien Costantini 83c49f6fba Documentation makefile: Fixed make install would return an error if html folder does not exist.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6455 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 20:46:27 +00:00
Fabien Costantini b110a858d6 Changed the former todo_filelist used for WPs about porting old html to doxygen to a general TODO.doc now.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6454 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 12:50:16 +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 4b5a6d1b23 adding jpg files from 6430 to restore dir
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6450 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 11:17:55 +00:00
Fabien Costantini 4ff02beea2 added new eps files to histo restoring dir.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6449 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 11:13:42 +00:00
Fabien Costantini 690af6a7a0 updated all dox files, history kept. will add other eps files on another commit
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6448 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 11:10:23 +00:00
Fabien Costantini 501690edce Last test does keep history, lets add all related files and patch them afterwards...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6447 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 11:08:15 +00:00
Fabien Costantini 7183891af3 test only, will remove. check if we keep the history for that file from pre 6430.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6446 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 11:02:23 +00:00
Fabien Costantini ee1db2a27c Doxygen documentation: Fixes obsolete install data when using make install. Now fltk.pdf and all potential html files are installed in the fltk docdir.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6443 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-16 11:41:58 +00:00
Fabien Costantini 4f60171ba6 documentation Makefile:
+ Added all eps files to pdf gen dependencies.
+ Added Doxyfile to html and latex/pdf deps
+ Added a new pdf-dist target to please mum & dad there in heaven.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6441 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 17:35:39 +00:00
Fabien Costantini 14ca02ffff Doxygen documentation: commented out the 1.5.7 specific doc options, updated README for pdf and html use. Now minimum version required is 1.5.5
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6440 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 15:58:04 +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 7735c1b42c Doxygen documentation: added svn properties to ignore temp files, set pdf file mime-type to octet stream. Created a custom output log that captures all pdflatex output and makeindex output as we could loose some of them in the standard refman.log because of the iterating crazy nature of these latex tools. Now make pdf file generates the full baby (including ToC) in one shot.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6435 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 08:09:33 +00:00
Fabien Costantini 9701852f48 Doxygen pdf documentation: made pdflatex run in batchmode. This is non verbose and nonstopmode is, but pdflatex also furthers refman.log containing all the error report...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6434 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 06:58:38 +00:00
Fabien Costantini 42184c88b6 Updated the todo list with new devl notes and todo for the pdf doc & makefile
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6433 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14 23:10:57 +00:00
Fabien Costantini 7592d7c588 Doxygen makefile: added new html and pdf targets, to use it run : make html, make pdf. for the last case, when an error is detected, the gen stops and you may have to run manually pdflatex again to have a correct toc ...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6432 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14 23:00:13 +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
Fabien Costantini 7a90386c6d Doxygen pdf documentation: OUTPUT_DIRECTORY is now . Changed the ABSOLUTE_PATH_NAMES as suggested but it seems that there is a bug in doxygen as the pdf TOC still shows the path but not the content pages.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6429 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14 20:54:00 +00:00
Fabien Costantini 528d1d0e7a Doxygen pdf documentation: added htmlonly endhtmlonly tags to avoid pdf doc to have ugly nav bar at the end of the custom chapters. This implies that no ref tag is used, so i reverted ref tags to original a href names. htmldoc was never expanded to doxygen, changed it so that it works in configure.in .
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6428 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14 20:40:23 +00:00
Fabien Costantini 86fee3f0d1 Set CASE SENSE NAME option to YES as discussed.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6424 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-13 23:12:51 +00:00
engelsman de04c108f8 copied more doxygen comments from drawing.dox back to source code
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6421 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-13 21:42:05 +00:00
engelsman 3fda0918b6 more html to doxygen conversion for license.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6413 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-12 15:13:40 +00:00
Albrecht Schlosser 01290ba3df Fixed some old typos.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6412 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-11 16:27:55 +00:00
engelsman 9ffe5fdeec more html to doxygen conversion for examples.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6411 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-11 14:49:33 +00:00
engelsman 9584477b26 more html to doxygen conversion for {osissues,migration*,development}.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6410 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-11 12:46:11 +00:00
engelsman 5abbe21b52 more html to doxygen conversion for {enumerations,glut,forms}.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6408 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-11 09:50:07 +00:00
engelsman 0e518f7f49 more html to doxygen conversion for {fluid,advanced,unicode}.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6407 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-11 08:14:59 +00:00
engelsman d658ae6039 converted more html to plain doxygen in {events,subclassing,opengl}.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6406 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-10 20:17:33 +00:00
engelsman 136b5f86f6 converted more html to plain old doxygen in editor.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6405 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-10 18:49:47 +00:00
engelsman 7f105bfa47 converted more html to plain old doxygen in basics.dox and common.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6404 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-10 17:10:28 +00:00
engelsman 56fdfed542 converted more html to plain old doxygen in preface.dox and intro.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6403 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-09 21:13:38 +00:00
engelsman 4fb871e245 first steps towards doxygen to LaTeX to PDF generation
- Doxyfile: enable LATEX generation
- index.dox: table simplified, and alternative \image latex added
- FL200.eps: new eps version of FL200.gif
- fltk-book.tex: LaTeX template file, with title page

Note: there are still too many errors in the generated LaTeX because
the html in the *.dox files is too complex for doxygen's understanding,
so we still can't generate the full LaTeX and hence PDF versions.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6402 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-09 20:29:36 +00:00
engelsman 28ab4c4411 converted <a href> to \li \ref, and reduced space with <br> in drawing.dox
minor simplification and tidying



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6400 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-08 22:28:57 +00:00
engelsman 9f39d287b9 completed addition of \section, \subsection and \par to drawing.dox
consistent \section, \subsection, \par applied to complete file.
corresponding source code comments for functions still to be completed.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6399 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-08 22:04:13 +00:00
engelsman 9ab5e8b528 proof of concept use of \section, \subsection, \par in drawing.dox
experiment replacing html H2 H3 H4 tags in Boxes and Clipping sections
with \section, \subsection, functionname and \par for indentation.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6398 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-08 20:01:36 +00:00
engelsman 32d164ccdf started simplification of HTML in drawing.dox to allow LaTeX generation
This is very much a work in progress, with some wierd formatting of H3,
H4 and A tags until they are replaced by doxygen or reworked in html.
The two big questions to come out of this simplification are:
1. if the function descriptions are moved to the source code and the
   reference pages, how much does the tutorial page need to be reworked
   and how much information should be duplicated;
2. how do we distinguish between the doxygen Fl_Widget::draw() links
   to the reference page, and the in-page links in the tutorial 
   <A href="subclassing.html#draw"><tt>Fl_Widget::draw()</tt></A>
   This second point is illustrated by the first two bullet points
   which are identical text but the links point to different places.




git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6397 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-08 16:53:41 +00:00
engelsman d4f47ee97e changed index.dox table text to use <b> instead of <h1> for doxygen/latex
Changing <H1>FLTK 1.3.0 Programming Manual</H1> in the table on the
current "cover page" to plain old <B>...</B> allows the 'make pdf' in
the doxygen created latex directory to at least get past the first page.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6379 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-05 19:09:55 +00:00
engelsman 8d5f884b4a added explicit *.dox entries to Doxyfile INPUT variable.
This is needed so that the LaTeX option processes files in the
desired order rather than alphabetical. Not sure whether the
../FL and ../src entries should be mid-list or at the end.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6377 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-05 16:25:26 +00:00
Fabien Costantini 727b50652c Added systematically missing in out modifiers to all param doxygen statements. Added a TODO.osx file in the root describing what we have to do on the os x platform before we can pre-release 1.3
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6368 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-03 12:00:21 +00:00
Albrecht Schlosser 6dce14f1f5 updated links in preface.dox.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6360 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-01 15:11:54 +00:00
Albrecht Schlosser 82e80a4fa0 Added navigation bar.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6352 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-28 23:24:36 +00:00
Fabien Costantini ffad932289 + Cairo branch merged after successful testing on Mac OS X 10.5.4, Linux Ubuntu 8.04,Windows XPSP2.
This integration is minimum as discussed, in particular it does not feature any fltk cairo drawing substitution
  as in fltk2.
  Still it provides all the fundations to go further even in next 1.4 ... 
  By default *no* cairo features are implemented nor linked, it can only be activated by --enable-cairo
  whose default is false.
  Please visit the README.cairo for complete description.

+ fixed UTF8 compilation pb on linux ubuntu

+ minor comments fixes on the fly



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6350 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-25 18:26:33 +00:00
Albrecht Schlosser 130029372d More work on links, new navigation elements at the bottom of development.dox.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6337 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 18:25:17 +00:00
Albrecht Schlosser 9ce5dd8c73 Updated lots of links in text documentation.
Added missing file "tiny.gif" for html_footer.
Updated html_footer (copyright, no date/time, no line break).


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6333 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 14:06:57 +00:00
Albrecht Schlosser c7921f06ad Forgotten html_footer file added.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6330 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 11:00:00 +00:00
Albrecht Schlosser ebc93ed3f2 Added a html_footer file for display at the bottom of each doxygen page
instead of the doxygen default "Generated ... by doxygen"
(copied from FLTK 2.0).

This should be discussed, and optionally removed or modified.

Added 5 different navigation elements to the bottom of development.dox.
Please check, what you like most (if any).


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6329 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 10:46:25 +00:00
Albrecht Schlosser b804e1f3ab Fixed some typos and links and added a section about document structure
and some more to development.dox.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6320 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-20 22:46:24 +00:00
engelsman 40a156aa94 Simplified the doxygen comment strategy for fl_color_command()
Too many \defgroup, \ingroup and \relatesalso and doxygen gets confused!
Simplified down to a single \relatesalso, and moved the extra function
documentation into the class comments.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6313 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19 20:56:19 +00:00
Matthias Melcher e8f467b9e3 Updating fl_utf8.h references. Fixing copyright date in .fl files.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6311 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19 17:40:20 +00:00
Albrecht Schlosser 29c1972a6a documentation/drawing.dox: Fixed that &cedil; and &uuml; encoding problem
by coding this in utf-8.

documentation/development.dox: added some more examples with links and
hidden comments.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6305 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19 07:23:19 +00:00
Matthias Melcher 04d1788523 Initial and very thin unicode and utf-8 chapter.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6303 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 21:59:52 +00:00
Matthias Melcher f3ae3c705b Fixing table on index page a little.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6301 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 20:13:10 +00:00
Fabien Costantini e8478458bf Doxygen documentation: Fixed most important warnings for the Fl_Widget, Fl_Window, Fl_Valuator classes that should be now a 100% documented. For the rest I drastically reduced the undocumented APIs, but many others (less important) remains.
It looks and feels pretty good now :-)


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6299 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 19:09:34 +00:00
Fabien Costantini 72ac77216d Doxygen documentation
+ Added new \relatesalso dox command to attach fl_file_chooser(), fl_color_chooser() to their respective related classes
 + corrected copyright date and added lgpl with exceptions in preface
 + restored undocumented warnings, changed QUIET mode to yes, this way we get all warnings/errors and not the long verbose list treated files. Seems to be a bit faster to run too.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6297 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 10:34:22 +00:00
Fabien Costantini 4bbafadc4f Doxygen documentation: started to exclude few unnecessary files.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6293 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 23:26:50 +00:00
Fabien Costantini d71cd6ec73 fixed missing <br> after dl,dt,dd modification.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6290 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 22:36:21 +00:00
Fabien Costantini 2be88792b3 Doxygen documentation: fixed all ambiguous methods signatures, fixed erroneous path test into ../test since the doxyfile move, fixed all intro dl,dt,dd related tags warnings in intro.dox .
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6289 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 22:25:45 +00:00
Albrecht Schlosser 74cbd55745 Another bunch of doxygen updates: *.dox. Fixed links and many html tags.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6287 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 21:13:03 +00:00
Fabien Costantini a2eaf60572 Doxygen documentation:
+ Added HAVE_GL,HAVE_GL_OVERLAY to Doxyfile defines
   + many obsolete api signature causing to be igmored by doxygen have been fixed, more to come and this is good! (we are forced to refresh these api and be up-to-date to have them documented...)
   + Added a Fl_Gl_Window::draw() method that raises a Fl::fatal() message if used directly. The old doc said it was a pure virtual which is not true. one can easily create a Fl_Gl_Window created, this won't work of course but is subject to trouble.
   Now the Fl_Gl_Window doxygenize beautifully and content is more accurate.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6286 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 20:30:37 +00:00
Albrecht Schlosser eed2315487 IMAGE_PATH correction (missed, when moved to the documentation dir)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6285 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 20:06:34 +00:00
Fabien Costantini 3787be9b6e Doxygen documentation: replace all occurences in comments of &quot; by a quote char. Temporarily set warn_if_undocumented to NO until we correct more severe messages.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6283 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 15:44:43 +00:00
Albrecht Schlosser 0dfa2ab08f Moved Doxyfile from the root dir to documentation dir, as announced.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6280 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 11:17:57 +00:00
Albrecht Schlosser 4faea14c54 doxygen: fixed typos and code examples (html quotes and \ escape sequences)
in tutorials


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6278 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 10:29:00 +00:00
Fabien Costantini e81b075ab9 added a TODO in next batch section. add your own suggestions that would affect lot of files in one shot.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6275 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 08:46:43 +00:00
Albrecht Schlosser ec13e9a02d Added forgotten documentation/development.dox file.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6274 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 08:28:08 +00:00
Albrecht Schlosser 6f639ea8d8 Added Appendix "Developer Information" for doxygen documentation info
and maybe more guidelines.
Fixed links, and replace a "\r" with "\\r".

\todo: there are more doxygen "\?" warnings to be resolved.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6273 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 08:23:24 +00:00
Albrecht Schlosser b1cc47a4b3 updated the doxygen todo file list.
Todo: remove the related files that are done from the list, especially
for those that engelsman modified.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6266 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-16 07:47:20 +00:00
Albrecht Schlosser 5da1c0f71f Added more comments to FL/Enumerations.h,
minor amendment for common.dox,
updated todo_filelist_doc.txt


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6262 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 22:55:40 +00:00
Albrecht Schlosser c975ec6dca fixed broken links by adding double quotes, where appropriate.
This may be a doxygen bug, but I fixed it anyway.

\todo	fix other links without double quotes or fix doxygen,
	if this is a doxygen bug.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6256 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 16:42:50 +00:00
Fabien Costantini b8955a9ced Doxygen documentation WP11 Done!
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6255 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 16:39:05 +00:00
Fabien Costantini 09f3094aef Doxygen documentation WP10 Done. Reserved WP11.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6254 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 12:46:49 +00:00
Fabien Costantini 8701883e54 Doxygen documentation WP9 Done.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6251 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 11:10:51 +00:00
Fabien Costantini b9ca133376 Doxygen documentation WP8 Done. Reserved WP9, WP10. Will now check WP3 from engelsman and integrates it.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6250 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 08:41:54 +00:00
Fabien Costantini fdcfef214e Doxygen documentation WP7 Done. Fl_Menu_Item was a real pain to doxyfy.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6248 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 00:27:28 +00:00
Albrecht Schlosser e760e8a6e7 updated index page with correct link to class Fl_Pixmap
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6246 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 22:03:41 +00:00
Albrecht Schlosser de6f468b51 Edited basic chapters to be more doxygen-friendly, added \image html
statements.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6245 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 21:58:12 +00:00
Fabien Costantini 7f544a0cf9 updating doxygen todo file list for reserving WP7 and WP8
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6244 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 20:10:58 +00:00
Fabien Costantini 6645d3cb6a Doxygen Documentation WP6 Done, Also completed the documentation of Help_View, Help_Dialog and cleaned up Preferences from ugly stars in comments and also removed redundant get/set text from methods doc. In this increment, we don't bother with the old dox format (comments in header). We have better things to do with our time (like about 40 mores files to doxyfy :-).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6243 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 20:00:03 +00:00
Fabien Costantini 7ddd3b8c50 Doxygen Documentation WP5 Done, WP6 half finished so that all Fl_Image class hierarchy is up-to-date. Also completed the documentation of the useful Fl_Shared_Image.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6241 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 18:19:41 +00:00
Fabien Costantini 806dd6bbdc Reserved WP6 as well to finish with the Fl_image tree. Removed used files from WP4
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6240 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 16:45:51 +00:00
Fabien Costantini ce4d0fd5d8 Doxygen Documentation WP4 Done. Has all documentation content but should be completed in increment 2. Registered for WP5.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6239 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 15:45:27 +00:00
Albrecht Schlosser 7f4e2867e8 Yet another update for FL/Enumerations.H.
Added more documentation and tried some grouping.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6238 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 13:13:24 +00:00
Fabien Costantini bb682d955f updated WP3 with the proper name, sorry.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6237 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 13:09:24 +00:00
Fabien Costantini f42614b623 updated WP in progress list + file list, put Alvin in WP3, registered for WP4...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6236 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 13:07:28 +00:00
Fabien Costantini 58548b781d Doxygen Documentation WP2 done.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6235 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 12:45:42 +00:00
Albrecht Schlosser 8bc9d467ef Saving an improved version of FL/Enumerations.H and related files.
Still working on FL/Enumerations.H, though.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6234 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 11:15:17 +00:00
Fabien Costantini 9bf19e2329 WP1 merged from my branch, WP2 reserved, todo list updated.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6231 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-13 22:33:03 +00:00
Albrecht Schlosser b9ab566a35 doxygen doc updates:
documentation/enumerations.dox: file is not actively managed, note added
 
documentation/fluid.dox: many html tags reformatted, including images


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6225 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-13 17:41:00 +00:00
Albrecht Schlosser 8416a4012e Doxygen documentation - WP12 and WP13 - first step.
Converted the descriptive chapters of the html docs to doxygen format
and modified index.dox accordingly.

This checkin includes only trivial reformatting, no major rewriting.

Added a chapter "Migrating Code from FLTK 1.1 to 1.3".

All links on the main page are working now.

Todo:
  - Check doxygen error messages, rewrite pages (html tags, contents).
  - Fill the new "Migrating..." chapter.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6224 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-13 15:55:32 +00:00
Albrecht Schlosser 054d25081a documentation/preface.dox re-added, with history (preface.html)
documentation/index.dox		re-added, with history (index.html)
documentation/advanced.dox	added, copied from advanced.html


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6223 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-13 13:28:51 +00:00
Albrecht Schlosser bdb9a5f237 removed preliminary .dox files
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6222 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-13 13:17:46 +00:00
Albrecht Schlosser 56e4a7a837 Added a note for updating STR 2037 for other helpers.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6221 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-13 11:47:51 +00:00
Albrecht Schlosser 637803e656 I took WP12 and WP13 - general documentation chapters.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6220 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-13 11:37:01 +00:00
Fabien Costantini 5ef343568c updated recent strategy choice and added an in progress list
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6215 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-11 07:20:28 +00:00
Fabien Costantini 975c1e8ff4 changed WP subdivisions, now 11 wp dealing with classes, 2 dealing with others
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6214 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-11 06:14:48 +00:00
Fabien Costantini 44f5c216ac added html files first, divided them into 4 work packages, started from alphabetic sort, then grouped together main thematics like containers,images,valuators.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6201 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-09 11:22:40 +00:00
Fabien Costantini d63439e522 added a file list to check and/or document divided into 4 workpackages WP1->WP4.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6195 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-08 10:13:08 +00:00
yuri d2d7daa20a Fixed Fl_File_Chooser::add_extra docs.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6139 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-06-17 08:44:21 +00:00
Matthias Melcher 5134c0988d Fixed issues with Fl_Scroll inside and Fl_Scroll (STR #265)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6117 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-04-24 09:01:37 +00:00
Matthias Melcher 8683ea2c81 Adding keyboard shortcut to Fl_Value_Input and Fl_Text_Editor
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6111 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-04-23 14:19:58 +00:00
Matthias Melcher 8198e51799 Added support for keyboard shortcuts to Fl_Input_ derived widgets (STR #1770). Code added for Fluid. Documentation updated.
This commit must be considered partial because there is no shortcut handling for Fl_Text_Display derived widgets or Fl_Value_Input which is derived form Fl_Valuator.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6109 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-04-22 23:33:17 +00:00
Matthias Melcher 97b806e580 Added two UTF-8 support headers which can not be used just yet. Added sample implementation of Doxygen documentation, including a Doxygen config file, two copied doc pages documentation/index.do and documentation/preface.dox, and sample headers fro Fl_Preferences and Fl_Clock.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6089 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-04-08 00:09:16 +00:00
Matthias Melcher 7d013249f7 First checkin simply updating a few version numbers and copyright dates
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6086 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-03-27 21:38:44 +00:00
Matthias Melcher b634764133 STR 1897: fixed man pages for unicode translation
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6070 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-03-16 12:12:55 +00:00
Matthias Melcher 3b9d3c3efe STR 1900: fixed wrong documentation for Fl_Scroll
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6068 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-03-16 11:22:29 +00:00
Matthias Melcher 75693af5da Fixed unescape HTML in docs: STR 1892
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6064 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-03-09 14:14:06 +00:00
Matthias Melcher efa4ad3ad7 Syb=nching the list of mirrors in doc/intro.html and README
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6062 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-03-01 11:08:32 +00:00
Matthias Melcher e7451ad0a9 STR 1886: added a few lines explaining the 1-based array in Fl_File_Chooser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6054 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-02-27 08:21:58 +00:00
Matthias Melcher 68a20dbc32 Fixed typos
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6050 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-02-26 15:04:03 +00:00
Matthias Melcher cf2e50b8c3 Added STR #1859 as a fluid documentation sub chapter
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6044 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-02-25 14:14:52 +00:00
Matthias Melcher c7d5670c3a STR #1747: Fl::grab may not work as expected, added warning in documentation
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6037 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-02-20 18:55:36 +00:00
Matthias Melcher fe9e4fe1e7 STR 1874: remove fl_create_offscreen_with_alpha which is merely a helper function for built-in image rendering on only a single platform and should not be public.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6028 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-02-20 17:31:39 +00:00
Matthias Melcher 4cdd301695 STR 1867: Documentation fix
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6027 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-02-14 18:36:42 +00:00
Matthias Melcher 9d3e96acd7 STR 1862: added missing Fl_File_Input in docs
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6022 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-01-30 09:43:49 +00:00
Matthias Melcher 8ff562936d STR 1857: fixed malformed HTML.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6021 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-01-16 15:25:17 +00:00
Matthias Melcher d8a0c923db typo
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6020 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-01-10 22:43:37 +00:00
Matthias Melcher 1e7916d354 STR 1855: fixed include file reference in Fl_RGB_IMage docs
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6019 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-01-10 22:05:17 +00:00
Matthias Melcher 3507b6cf9f Added a few links in the documentation Basics page
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6009 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-01-04 20:31:06 +00:00
Matthias Melcher 88b4e6fab6 STR #1726, STR #1753: documentation updates
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6008 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-12-28 23:01:40 +00:00
Matthias Melcher 7a3a8c1892 STR 1815: Added begin() and end() information to the Basics chapter. Hope you'll like it
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6007 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-12-27 11:02:27 +00:00
Matthias Melcher 6e8ae36abd STR #1796: fixed documentation for size_range
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6004 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-12-18 10:02:54 +00:00
Michael R Sweet b3c0a67be8 Add delete/release comments for Fl_Image::copy() (STR #1827)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5996 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-12-15 17:19:36 +00:00
Michael R Sweet b71ca52b7e Add documentation for Fl::event_dx, event_dy, and event_text (STR #1843)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5995 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-12-15 17:10:13 +00:00
Michael R Sweet 681e6ae946 Add clip_children() method (STR #1844)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5993 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-12-15 16:42:00 +00:00
Michael R Sweet 82eb2dde8c Note that Fl_Pack only works with frame box types (STR #1794)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5989 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-11-21 05:00:55 +00:00
Matthias Melcher 4da946c5de Typo...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5983 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-11-20 11:09:07 +00:00
Matthias Melcher ba396b3ea4 STR #1767: Adding "remove" function for the Fl_Check_Browser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5980 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-11-19 15:49:51 +00:00
Matthias Melcher b92ee9f21c Fixed some typos and some funny language (my own) in the documentation of the test applications. ADded a hidden [+] key support for 'Blocks' so that I can increase the level to my prefered one (6) and not have to play through 1-5 ;-)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5976 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-11-19 14:14:13 +00:00
Matthias Melcher 7455482458 STR #1777: Updated documentation to explain deselecting a line in an Fl_Multi_Browser.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5953 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-10-07 18:49:55 +00:00
Matthias Melcher a965dff175 STR #1742: Updated documentation to reflect the true nature of "selection()" and "value()" for Fl_Multi_Browser which can be quite surprisin for unsuspecting customers.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5952 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-10-07 18:39:23 +00:00
Matthias Melcher 05cf7832af STR #1792: fixed documentation of FL_HORIZONTAL vs. the correct Fl_Pack::HORIZONTAL
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5946 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-10-07 09:58:45 +00:00
Matthias Melcher 072398649c STR #1793: Updated docs to reflect the default for Fl_Pack::resizable() to be NULL.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5945 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-10-07 09:43:10 +00:00
Matthias Melcher a9456e49f4 STR #1718: added short documentation to Basics that briefly explains automatic parenting.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5944 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-10-06 17:54:25 +00:00
Matthias Melcher f6de9c9692 Updated Fl_Menu_ documentation with a warning to not change the structure of a menu during a callback by itself.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5943 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-10-06 17:42:05 +00:00
Matthias Melcher ab3eb7e719 Fixed missing slash in documentation.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5933 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-07-19 18:48:15 +00:00
Matthias Melcher a914d9c27f STR #1688: added missing /UL in documentation
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5857 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-23 19:39:55 +00:00
Matthias Melcher cbfbef8f20 Documentation typo
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5852 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-21 18:27:37 +00:00
Matthias Melcher 9c7640d047 Added link to documentation
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5851 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-21 18:01:28 +00:00
Matthias Melcher 9ca173a702 Updated Cygwin/Mingw makefiles and documentation (STR #1683)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5844 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-18 19:04:14 +00:00
Matthias Melcher a5c7b92f37 Documentation fix (STR #1686)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5843 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-18 18:57:40 +00:00
Matthias Melcher 73016d4919 Documentation fix (STR #1687)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5842 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-18 18:52:53 +00:00
Matthias Melcher ac18bf7609 Replaced '>' with '&gt;' in the documentation where appropriate (STR# 1682, 1684, 1685)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5838 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-17 15:52:15 +00:00
Matthias Melcher 2c7bea98fe STR #1678: improved fl_down, fl_frame, added fl_box, updated documentation. Fixed indent in Fl_Input_Choice.H
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5834 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-16 08:30:48 +00:00
Matthias Melcher 1feb3ed69c More documentation for creating a custom box type. I am sure this could be written more elegantly, but my English seems to get worse every day ;-/
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5833 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-16 08:17:45 +00:00
Matthias Melcher 6312531457 Some very minor documentation updates. More to come.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5832 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-05-15 10:08:49 +00:00