Generating HTML and PDF docs is now independent, order doesn't matter.
New and modified make targets:
- html: generate HTML docs only
- pdf: generate PDF docs only
- dist: generate HTML and PDF docs (use for distribution files)
- html-online: HTML docs with "stripping" modification dates
- alldocs: retained as synonym for 'dist'
To do: README file must be updated...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8191 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
chapter "Advanced FLTK" (Multithreading) and added a short
explanation to sending and retrieving messages.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8047 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Summary:
Get rid of eps files,
change all doxygen '\image latex' references to eps files to png/jpeg instead,
convert doxygen images from gif -> png (to support html+latex).
Actual operations:
1) svn remove *.eps
2) convert all gifs -> png
3) svn remove *.gif
4) svn add *.png
5) For jpeg/png images, change all \image latex foo.eps .. -> \image latex foo.[jpg,png] ..
6) For gif images, change all \image html foo.gif .. -> \image html foo.png
and (harder to do): change \image latex foo.eps .. -> \image latex foo.png ..
7) Remove EPSFILES macro from documentation/Makefile
and remove eps related dependencies that were added recently
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7981 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This would probably allow us to remove the documentation/src/*.eps files from svn at some point.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7958 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Adjusted documentation/Makefile: in IMAGEFILES and EPSFILES: removed duplicates, added missing, sorted all.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7957 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
(char* -> const void*)
Noticed this because docs for this method under OS issues
wasn't showing up with html highlights.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7786 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
- added text about color(0xRRGGBBII) call to common.dox and drawing.dox
- added doxygen comments for fl_show_chooser(), including image.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7770 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
part of the confusion was the main page link to
Common Widgets and Attributes/Colors actually went to
Drawing Things in FLTK/Colors therefore making it harder
to find information.
Common Widgets and Attribute/Colors now simplified
Drawing Things in FLTK/Colors now expanded
FLTK Enumerations/Colors now simplified
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7762 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
added a note to examples.dox about the 'examples' directory
updated Fl_arg.cxx to move the description of standard FLTK options
to Fl::arg() and simplified/rationalized the Fl::args() description.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7731 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
added references to RFC 3629 as the source of the 21-bit U+10FFFF limit,
outlined the illegal character strategy of fl_utf8decode(), and
added warnings that fl_utf8len() is unsafe
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7610 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
"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
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
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
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
- 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
+ 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
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
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
+ '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
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
- 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
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
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
+ 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
- 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
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
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
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
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
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
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
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
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
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
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
+ 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
+ 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
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
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
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
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
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
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
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
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
