Commit Graph

580 Commits

Author SHA1 Message Date
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
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