From 6f639ea8d8209974284b1565db489da1182936f5 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Wed, 17 Sep 2008 08:23:24 +0000 Subject: [PATCH] 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 --- FL/Enumerations.H | 2 +- documentation/examples.dox | 2 +- documentation/index.dox | 2 ++ documentation/license.dox | 2 +- documentation/preface.dox | 27 +++++++++++++++------------ 5 files changed, 20 insertions(+), 15 deletions(-) diff --git a/FL/Enumerations.H b/FL/Enumerations.H index 177d432f1..3ca344b0f 100644 --- a/FL/Enumerations.H +++ b/FL/Enumerations.H @@ -374,7 +374,7 @@ enum Fl_When { // Fl_Widget::when(): #define FL_Help 0xff68 ///< The 'help' key on Mac keyboards #define FL_Num_Lock 0xff7f ///< The num lock key. #define FL_KP 0xff80 ///< One of the keypad numbers; use FL_KP + n for number n. -#define FL_KP_Enter 0xff8d ///< The enter key on the keypad, same as Fl_KP+'\r'. +#define FL_KP_Enter 0xff8d ///< The enter key on the keypad, same as Fl_KP+'\\r'. #define FL_KP_Last 0xffbd ///< The last keypad key; use to range-check keypad. #define FL_F 0xffbd ///< One of the function keys; use FL_F + n for function key n. #define FL_F_Last 0xffe0 ///< The last function key; use to range-check function keys. diff --git a/documentation/examples.dox b/documentation/examples.dox index 7ae2482d9..837c6f3b2 100644 --- a/documentation/examples.dox +++ b/documentation/examples.dox @@ -1,6 +1,6 @@ /** - \page examples J - Example Source Code + \page examples K - Example Source Code

March 19, 2005

diff --git a/documentation/index.dox b/documentation/index.dox index e63c35f4a..c12bff0d6 100644 --- a/documentation/index.dox +++ b/documentation/index.dox @@ -90,6 +90,8 @@ \subpage migration_1_3 + \subpage development + \subpage license \subpage examples diff --git a/documentation/license.dox b/documentation/license.dox index fc2e766dd..4deedc3c9 100644 --- a/documentation/license.dox +++ b/documentation/license.dox @@ -1,6 +1,6 @@ /** - \page license I - Software License + \page license J - Software License

December 11, 2001

diff --git a/documentation/preface.dox b/documentation/preface.dox index 2844d5d66..b940fc477 100644 --- a/documentation/preface.dox +++ b/documentation/preface.dox @@ -2,9 +2,9 @@ \page preface Preface -

This manual describes the Fast Light Tool Kit ("FLTK") +

This manual describes the Fast Light Tool Kit ("FLTK") version 1.3.0, a C++ Graphical User Interface -("GUI") toolkit for UNIX, Microsoft Windows and MacOS. Each +("GUI") toolkit for UNIX, Microsoft Windows and MacOS. Each of the chapters in this manual is designed as a tutorial for using FLTK, while the appendices provide a convenient reference for all FLTK widgets, functions, and operating system @@ -12,7 +12,7 @@ interfaces.

This manual may be printed, modified, and/or used under the terms of the FLTK license provided in Appendix A. +HREF="license.html">Appendix H.

Organization

@@ -26,26 +26,25 @@ HREF="license.html">Appendix A.
  • Chapter 3 - Common Widgets and Attributes
    • -
  • Chapter 4 - Designing a Simple Text - Editor
    • +
  • Chapter 4 - Designing a Simple Text Editor
  • Chapter 5 - Drawing Things in FLTK
  • Chapter 6 - Handling Events
    • -
  • Chapter 7 - Extending and - Adding Widgets
    • +
  • Chapter 7 - Adding and Extending Widgets
  • Chapter 8 - Using OpenGL
  • Chapter 9 - Programming With FLUID
    • +
  • Chapter 10 - Advanced FLTK
    • +
  • Appendix A - Class Reference
  • Appendix B - Function Reference
    • -
  • Appendix C - Enumeration - Reference
    • +
  • Appendix C - FLTK Enumerations
  • Appendix D - GLUT Compatibility
    • @@ -53,11 +52,15 @@ HREF="license.html">Appendix A.
  • Appendix F - Operating System Issues
    • -
  • Appendix G - Migrating from FLTK 1.0.x to FLTK 1.1.x
    • +
  • Appendix G - Migrating from FLTK 1.0 to FLTK 1.1
    • -
  • Appendix H - Software License
    • +
  • Appendix H - Migrating from FLTK 1.1 to FLTK 1.3
    • -
  • Appendix I - Example Source Code
    • +
  • Appendix I - Developer Information
    • + +
  • Appendix J - Software License
    • + +
  • Appendix K - Example Source Code