summaryrefslogtreecommitdiff
path: root/documentation
AgeCommit message (Collapse)Author
2008-10-11more html to doxygen conversion for examples.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6411 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-11more html to doxygen conversion for {osissues,migration*,development}.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6410 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-11more html to doxygen conversion for {enumerations,glut,forms}.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6408 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-11more html to doxygen conversion for {fluid,advanced,unicode}.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6407 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-10converted more html to plain doxygen in {events,subclassing,opengl}.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6406 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-10converted more html to plain old doxygen in editor.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6405 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-10converted more html to plain old doxygen in basics.dox and common.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6404 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-09converted more html to plain old doxygen in preface.dox and intro.doxengelsman
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6403 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-09first steps towards doxygen to LaTeX to PDF generationengelsman
- 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
2008-10-08converted <a href> to \li \ref, and reduced space with <br> in drawing.doxengelsman
minor simplification and tidying git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6400 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-08completed addition of \section, \subsection and \par to drawing.doxengelsman
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
2008-10-08proof of concept use of \section, \subsection, \par in drawing.doxengelsman
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
2008-10-08started simplification of HTML in drawing.dox to allow LaTeX generationengelsman
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
2008-10-05changed index.dox table text to use <b> instead of <h1> for doxygen/latexengelsman
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
2008-10-05added explicit *.dox entries to Doxyfile INPUT variable.engelsman
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
2008-10-03Added systematically missing in out modifiers to all param doxygen ↵Fabien Costantini
statements. Added a TODO.osx file in the root describing what we have to do on the os x platform before we can pre-release 1.3 git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6368 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-01updated links in preface.dox.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6360 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-28Added navigation bar.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6352 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-25+ Cairo branch merged after successful testing on Mac OS X 10.5.4, Linux ↵Fabien Costantini
Ubuntu 8.04,Windows XPSP2. 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
2008-09-21More work on links, new navigation elements at the bottom of development.dox.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6337 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21Updated lots of links in text documentation.Albrecht Schlosser
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
2008-09-21Forgotten html_footer file added.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6330 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21Added a html_footer file for display at the bottom of each doxygen pageAlbrecht Schlosser
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
2008-09-20Fixed some typos and links and added a section about document structureAlbrecht Schlosser
and some more to development.dox. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6320 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19Simplified the doxygen comment strategy for fl_color_command()engelsman
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
2008-09-19Updating fl_utf8.h references. Fixing copyright date in .fl files.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6311 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19documentation/drawing.dox: Fixed that &cedil; and &uuml; encoding problemAlbrecht Schlosser
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
2008-09-18Initial and very thin unicode and utf-8 chapter.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6303 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18Fixing table on index page a little.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6301 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18Doxygen documentation: Fixed most important warnings for the Fl_Widget, ↵Fabien Costantini
Fl_Window, Fl_Valuator classes that should be now a 100% documented. For the rest I drastically reduced the undocumented APIs, but many others (less important) remains. It looks and feels pretty good now :-) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6299 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18Doxygen documentationFabien Costantini
+ 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
2008-09-17Doxygen documentation: started to exclude few unnecessary files.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6293 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17fixed missing <br> after dl,dt,dd modification.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6290 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Doxygen documentation: fixed all ambiguous methods signatures, fixed ↵Fabien Costantini
erroneous path test into ../test since the doxyfile move, fixed all intro dl,dt,dd related tags warnings in intro.dox . git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6289 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Another bunch of doxygen updates: *.dox. Fixed links and many html tags.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6287 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Doxygen documentation:Fabien Costantini
+ 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
2008-09-17IMAGE_PATH correction (missed, when moved to the documentation dir)Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6285 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Doxygen documentation: replace all occurences in comments of &quot; by a ↵Fabien Costantini
quote char. Temporarily set warn_if_undocumented to NO until we correct more severe messages. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6283 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Moved Doxyfile from the root dir to documentation dir, as announced.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6280 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17doxygen: fixed typos and code examples (html quotes and \ escape sequences)Albrecht Schlosser
in tutorials git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6278 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17added a TODO in next batch section. add your own suggestions that would ↵Fabien Costantini
affect lot of files in one shot. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6275 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Added forgotten documentation/development.dox file.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6274 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Added Appendix "Developer Information" for doxygen documentation infoAlbrecht Schlosser
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
2008-09-16updated the doxygen todo file list.Albrecht Schlosser
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
2008-09-15Added more comments to FL/Enumerations.h,Albrecht Schlosser
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
2008-09-15fixed broken links by adding double quotes, where appropriate.Albrecht Schlosser
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
2008-09-15Doxygen documentation WP11 Done!Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6255 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Doxygen documentation WP10 Done. Reserved WP11.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6254 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Doxygen documentation WP9 Done.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6251 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 Doxygen documentation WP8 Done. Reserved WP9, WP10. Will now check WP3 from ↵Fabien Costantini
engelsman and integrates it. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6250 ea41ed52-d2ee-0310-a9c1-e6b18d33e121