fix to readme, enhance readability of doxytags for WRATHGradientSourc…

…eBase and WRATHtextureCoordinateSourceBase and add missing bold to doxytag in WRATHShaderBrushSourceHoard

README.1st

@@ -35,7 +35,7 @@ Documentation
   WRATH has doxygen documentation complete with tutorials and overview text,
 build the documentation with:
 
- #cd docs; make  
+ #cd docs && make  
 
 and find it at docs/doxy/html/index.html
 
@@ -46,7 +46,7 @@ Porting WRATH
 Most of WRATH's source code is standard vanilla C/C++ code.
 The main issues of which to be aware are:
   - GL version and GL header files. This is the NGL system. You will
-    need to hack ngl/Rules.ml for a new target to where the GL/GLES
+    need to hack ngl/Rules.mk for a new target to where the GL/GLES
     header files are located In addition, you will need to set 
     correctly the GL/GLES version, in Makefile.settings,
     the variable GL_VERSION 

inc/WRATH/image/WRATHGradientSourceBase.hpp

@@ -51,8 +51,8 @@ namespace WRATHGradientSourceBasePrivate
     interpolation_behaviour_t
 
   - A gradient interpolate is implemented in GLSL by
-    implementing 2 functions: pre_compute_gradient()
-    and compute_gradient(). 
+    implementing 2 functions: <B>pre_compute_gradient()</B>
+    and <B>compute_gradient()</B>. 
 
   The interpolation behavior can be linear, partially-nonlinear
   and fully non-linear. The caller requests the nature
@@ -79,7 +79,8 @@ namespace WRATHGradientSourceBasePrivate
     \code   
     void pre_compute_gradient(in vec2 p)
     \endcode
-    in the vertex shader and the function
+    in the vertex shader.\n\n 
+    Also implement the function
     \code
     vec2 compute_gradient(in vec2 p)
     \endcode
@@ -99,7 +100,8 @@ namespace WRATHGradientSourceBasePrivate
     \code   
     void pre_compute_gradient(void)
     \endcode
-    in the vertex shader and the function
+    in the vertex shader.\n\n 
+    Also implement the function
     \code
     vec2 compute_gradient(in vec2 p)
     \endcode
@@ -176,7 +178,7 @@ class WRATHGradientSourceBase:public WRATHBaseSource
     \param prec precision qaulifier to use
     \param suffix suffix to which to append to all function, macros, etc
                   added to the GLSL code, including the functions
-                  compute_gradient() and pre_compute_gradient(). 
+                  <B>compute_gradient()</B> and <B>pre_compute_gradient()</B>. 
                   A non-empty suffix indicates that the functions
                   are being chained from another function, in this
                   case none of the macros LINEAR_GRADIENT, NON_LINEAR_GRADIENT
@@ -220,7 +222,7 @@ class WRATHGradientSourceBase:public WRATHBaseSource
     \param prec precision qaulifier to use
     \param suffix suffix to which to append to all symbols of GLSL shaders
                   that are at global scope, including the functions
-                  compute_gradient() and pre_compute_gradient()
+                  <B>compute_gradient()</B> and <B>pre_compute_gradient()</B>
    */
   virtual
   void

inc/WRATH/image/WRATHShaderBrushSourceHoard.hpp

@@ -74,7 +74,7 @@ class WRATHShaderBrushSourceHoard:boost::noncopyable
         - <B>void wrath_shader_brush_prepare()</B> in the
           vertex shader to perform any pre-compute stages of 
           the gradient and image 
-        - vec4 wrath_shader_brush_color(in vec2 p) in the fragment
+        - <B>vec4 wrath_shader_brush_color(in vec2 p)</B> in the fragment
           shader taking as input the brush coordinate to feed 
           to image and gradient. If the brush dictates that the 
           fragment should not be drawn, issues a discard. Also defines 

inc/WRATH/image/WRATHTextureCoordinateSourceBase.hpp

@@ -69,7 +69,8 @@ namespace WRATHTextureCoordinateSourceBasePrivate
     \code   
     void pre_compute_texture_coordinate(in vec2 p)
     \endcode
-    in the vertex shader and the function
+    in the vertex shader.\n\n 
+    Also implement the function
     \code
     vec2 compute_texture_coordinate(in vec2 p)
     \endcode
@@ -83,7 +84,8 @@ namespace WRATHTextureCoordinateSourceBasePrivate
     \code   
     void pre_compute_texture_coordinate(void)
     \endcode
-    in the vertex shader and the function
+    in the vertex shader.\n\n 
+    Also implement the function
     \code
     vec2 compute_texture_coordinate(in vec2 p)
     \endcode
@@ -140,7 +142,8 @@ class WRATHTextureCoordinateSourceBase:public WRATHBaseSource
     \param prec precision qaulifier to use
     \param suffix suffix to which to append to all function, macros, etc
                   added to the GLSL code, including the functions
-                  compute_texture_coordinate() and pre_compute_texture_coordinate().
+                  <B>compute_texture_coordinate()</B> and 
+                  <B>pre_compute_texture_coordinate()</B>.
                   A non-empty suffix indicates that the functions
                   are being chained from another function, in this
                   case none of the macros LINEAR_TEXTURE_COORDINATE, 
@@ -187,7 +190,8 @@ class WRATHTextureCoordinateSourceBase:public WRATHBaseSource
     \param prec precision qaulifier to use
     \param suffix suffix to which to append to all symbols of GLSL shaders
                   that are at global scope, including the functions
-                  compute_texture_coordinate() and pre_compute_texture_coordinate().
+                  <B>compute_texture_coordinate()</B> and 
+                  <B>pre_compute_texture_coordinate()</B>.
    */
   virtual
   void