Clarification and better documentation of ABI version configuration.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11804 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

5 files changed, 13 insertions, 18 deletions

diff --git a/CMake/options.cmake b/CMake/options.cmake
index 446357faf..11c92823b 100644
--- a/CMake/options.cmake
+++ b/CMake/options.cmake
@@ -4,7 +4,7 @@
 # Main CMakeLists.txt to build the FLTK project using CMake (www.cmake.org)
 # Written by Michael Surette
 #
-# Copyright 1998-2015 by Bill Spitzak and others.
+# Copyright 1998-2016 by Bill Spitzak and others.
 #
 # This library is free software. Distribution and use rights are outlined in
 # the file "COPYING" which should have been included with this file.  If this
@@ -36,7 +36,7 @@ add_definitions(${OPTION_ARCHFLAGS})
 #######################################################################
 set(OPTION_ABI_VERSION ""
    CACHE STRING
-   "FLTK ABI Version (FL_ABI_VERSION - define as 10x0y for 1.x.y)"
+   "FLTK ABI Version FL_ABI_VERSION: 1xxyy for 1.x.y (xx,yy with leading zero)"
    )
 set(FL_ABI_VERSION ${OPTION_ABI_VERSION})
 
diff --git a/FL/Enumerations.H b/FL/Enumerations.H
index 9203b514c..5612bd5c9 100644
--- a/FL/Enumerations.H
+++ b/FL/Enumerations.H
@@ -3,7 +3,7 @@
 //
 // Enumerations for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2015 by Bill Spitzak and others.
+// Copyright 1998-2016 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
 // the file "COPYING" which should have been included with this file.  If this
@@ -34,13 +34,8 @@
  *	or CMake. Do NOT define it here. Its definition will be included
  *	below by "#include <FL/abi-version.h>".
  *
- * (3)	If you use the provided IDE files (Windows VC++ or Xcode) you should
- *	edit the definition in the provided IDE subdirectory. The correct
- *	file is `/path/to/fltk/ide/<IDE-name>/FL/abi-version.h' .
- *
  ******************************************************************************
- * For more info on FL_ABI_VERSION, see: http://fltk.org/cmp.php#FL_ABI_VERSION
- * FIXME: Update docs ...
+ * For more informations on FL_ABI_VERSION see README.abi-version.txt.
  ******************************************************************************
  */
 
@@ -91,8 +86,8 @@
     \deprecated This \p double version number is retained for compatibility
     with existing program code. New code should use \em int FL_API_VERSION
     instead. FL_VERSION is deprecated because comparisons of floating point
-    values may fail because of rounding errors. However, there are
-    currently no plans to remove this constant.
+    values may fail due to rounding errors. However, there are currently no
+    plans to remove this deprecated constant.
 
     FL_VERSION is equivalent to <em>(double)FL_API_VERSION / 10000</em>.
 
@@ -152,7 +147,7 @@
     To enable new ABI-breaking features in patch releases you can configure
     FLTK to use a higher FL_ABI_VERSION.
 
-    \todo Configuration of FL_ABI_VERSION needs documentation.
+    \see README.abi-version.txt
  */
 #ifndef FL_ABI_VERSION
 #define FL_ABI_VERSION (FL_MAJOR_VERSION*10000 + FL_MINOR_VERSION*100)
@@ -904,7 +899,7 @@ extern FL_EXPORT Fl_Fontsize FL_NORMAL_SIZE;	///< normal font size
 /** \name Colors 
     The Fl_Color type holds an FLTK color value.
 
-    Colors are either 8-bit indexes into a virtual colormap
+    Colors are either 8-bit indexes into a <a href="fltk-colormap.png">virtual colormap</a>
     or 24-bit RGB color values. (See \ref drawing_colors for the default FLTK colormap)
 
     Color indices occupy the lower 8 bits of the value, while
diff --git a/README.abi-version.txt b/README.abi-version.txt
index e9004d879..25fa06db9 100644
--- a/README.abi-version.txt
+++ b/README.abi-version.txt
@@ -5,7 +5,7 @@ FLTK preserves the application binary interface (ABI) throughout
 patch versions, for instance all 1.3.x versions (x = patch version).
 
 This basically means that a program compiled and linked with FLTK 1.3.0
-can run with a FLTK shared library (fltk.dll, fltk.so.1.3.4) of a later
+can run with a FLTK shared library (fltk.dll, fltk.so.1.3.x) of a later
 FLTK version.
 
 Since FLTK 1.3.1 the FLTK team began to introduce ABI-breaking features
diff --git a/abi-version.cmake.in b/abi-version.cmake.in
index d3e1ad563..ea1dc598e 100644
--- a/abi-version.cmake.in
+++ b/abi-version.cmake.in
@@ -3,7 +3,7 @@
  *
  * Configuration file for the Fast Light Tool Kit (FLTK).
  *
- * Copyright 1998-2015 by Bill Spitzak and others.
+ * Copyright 1998-2016 by Bill Spitzak and others.
  *
  * This library is free software. Distribution and use rights are outlined in
  * the file "COPYING" which should have been included with this file.  If this
@@ -22,7 +22,7 @@
   ============================================================================
 */
 
-/* define FL_ABI_VERSION as 10x0y for FLTK ABI version 1.x.y */
+/* define FL_ABI_VERSION: 1xxyy for 1.x.y (xx,yy with leading zero) */
 
 #cmakedefine FL_ABI_VERSION @FL_ABI_VERSION@
 
diff --git a/abi-version.in b/abi-version.in
index 9e958e077..5b0857441 100644
--- a/abi-version.in
+++ b/abi-version.in
@@ -3,7 +3,7 @@
  *
  * Configuration file for the Fast Light Tool Kit (FLTK).
  *
- * Copyright 1998-2015 by Bill Spitzak and others.
+ * Copyright 1998-2016 by Bill Spitzak and others.
  *
  * This library is free software. Distribution and use rights are outlined in
  * the file "COPYING" which should have been included with this file.  If this
@@ -22,7 +22,7 @@
   ============================================================================
 */
 
-/* define FL_ABI_VERSION as 10x0y for FLTK ABI version 1.x.y */
+/* define FL_ABI_VERSION: 1xxyy for 1.x.y (xx,yy with leading zero) */
 
 #undef FL_ABI_VERSION