Commit Graph

604 Commits

Author SHA1 Message Date
Greg Ercolano
f190582fea Added a \ref for proper doc linking.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7158 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-02-26 17:50:51 +00:00
Greg Ercolano
6168f6fd4b doc mods to support fl_eventnames[].
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7157 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-02-26 17:49:19 +00:00
Albrecht Schlosser
1ea4b45735 Fixed some typos in examples.dox.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6948 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-11-29 17:26:26 +00:00
Albrecht Schlosser
06f5899980 Fix for documentation typos provided by Josef Vitu. Thanks.
Added Josef Vitu to CREDITS.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6946 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-11-29 11:14:42 +00:00
Matthias Melcher
07a18370ad Added Fl_Tree source code, demo files, and documentation. Thanks, Greg!
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6934 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-11-14 15:49:12 +00:00
Matthias Melcher
e649ce327e Added doxygenified documentation for Fl_Table
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6931 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-11-14 14:34:29 +00:00
Matthias Melcher
517fb60eb5 Updated mirror sites in documentation (STR #2220)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6866 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-09-13 10:57:38 +00:00
Albrecht Schlosser
7e8ba419c6 Fixed a few typos.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6837 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-07-29 16:29:26 +00:00
engelsman
61261c2917 added html_stylesheet.css for control over doxygen generated html
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6810 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-30 18:51:09 +00:00
engelsman
7f18e1002f simplified old HTML anchors with name= and href= in all *.dox files.
removed "old html link" section from development.dox



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6799 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-27 20:40:48 +00:00
engelsman
fa331cc910 minor changes and typo corrections in migration_1_3.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6797 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-27 16:22:27 +00:00
engelsman
4d326ad1bf converted old html tags to doxygen in osissues.dox
plus minor tidying in forms.dox and subclassing.dox



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



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



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



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

corrected minor typo in Fl.H



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



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



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



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



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6748 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-09 19:00:16 +00:00
engelsman
08d9455858 suppress spurious doxygen hyperlink to file:// in events.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6747 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-09 17:25:55 +00:00
engelsman
8bb63644d2 converted more html tags to doxygen commands in drawing.dox
most of the function names used as indented paragraph titles
are now recognised properly and are shown as links. However,
I was forced to "downgrade" many function() references in the
text so that the unwary user isn't unexpectedly teleported off
the tutorial pages. It reduces the link spaghetti a lot,

tweaked Enumerations.H and fl_draw.cxx to get doxygen to recognise
more function names used in drawing.dox. only fl_scroll(...)
and the offscreen drawing functions still needed for drawing.dox



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6735 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-01 22:11:57 +00:00
engelsman
c34d7585ee minor formatting tweaks to documentation/src/editor.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6734 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-01 16:24:51 +00:00
engelsman
12318a5d25 started changing html href calls to doxygen \ref commands
in basics.dox, common.dox and drawing.dox, and other cleaning up



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6729 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-30 20:41:22 +00:00
engelsman
165eed565c updated document conventions for doxygen recognised entities,
removed links to class/function reference from index/preface



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6728 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-28 16:40:06 +00:00
engelsman
76e418dccd converted page footer navigation bars to three-cell tables in all *.dox
also relaxed table widths in intro.dox to use 100% instead of 700 pixels
to fit with doxygen header rule and new footer navigation bars



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6724 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-26 22:58:23 +00:00
engelsman
c95505b462 removed numbering from doxygen chapters and navigation bars,
moved class/function reference pages to end of index table,
swapped editor/drawing chapters in Doxybook for PDF version



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6721 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25 23:12:48 +00:00
Fabien Costantini
15489bda1b Major documentation update including: now html doc API is sorted, navigation problems/side effects fixed, html tags replaced by proper doxygen commands, parameters command switched from a to p. Includes a pdf update.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6716 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-24 01:40:44 +00:00
Albrecht Schlosser
2fb4b11e91 Fixed garbage pdf/html resulting from glut.dox.
The problem was the '~' character in a (maybe osolete?) html anchor.


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

Needs to be fixed ASAP.


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

Todo: Document missing function draw_children(). 


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



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



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




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


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6703 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-21 13:36:04 +00:00
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