[Boost-commit] svn:boost r50993 - sandbox/guigl/libs/guigl/doc

Subject: [Boost-commit] svn:boost r50993 - sandbox/guigl/libs/guigl/doc
From: stipe_at_[hidden]
Date: 2009-02-03 11:33:15

Author: srajko
Date: 2009-02-03 11:33:15 EST (Tue, 03 Feb 2009)
New Revision: 50993
URL: http://svn.boost.org/trac/boost/changeset/50993

Log:
adding guigl docs
Added:
   sandbox/guigl/libs/guigl/doc/
   sandbox/guigl/libs/guigl/doc/Jamfile   (contents, props changed)
   sandbox/guigl/libs/guigl/doc/guigl.qbk   (contents, props changed)

Added: sandbox/guigl/libs/guigl/doc/Jamfile
==============================================================================
--- (empty file)
+++ sandbox/guigl/libs/guigl/doc/Jamfile	2009-02-03 11:33:15 EST (Tue, 03 Feb 2009)
@@ -0,0 +1,65 @@
+#==================================---------------------------------------------
+#   Copyright 2008 Stjepan Rajko
+#  
+#   Distributed under the Boost Software License, Version 1.0.
+#   (See accompanying file LICENSE_1_0.txt or copy at
+#   http://www.boost.org/LICENSE_1_0.txt)
+#----------------------------------------------===============================*/
+
+
+project boost/guigl/doc ;
+
+import boostbook : boostbook ;
+using quickbook ;
+
+local loc = [ path.native [ path.pwd ] ] ;
+
+xml guigl_xml : guigl.qbk ;
+
+doxygen guigl_doxygen
+   :
+      [ glob $(TOP)/boost/guigl/window.hpp ]
+      [ glob $(TOP)/boost/guigl/widget/button.hpp ]
+      [ glob $(TOP)/boost/guigl/widget/slider.hpp ]
+      [ glob $(TOP)/boost/guigl/view/active_colored.hpp ]
+      [ glob $(TOP)/boost/guigl/view/clickable.hpp ]
+      [ glob $(TOP)/boost/guigl/view/draggable.hpp ]
+      [ glob $(TOP)/boost/guigl/view/solid_background.hpp ]
+   :
+        <doxygen:param>TAB_SIZE=4
+        <doxygen:param>EXAMPLE_PATH=../test
+        <doxygen:param>EXAMPLE_PATH=../example
+        <doxygen:param>STRIP_FROM_PATH=$(TOP)
+        <doxygen:param>STRIP_FROM_INC_PATH=$(TOP)
+        <doxygen:param>EXTRACT_ALL=NO
+        <doxygen:param>HIDE_UNDOC_MEMBERS=YES
+        <doxygen:param>INHERIT_DOCS=YES
+        <doxygen:param>EXTRACT_PRIVATE=NO
+        <doxygen:param>ENABLE_PREPROCESSING=YES
+        <doxygen:param>MACRO_EXPANSION=YES
+        <doxygen:param>SEARCH_INCLUDES=YES
+        <doxygen:param>INCLUDE_PATH=$(TOP)
+        <doxygen:param>INCLUDE_PATH=$(BOOST_ROOT)
+        <doxygen:param>PREDEFINED=DOXYGEN_DOCS_BUILD
+   ;
+
+boostbook standalone
+   :
+      guigl_xml
+      guigl_doxygen
+    :
+        # pull in the online .css and images
+        <xsl:param>project.root=http://dancinghacker.com
+        # without the next line, build complains
+        <xsl:param>annotation.support=1
+        # pulled this from the doc_test Jamfile
+        <xsl:param>quickbook.source.style.show="'true'"
+        # formatting options
+        <xsl:param>chunk.first.sections=1
+        <xsl:param>chunk.section.depth=10
+        <xsl:param>toc.section.depth=4
+        <xsl:param>toc.max.depth=2
+        <xsl:param>generate.section.toc.level=4
+    ;
+
+install png : [ glob *.png ] : <location>html ;

Added: sandbox/guigl/libs/guigl/doc/guigl.qbk
==============================================================================
--- (empty file)
+++ sandbox/guigl/libs/guigl/doc/guigl.qbk	2009-02-03 11:33:15 EST (Tue, 03 Feb 2009)
@@ -0,0 +1,50 @@
+[article guigl
+    [quickbook 1.4]
+    [version alpha]
+    [authors [Rajko, Stjepan]]
+    [copyright 2008 Stjepan Rajko]
+    [purpose A modular GUI library that uses OpenGL.]
+    [license
+        Distributed under the Boost Software License, Version 1.0.
+        (See accompanying file LICENSE_1_0.txt or copy at
+        [@http://www.boost.org/LICENSE_1_0.txt])
+    ]
+]
+
+[template guigl[] [^guigl]]
+[template boost[] [@http://www.boost.org boost]]
+
+[section Introduction]
+
+[guigl] is a modular GUI library tbat uses OpenGL.  It's development was
+inspired by the [@http://mat.ucsb.edu/glv/ GLV library].  The major design goals
+of guigl are:
+
+* To provide a basic set of GUI elements / widgets.
+* To allow easy creation of new GUI elements / widgets through code reuse.
+* To maximally use the [boost] libraries for anything not directly reated to
+  GUI functionality.
+
+In [guigl], GUI elements are referred to as /views/.  /views/ are
+implemented through a simple chaining of /behaviors/, where each behavior can
+change the way the view looks and/or change the way in which the view responds
+to user interaction.  Behaviors can also add member functions and variables
+to the view, which can be used by other view code or user code.
+
+[/For example, the [classref guigl::view::button button] widget is implemented
+by combining.]
+
+
+
+[endsect]
+
+[section:license License]
+
+Copyright 2007 Stjepan Rajko.
+Distributed under the Boost Software License, Version 1.0. (See
+accompanying file LICENSE_1_0.txt or copy at
+[@http://www.boost.org/LICENSE_1_0.txt])
+
+[endsect]
+
+[xinclude guigl_doxygen.xml]