summaryrefslogtreecommitdiff
path: root/documentation
AgeCommit message (Collapse)Author
2009-03-24Major documentation update including: now html doc API is sorted, navigation ↵Fabien Costantini
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-23Fixed garbage pdf/html resulting from glut.dox.Albrecht Schlosser
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-23TEMPORARY fix garbage pages in the pdf docs, introduced with svn -r 6704.Albrecht Schlosser
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-22More html to doxygen conversions.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6713 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22changed more html tags to doxygen commands in documentation/src/subclassing.dox,Albrecht Schlosser
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-22changed html tags to doxygen commands in documentation/src/glut.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6710 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22changed html tags to doxygen commands in documentation/src/enumerations.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6709 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22converted html tags to doxygen commands in documentation/src/advanced.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6708 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22converted html tags to doxygen commands in documentation/src/fluid.doxengelsman
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-21converted html tags to doxygen commands in documentation/src/opengl.doxengelsman
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-21converted html tags to doxygen commands in documentation/src/subclassing.doxengelsman
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-21Reworked navigation links.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6704 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-21Changed html tags to doxygen commands and fixed navigation links.Albrecht Schlosser
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-21Moved the stripping of date comments (strip_tags) to its own targetAlbrecht Schlosser
"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-20changed brief docs sort order, as discussed in fltk.generalAlbrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6701 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-19reworked handle(), MyClass::handle() and Fl_Widget::handle() in events.doxengelsman
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-18converted html tags to doxygen commands in documentation/src/events.doxengelsman
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-17converted html tags to doxygen commands in documentation/src/editor.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6697 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-16doxygen comments for fl_box(), fl_down(), fl_frame() and converted html tagsengelsman
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-15added doxygen comments for more functions in fl_draw.Hengelsman
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-15added doxygen coments for more routines in fl_draw.Hengelsman
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-15doxygen comments for fl_draw_image(), fl_latin1_to_local() and friendsengelsman
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-14Updated the make html process, adding a new strip functionality that removes ↵Fabien Costantini
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-09basics.dox: added example Makefile using fltk-config (STR #2149)engelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6673 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-02-20Documentation updates for STR #2142 (protected draw methods).Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6665 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-02-14STR 2147: new configure option --enable-x11 for building on cygwin with X11Albrecht Schlosser
support. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6657 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-01-29STR#2127:Fabien Costantini
- 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-20Doxygen documentationFabien Costantini
+ 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-03Doxygen Documentation:Fabien Costantini
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-02Doxygen documentation:Fabien Costantini
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-01Changed the copyright to 2009 for header files. Still todo: src and test ↵Matthias Melcher
directory. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6614 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07Doxygen pdf manual:Fabien Costantini
+ '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-07fltk-book.tex : Reduced ToC to depth 1 thus limiting the number of pages to 9.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6571 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07Enhanced fltk-book.tex to feature automatic date update at each generation ↵Fabien Costantini
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-07Enhanced fltk-book.tex to feature automatic date update at each generation ↵Fabien Costantini
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-07Updated fltk-book.tex to match recent revision change and contributors ↵Fabien Costantini
update in html files. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6568 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07Generated a new version of the fltk reference manual (fltk.pdf)Fabien Costantini
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-07Fixed documentation dependencies and changed Doxybook (for latex/pdf gen.)Albrecht Schlosser
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-07Correct previous mod. of index.dox (function ref. was okay).Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6556 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07Fixed broken (html) links on documentation index page.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6554 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-03Doxygen documentation:Fabien Costantini
- 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-11-16Added missing dependency (COMCTRL32.LIB) to documentation/src/basics.doxAlbrecht Schlosser
(reported in fltk.general). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6528 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-19documented the major code changes in migration_1_3.doxAlbrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6470 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-19Minor documentation Makefile tweaks.Albrecht Schlosser
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-18Enabled Xcode docset makefile generation as it is transparent for non xcode ↵Fabien Costantini
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-18Doxygen documentation:updated READMEFabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6456 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17Documentation makefile: Fixed make install would return an error if html ↵Fabien Costantini
folder does not exist. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6455 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17Changed the former todo_filelist used for WPs about porting old html to ↵Fabien Costantini
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-17Moved latex related files to src, man files to src, updated Makefile and ↵Fabien Costantini
Doxyfile accordingly. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6453 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17now renaming restoring dir src_doc src.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6452 ea41ed52-d2ee-0310-a9c1-e6b18d33e121