Commit Graph

3411 Commits

Author SHA1 Message Date
Greg Ercolano
eb6b632b0a Brace and indent mods for readability..
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6736 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-02 01:19:25 +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
Albrecht Schlosser
509ac7e176 Reverted removal of #include <stdio.h>, because it _is_ needed.
It was removed in r 6682 (STR #2173).


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6733 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-01 14:10:58 +00:00
Albrecht Schlosser
f4de1317c3 Added "Rendering and measuring of non-utf8-conforming text"
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6732 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-01 07:21:34 +00:00
Greg Ercolano
345501a1dd Added Mike's suggestion for more const correctness;
const char * -> const char * const



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6731 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-31 22:41:10 +00:00
Greg Ercolano
b6cf0250b6 Made the char* arrays 'const' to prevent compiler warnings.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6730 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-31 17:00:35 +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
88a23466e3 fluid: fix erroneous declaration of user-defined static function (STR #2011)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6727 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-27 20:05:03 +00:00
Greg Ercolano
f91d962536 Doxgen mods for Fl_Browser*:
o Added \see for all methods that seemed to need it
	o Fix to has_scroll() enum docs as per Albrecht's comments
	o Other small doc tweaks



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6726 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-27 16:52:31 +00:00
Fabien Costantini
4d82b14831 vc2005 update:
+ Added readmes to the solution explorer
+ Added folder to solution explorer to help navigating in the distrib faster and more easily.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6725 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-27 00:02:20 +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
Fabien Costantini
a8dad162af vc2005 Project files:
- Fixed dependencies problems for line_style and cairo_test targets making full build failed because fltk lib would build after them.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6723 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-26 22:46:46 +00:00
Fabien Costantini
792f2adb41 Updated UTF8 todo list from current google shared document for those who can't/ don't know where to look at.
Great addons Greg, Thanks!


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6722 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-26 21:52:24 +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
Greg Ercolano
f414a50dd2 o Major mods to Fl_Browser_.{cxx.H}'s doxygen docs
o Small mods to Fl_Browser.{cxx,H}'s doxygen docs
	o FL_SORT_ASC/DESC -> FL_SORT_ASCENDING/DESCENDING (includes necessary mod to test/browser.cxx demo)

	TODO: Fl_Browser needs new '\see Related methods: ' that was initiated in Fl_Browser_



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6720 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25 23:09:04 +00:00
Fabien Costantini
9c191c2317 Removed former TODO.utf8 file as suggested and confirmed.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6719 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25 16:38:28 +00:00
Fabien Costantini
9c7d2ed48a Started a new TODO.utf8 list canvas. Please fill the lists. moved the former todo content to a TOD-files.utf8 file. Should be removed IMHO
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6718 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25 16:23:14 +00:00
Matthias Melcher
fb10b252a0 Typo
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6717 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25 15:05:30 +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
f5d5c97312 fixed a typo
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6712 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-22 19:21:34 +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
Greg Ercolano
6cbde8909b xutf8 files code conformance:
o C files containing C++ "//" comments -> C style "/* */" comments
    o Converted unintended doxygen style comments to regular C comments
    o FLTK brace/indent coding standard conformance
    o Tested linux + sgi
    o Avoided mods to xutf8/lcUniConv [libiconv/FSF code]
      to avoid unwanted diffs with future updates of that lib
      as per Fabien's fltk.dev request 03/14/09.
      (Those files already compliant anyway)



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6698 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-18 04:47:01 +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
Greg Ercolano
cae2ca6d7e Spell check was an after thought..
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6696 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-17 03:41:34 +00:00
Greg Ercolano
498dcb05ae Fl_Browser documenation improvements/additions.
- Standardized all methods + parameter names
    - Strengthened descriptions
    - added \code examples



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6695 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-17 03:29:58 +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
Albrecht Schlosser
52c0cd3d9a more documentation updates for Fl_Help_View.H
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6693 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-15 21:28:50 +00:00
engelsman
6eb194ae48 added doxygen comments for remaining functions in fl_draw.H
Fl/fl_draw.H: \todo for fl_set_status(), fl_set_spot(), fl_reset_spot()
src/fl_symbols.cxx: fl_add_symbol(), fl_draw_symbol()



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6692 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-15 21:24:43 +00:00
Albrecht Schlosser
023b77a1ab Fixed some comments and removed obsolete
#define getcwd _getcwd[2]

because FLTK 1.3 now uses fl_getcwd().


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6691 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-15 21:16:34 +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
Greg Ercolano
a68ea3c069 Surrounded all #warning's with #if defined(__GNUC__)
to prevent compiling problems on non-gnu compilers.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6687 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-15 03:14:43 +00:00