[Plplot-cvs] SF.net SVN: plplot:[12689] trunk

[<ai...@us...>]

Revision: 12689
          http://sourceforge.net/p/plplot/code/12689
Author:   airwin
Date:     2013-11-13 09:10:07 +0000 (Wed, 13 Nov 2013)
Log Message:
-----------
Update documentation of PL_COLORBAR_ORIENT_* bits used to help form
plcolorbar arguments.

The docbook result validates, and the doxygen commentary in the
source file compiles.

The corresponding changes in swig_documentation.i were automatically
generated from the DocBook api.xml file using the
check_swig_documentation target.

Modified Paths:
--------------
    trunk/bindings/swig-support/swig_documentation.i
    trunk/doc/docbook/src/api.xml
    trunk/src/pllegend.c

Modified: trunk/bindings/swig-support/swig_documentation.i
===================================================================
--- trunk/bindings/swig-support/swig_documentation.i	2013-11-13 06:30:19 UTC (rev 12688)
+++ trunk/bindings/swig-support/swig_documentation.i	2013-11-13 09:10:07 UTC (rev 12689)
@@ -702,10 +702,12 @@
     opt (PLINT, input) :    opt contains bits controlling the overall
     color bar.  The orientation (direction of the maximum value) of
     the color bar is specified with PL_ORIENT_RIGHT, PL_ORIENT_TOP,
-    PL_ORIENT_LEFT, or PL_ORIENT_BOTTOM.  If none of those bits are
-    specified, the default orientation is toward the top, i.e., a
-    vertical color bar. If the PL_COLORBAR_BACKGROUND bit is set, plot
-    a (semi-transparent) background for the color bar. If the
+    PL_ORIENT_LEFT, or PL_ORIENT_BOTTOM.  If none of these bits are
+    specified, the default orientation is toward the top if the
+    colorbar is placed on the left or right of the viewport or toward
+    the right if the colorbar is placed on the top or bottom of the
+    viewport. If the PL_COLORBAR_BACKGROUND bit is set, plot a
+    (semi-transparent) background for the color bar. If the
     PL_COLORBAR_BOUNDING_BOX bit is set, plot a bounding box for the
     color bar. The type of color bar must be specified with one of
     PL_COLORBAR_IMAGE, PL_COLORBAR_SHADE, or PL_COLORBAR_GRADIENT. If

Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml	2013-11-13 06:30:19 UTC (rev 12688)
+++ trunk/doc/docbook/src/api.xml	2013-11-13 09:10:07 UTC (rev 12689)
@@ -1954,10 +1954,12 @@
 	    the maximum value) of the color bar is specified with
 	    <literal>PL_ORIENT_RIGHT</literal>, <literal>PL_ORIENT_TOP</literal>,
 	    <literal>PL_ORIENT_LEFT</literal>, or
-	    <literal>PL_ORIENT_BOTTOM</literal>.  If none of those bits are
-	    specified, the default orientation is toward the top, i.e., a vertical
-	    color bar. If the <literal>PL_COLORBAR_BACKGROUND</literal> bit is
-	    set, plot a (semi-transparent) background for the color bar. If the
+	    <literal>PL_ORIENT_BOTTOM</literal>.  If none of these bits are
+	    specified, the default orientation is toward the top if the colorbar
+	    is placed on the left or right of the viewport or toward the right if
+	    the colorbar is placed on the top or bottom of the viewport. If the
+	    <literal>PL_COLORBAR_BACKGROUND</literal> bit is set, plot a
+	    (semi-transparent) background for the color bar. If the
 	    <literal>PL_COLORBAR_BOUNDING_BOX</literal> bit is set, plot a
 	    bounding box for the color bar. The type of color bar must be
 	    specified with one of <literal>PL_COLORBAR_IMAGE</literal>,

Modified: trunk/src/pllegend.c
===================================================================
--- trunk/src/pllegend.c	2013-11-13 06:30:19 UTC (rev 12688)
+++ trunk/src/pllegend.c	2013-11-13 09:10:07 UTC (rev 12689)
@@ -1400,8 +1400,10 @@
 //! @param opt This variable contains bits which control the overall
 //! color bar.  The orientation (direction of the maximum value) of
 //! the color bar is specified with PL_COLORBAR_ORIENT_(RIGHT, TOP,
-//! LEFT, BOTTOM).  If none of those bits are specified, the default
-//! orientation is toward the top, i.e., a vertical color bar.  If the
+//! LEFT, BOTTOM).  If none of these bits are specified, the default
+//! orientation is toward the top if the colorbar is placed on the
+//! left or right of the viewport or toward the right if the colorbar
+//! is placed on the top or bottom of the viewport.  If the
 //! PL_COLORBAR_BACKGROUND bit is set, plot a (semi-transparent)
 //! background for the color bar.  If the PL_COLORBAR_BOUNDING_BOX bit
 //! is set, plot a bounding box for the color bar.  The type of color

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.