Commit Graph

496 Commits

Author SHA1 Message Date
engelsman
0e518f7f49 more html to doxygen conversion for {fluid,advanced,unicode}.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6407 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-11 08:14:59 +00:00
engelsman
d658ae6039 converted more html to plain doxygen in {events,subclassing,opengl}.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6406 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-10 20:17:33 +00:00
engelsman
136b5f86f6 converted more html to plain old doxygen in editor.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6405 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-10 18:49:47 +00:00
engelsman
7f105bfa47 converted more html to plain old doxygen in basics.dox and common.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6404 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-10 17:10:28 +00:00
engelsman
56fdfed542 converted more html to plain old doxygen in preface.dox and intro.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6403 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-09 21:13:38 +00:00
engelsman
4fb871e245 first steps towards doxygen to LaTeX to PDF generation
- 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-09 20:29:36 +00:00
engelsman
28ab4c4411 converted <a href> to \li \ref, and reduced space with <br> in drawing.dox
minor simplification and tidying



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6400 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-08 22:28:57 +00:00
engelsman
9f39d287b9 completed addition of \section, \subsection and \par to drawing.dox
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-08 22:04:13 +00:00
engelsman
9ab5e8b528 proof of concept use of \section, \subsection, \par in drawing.dox
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-08 20:01:36 +00:00
engelsman
32d164ccdf started simplification of HTML in drawing.dox to allow LaTeX generation
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-08 16:53:41 +00:00
engelsman
d4f47ee97e changed index.dox table text to use <b> instead of <h1> for doxygen/latex
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-05 19:09:55 +00:00
engelsman
8d5f884b4a added explicit *.dox entries to Doxyfile INPUT variable.
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-05 16:25:26 +00:00
Fabien Costantini
727b50652c Added systematically missing in out modifiers to all param doxygen 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-03 12:00:21 +00:00
Albrecht Schlosser
6dce14f1f5 updated links in preface.dox.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6360 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-01 15:11:54 +00:00
Albrecht Schlosser
82e80a4fa0 Added navigation bar.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6352 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-28 23:24:36 +00:00
Fabien Costantini
ffad932289 + Cairo branch merged after successful testing on Mac OS X 10.5.4, Linux 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-25 18:26:33 +00:00
Albrecht Schlosser
130029372d More work on links, new navigation elements at the bottom of development.dox.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6337 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 18:25:17 +00:00
Albrecht Schlosser
9ce5dd8c73 Updated lots of links in text documentation.
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-21 14:06:57 +00:00
Albrecht Schlosser
c7921f06ad Forgotten html_footer file added.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6330 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 11:00:00 +00:00
Albrecht Schlosser
ebc93ed3f2 Added a html_footer file for display at the bottom of each doxygen page
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-21 10:46:25 +00:00
Albrecht Schlosser
b804e1f3ab Fixed some typos and links and added a section about document structure
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-20 22:46:24 +00:00
engelsman
40a156aa94 Simplified the doxygen comment strategy for fl_color_command()
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-19 20:56:19 +00:00
Matthias Melcher
e8f467b9e3 Updating fl_utf8.h references. Fixing copyright date in .fl files.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6311 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19 17:40:20 +00:00
Albrecht Schlosser
29c1972a6a documentation/drawing.dox: Fixed that &cedil; and &uuml; encoding problem
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-19 07:23:19 +00:00
Matthias Melcher
04d1788523 Initial and very thin unicode and utf-8 chapter.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6303 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 21:59:52 +00:00
Matthias Melcher
f3ae3c705b Fixing table on index page a little.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6301 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 20:13:10 +00:00
Fabien Costantini
e8478458bf Doxygen documentation: Fixed most important warnings for the Fl_Widget, 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-18 19:09:34 +00:00
Fabien Costantini
72ac77216d Doxygen documentation
+ 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-18 10:34:22 +00:00
Fabien Costantini
4bbafadc4f Doxygen documentation: started to exclude few unnecessary files.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6293 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 23:26:50 +00:00
Fabien Costantini
d71cd6ec73 fixed missing <br> after dl,dt,dd modification.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6290 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 22:36:21 +00:00
Fabien Costantini
2be88792b3 Doxygen documentation: fixed all ambiguous methods signatures, fixed 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-17 22:25:45 +00:00
Albrecht Schlosser
74cbd55745 Another bunch of doxygen updates: *.dox. Fixed links and many html tags.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6287 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 21:13:03 +00:00
Fabien Costantini
a2eaf60572 Doxygen documentation:
+ 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-17 20:30:37 +00:00
Albrecht Schlosser
eed2315487 IMAGE_PATH correction (missed, when moved to the documentation dir)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6285 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 20:06:34 +00:00
Fabien Costantini
3787be9b6e Doxygen documentation: replace all occurences in comments of &quot; by a 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-17 15:44:43 +00:00
Albrecht Schlosser
0dfa2ab08f Moved Doxyfile from the root dir to documentation dir, as announced.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6280 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 11:17:57 +00:00
Albrecht Schlosser
4faea14c54 doxygen: fixed typos and code examples (html quotes and \ escape sequences)
in tutorials


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6278 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 10:29:00 +00:00
Fabien Costantini
e81b075ab9 added a TODO in next batch section. add your own suggestions that would 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-17 08:46:43 +00:00
Albrecht Schlosser
ec13e9a02d Added forgotten documentation/development.dox file.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6274 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 08:28:08 +00:00
Albrecht Schlosser
6f639ea8d8 Added Appendix "Developer Information" for doxygen documentation info
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-17 08:23:24 +00:00
Albrecht Schlosser
b1cc47a4b3 updated the doxygen todo file list.
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-16 07:47:20 +00:00
Albrecht Schlosser
5da1c0f71f Added more comments to FL/Enumerations.h,
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-15 22:55:40 +00:00
Albrecht Schlosser
c975ec6dca fixed broken links by adding double quotes, where appropriate.
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-15 16:42:50 +00:00
Fabien Costantini
b8955a9ced Doxygen documentation WP11 Done!
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6255 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 16:39:05 +00:00
Fabien Costantini
09f3094aef Doxygen documentation WP10 Done. Reserved WP11.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6254 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 12:46:49 +00:00
Fabien Costantini
8701883e54 Doxygen documentation WP9 Done.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6251 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 11:10:51 +00:00
Fabien Costantini
b9ca133376 Doxygen documentation WP8 Done. Reserved WP9, WP10. Will now check WP3 from engelsman and integrates it.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6250 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 08:41:54 +00:00
Fabien Costantini
fdcfef214e Doxygen documentation WP7 Done. Fl_Menu_Item was a real pain to doxyfy.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6248 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 00:27:28 +00:00
Albrecht Schlosser
e760e8a6e7 updated index page with correct link to class Fl_Pixmap
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6246 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 22:03:41 +00:00
Albrecht Schlosser
de6f468b51 Edited basic chapters to be more doxygen-friendly, added \image html
statements.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6245 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 21:58:12 +00:00