Author: bgbnbigben Date: 2011-05-28 06:16:09 -0700 (Sat, 28 May 2011) New Revision: 8751 Log: Doxygen comment cleanups to shut some of the warnings up, as well as bringing the docs into 2011
Modified: trunk/documentation/00.doc trunk/documentation/01intro.doc trunk/documentation/html_footer trunk/fltk/Flags.h trunk/glut/glut_compatability.cxx trunk/src/Input.cxx trunk/src/Scrollbar.cxx trunk/src/WidgetAssociation.cxx trunk/src/file_chooser.cxx Modified: trunk/documentation/00.doc =================================================================== --- trunk/documentation/00.doc 2011-05-28 11:26:33 UTC (rev 8750) +++ trunk/documentation/00.doc 2011-05-28 13:16:09 UTC (rev 8751) @@ -7,10 +7,10 @@ <center> \image html fltk_shadow.png <br><a href="http://www.fltk.org"; TARGET="_top">www.fltk.org</a> -<br>Revision 17 by Bill Spitzak, Michael Sweet, Craig P. Earls, -Matthias Melcher, Nicolas Kaiser, your_name_here<br> +<br>Revision 18 by Bill Spitzak, Michael Sweet, Craig P. Earls, +Matthias Melcher, Nicolas Kaiser, Ben Stott<br> <i><small> -All contents ©1998-2007 by Bill Spitzak and others.<br> +All contents ©1998-2011 by Bill Spitzak and others.<br> Permission is granted to reproduce this manual<br> or any portion, for any purpose, provided this<br> copyright and permission notice are preserved. @@ -61,7 +61,7 @@ \section copyrights Copyrights and Trademarks -FLTK is ©1998-2008 by Bill Spitzak and others. +FLTK is ©1998-2011 by Bill Spitzak and others. UNIX is a registered trademark of the X Open Group, Inc. Microsoft and Windows are registered trademarks of Microsoft Corporation. OpenGL Modified: trunk/documentation/01intro.doc =================================================================== --- trunk/documentation/01intro.doc 2011-05-28 11:26:33 UTC (rev 8750) +++ trunk/documentation/01intro.doc 2011-05-28 13:16:09 UTC (rev 8751) @@ -22,7 +22,7 @@ \section licensing Licensing -FLTK comes with complete free source code. FLTK is ©1998-2007 +FLTK comes with complete free source code. FLTK is ©1998-2011 by Bill Spitzak and others. Use and distribution of FLTK is governed by the <A HREF=license.html>FLTK Library License</a>, which is the GNU Library General Public License with an \e exception added that allows you @@ -63,7 +63,7 @@ this form on Linux distributions. Here are some of the core features unique to FLTK: -- sizeof(fltk:\:Widget) == 60. +- sizeof(fltk::Widget) == 60. - The "core" (the "hello" program compiled & linked with a static FLTK library using gcc on a 486 and then stripped) is 82K. - The FLUID program (which includes every widget) is 352k. @@ -157,6 +157,6 @@ (Other stuff was here but I believe it was inaccurate. Need info on how to read the mailing lists using usenet, get svn access, post bugs, -etc. This information is currently available at http:/www.fltk.org) +etc. This information is currently available at http://www.fltk.org) */ Modified: trunk/documentation/html_footer =================================================================== --- trunk/documentation/html_footer 2011-05-28 11:26:33 UTC (rev 8750) +++ trunk/documentation/html_footer 2011-05-28 13:16:09 UTC (rev 8751) @@ -2,7 +2,7 @@ <address><small> $datetime. <a href="http://www.fltk.org";><img src="tiny.gif" align="bottom" alt="FLTK"></a> -©2007 Bill Spitzak and others. +©2011 Bill Spitzak and others. <br>Permission is granted to reproduce this manual or any portion for any purpose, provided this copyright and permission notice are preserved. </small></address> Modified: trunk/fltk/Flags.h =================================================================== --- trunk/fltk/Flags.h 2011-05-28 11:26:33 UTC (rev 8750) +++ trunk/fltk/Flags.h 2011-05-28 13:16:09 UTC (rev 8751) @@ -44,7 +44,7 @@ /*! Type returned by fltk::Widget::flags() and passed to fltk::Box and many other drawing functions. */ -typedef int Flags; +typedef unsigned Flags; /*! For back compatability with fltk1.1 */ typedef Flags Align; // for back compatability Modified: trunk/glut/glut_compatability.cxx =================================================================== --- trunk/glut/glut_compatability.cxx 2011-05-28 11:26:33 UTC (rev 8750) +++ trunk/glut/glut_compatability.cxx 2011-05-28 13:16:09 UTC (rev 8751) @@ -56,7 +56,7 @@ These may be created without opening the display, and thus can fit better into FLTK's method of creating windows. -The current GLUT window is available in the global variable ::glut_window. +The current GLUT window is available in the global variable fltk::glut_window. */ Modified: trunk/src/Input.cxx =================================================================== --- trunk/src/Input.cxx 2011-05-28 11:26:33 UTC (rev 8750) +++ trunk/src/Input.cxx 2011-05-28 13:16:09 UTC (rev 8751) @@ -75,8 +75,8 @@ - fltk::WHEN_ENTER_KEY_ALWAYS: The Enter key will do the callback even if the text has not changed. Useful for command fields. Also you need to do this if you want both the enter key and - either WHEN_CHANGED or WHEN_RELEASE, in this case you can tell - if Enter was typed by testing fltk::event_key()==fltk::EnterKey. + either fltk::WHEN_CHANGED or fltk::WHEN_RELEASE, in this case you + can tell if Enter was typed by testing fltk::event_key()==fltk::ReturnKey. - fltk::WHEN_RELEASE: Deprecated. The callback is done if the text has changed and the user clicks on another widget or the focus moves (which can happen due to the window this widget Modified: trunk/src/Scrollbar.cxx =================================================================== --- trunk/src/Scrollbar.cxx 2011-05-28 11:26:33 UTC (rev 8750) +++ trunk/src/Scrollbar.cxx 2011-05-28 13:16:09 UTC (rev 8751) @@ -60,7 +60,7 @@ If you call value() this is set to 1 linesize() less than the window. */ -/*! \fn int Scrollbar::value() +/*! \fn int Scrollbar::value() const Return the current position of the scrollbar as an integer. Scrollbars have step(1) preset (they always return integers). If Modified: trunk/src/WidgetAssociation.cxx =================================================================== --- trunk/src/WidgetAssociation.cxx 2011-05-28 11:26:33 UTC (rev 8750) +++ trunk/src/WidgetAssociation.cxx 2011-05-28 13:16:09 UTC (rev 8751) @@ -244,7 +244,7 @@ /*! Call the functor for each piece of data of the give AssociationType. - This is a wrapper for ::foreach(&at, this, fkt). + This is a wrapper for fltk::foreach(&at, this, fkt). */ void* Widget::foreach(const AssociationType& at, AssociationFunctor& fkt) const { return fltk::foreach(&at, this, fkt); } Modified: trunk/src/file_chooser.cxx =================================================================== --- trunk/src/file_chooser.cxx 2011-05-28 11:26:33 UTC (rev 8750) +++ trunk/src/file_chooser.cxx 2011-05-28 13:16:09 UTC (rev 8751) @@ -133,14 +133,14 @@ system FileChooser is opened. If the user picks multiple files, these will be separated by a new line. - \param \a message is a string used to title the window. + \param message is a string used to title the window. - \param \a pattern is used to limit the files listed in a directory to those + \param pattern is used to limit the files listed in a directory to those matching the pattern. This matching is done by filename_match(). Use NULL to show all files. If use_system_file_chooser() is set to true, this will automatically include the "All Files" option. - \param \a fname is a default folder/filename to fill in the chooser + \param fname is a default folder/filename to fill in the chooser with. If this ends with a '/' then this is a default folder and no file is preselected. @@ -149,11 +149,11 @@ is used. The first time the file chooser is called this defaults to a blank string. - \param \a save determines whether or not the chooser is created in "save" + \param save determines whether or not the chooser is created in "save" or "open" mode. This only effects WIN32 and will probably be replaced by the option to OR FileChooser flags together. - \param \a relative is used to determine whether this function returns a relative + \param relative is used to determine whether this function returns a relative or an absolute pathname. \return The returned value points at a static buffer that is only good until _______________________________________________ fltk-commit mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-commit
