GNOME.org
 

[clutter-box2dmm] Slight documentation improvements.

commit 6e09a6cc51ecfd6fc28199f351b59c713c920481
Author: Murray Cumming <murrayc murrayc com>
Date:   Wed May 5 23:58:52 2010 +0200

    Slight documentation improvements.
    
    * clutter-box2d/clutter-box2dmm.h: Slightly improved main page text, linking
    to the Box2D class.
    * clutter-box2d/src/box2d.hg: Added brief class documentation.
    * clutter-box2d/src/clutter-box2d_methods.defs: Regenerated, though no change
    seems very significant.

 ChangeLog                                    |   12 +++
 INSTALL                                      |   97 +++++++++++++++++++++-----
 NEWS                                         |    5 ++
 clutter-box2d/clutter-box2dmm.h              |    5 +-
 clutter-box2d/src/box2d.hg                   |    2 +-
 clutter-box2d/src/clutter-box2d_methods.defs |   39 ++++++----
 configure.ac                                 |    4 +-
 7 files changed, 125 insertions(+), 39 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index e756e8e..b405d6c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+0.9.2:
+
+2010-05-05  Murray Cumming  <murrayc murrayc com>
+
+	Slight documentation improvements.
+	
+	* clutter-box2d/clutter-box2dmm.h: Slightly improved main page text, linking 
+	to the Box2D class.
+	* clutter-box2d/src/box2d.hg: Added brief class documentation.
+	* clutter-box2d/src/clutter-box2d_methods.defs: Regenerated, though no change 
+	seems very significant.
+
 2010-04-28  David King  <davidk openismus com>
 
 	Add main page to Doxygen documentation
diff --git a/INSTALL b/INSTALL
index 2550dab..7d1c323 100644
--- a/INSTALL
+++ b/INSTALL
@@ -4,8 +4,10 @@ Installation Instructions
 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
 
-   This file is free documentation; the Free Software Foundation gives
-unlimited permission to copy, distribute and modify it.
+   Copying and distribution of this file, with or without modification,
+are permitted in any medium without royalty provided the copyright
+notice and this notice are preserved.  This file is offered as-is,
+without warranty of any kind.
 
 Basic Installation
 ==================
@@ -13,7 +15,11 @@ Basic Installation
    Briefly, the shell commands `./configure; make; make install' should
 configure, build, and install this package.  The following
 more-detailed instructions are generic; see the `README' file for
-instructions specific to this package.
+instructions specific to this package.  Some packages provide this
+`INSTALL' file but do not implement all of the features documented
+below.  The lack of an optional feature in a given package is not
+necessarily a bug.  More recommendations for GNU packages can be found
+in *note Makefile Conventions: (standards)Makefile Conventions.
 
    The `configure' shell script attempts to guess correct values for
 various system-dependent variables used during compilation.  It uses
@@ -42,7 +48,7 @@ may remove or edit it.
 you want to change it or regenerate `configure' using a newer version
 of `autoconf'.
 
-The simplest way to compile this package is:
+   The simplest way to compile this package is:
 
   1. `cd' to the directory containing the package's source code and type
      `./configure' to configure the package for your system.
@@ -53,12 +59,22 @@ The simplest way to compile this package is:
   2. Type `make' to compile the package.
 
   3. Optionally, type `make check' to run any self-tests that come with
-     the package.
+     the package, generally using the just-built uninstalled binaries.
 
   4. Type `make install' to install the programs and any data files and
-     documentation.
-
-  5. You can remove the program binaries and object files from the
+     documentation.  When installing into a prefix owned by root, it is
+     recommended that the package be configured and built as a regular
+     user, and only the `make install' phase executed with root
+     privileges.
+
+  5. Optionally, type `make installcheck' to repeat any self-tests, but
+     this time using the binaries in their final installed location.
+     This target does not install anything.  Running this target as a
+     regular user, particularly if the prior `make install' required
+     root privileges, verifies that the installation completed
+     correctly.
+
+  6. You can remove the program binaries and object files from the
      source code directory by typing `make clean'.  To also remove the
      files that `configure' created (so you can compile the package for
      a different kind of computer), type `make distclean'.  There is
@@ -67,8 +83,15 @@ The simplest way to compile this package is:
      all sorts of other programs in order to regenerate files that came
      with the distribution.
 
-  6. Often, you can also type `make uninstall' to remove the installed
-     files again.
+  7. Often, you can also type `make uninstall' to remove the installed
+     files again.  In practice, not all packages have tested that
+     uninstallation works correctly, even though it is required by the
+     GNU Coding Standards.
+
+  8. Some packages, particularly those that use Automake, provide `make
+     distcheck', which can by used by developers to test that all other
+     targets like `make install' and `make uninstall' work correctly.
+     This target is generally not run by end users.
 
 Compilers and Options
 =====================
@@ -93,7 +116,8 @@ same time, by placing the object files for each architecture in their
 own directory.  To do this, you can use GNU `make'.  `cd' to the
 directory where you want the object files and executables to go and run
 the `configure' script.  `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
+source code in the directory that `configure' is in and in `..'.  This
+is known as a "VPATH" build.
 
    With a non-GNU `make', it is safer to compile the package for one
 architecture at a time in the source code directory.  After you have
@@ -120,7 +144,8 @@ Installation Names
    By default, `make install' installs the package's commands under
 `/usr/local/bin', include files under `/usr/local/include', etc.  You
 can specify an installation prefix other than `/usr/local' by giving
-`configure' the option `--prefix=PREFIX'.
+`configure' the option `--prefix=PREFIX', where PREFIX must be an
+absolute file name.
 
    You can specify separate installation prefixes for
 architecture-specific files and architecture-independent files.  If you
@@ -131,15 +156,46 @@ Documentation and other data files still use the regular prefix.
    In addition, if you use an unusual directory layout you can give
 options like `--bindir=DIR' to specify different values for particular
 kinds of files.  Run `configure --help' for a list of the directories
-you can set and what kinds of files go in them.
+you can set and what kinds of files go in them.  In general, the
+default for these options is expressed in terms of `${prefix}', so that
+specifying just `--prefix' will affect all of the other directory
+specifications that were not explicitly provided.
+
+   The most portable way to affect installation locations is to pass the
+correct locations to `configure'; however, many packages provide one or
+both of the following shortcuts of passing variable assignments to the
+`make install' command line to change installation locations without
+having to reconfigure or recompile.
+
+   The first method involves providing an override variable for each
+affected directory.  For example, `make install
+prefix=/alternate/directory' will choose an alternate location for all
+directory configuration variables that were expressed in terms of
+`${prefix}'.  Any directories that were specified during `configure',
+but not in terms of `${prefix}', must each be overridden at install
+time for the entire installation to be relocated.  The approach of
+makefile variable overrides for each directory variable is required by
+the GNU Coding Standards, and ideally causes no recompilation.
+However, some platforms have known limitations with the semantics of
+shared libraries that end up requiring recompilation when using this
+method, particularly noticeable in packages that use GNU Libtool.
+
+   The second method involves providing the `DESTDIR' variable.  For
+example, `make install DESTDIR=/alternate/directory' will prepend
+`/alternate/directory' before all installation names.  The approach of
+`DESTDIR' overrides is not required by the GNU Coding Standards, and
+does not work on platforms that have drive letters.  On the other hand,
+it does better at avoiding recompilation issues, and works well even
+when some directory options were not specified in terms of `${prefix}'
+at `configure' time.
+
+Optional Features
+=================
 
    If the package supports it, you can cause programs to be installed
 with an extra prefix or suffix on their names by giving `configure' the
 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 
-Optional Features
-=================
-
    Some packages pay attention to `--enable-FEATURE' options to
 `configure', where FEATURE indicates an optional part of the package.
 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
@@ -152,6 +208,13 @@ find the X include and library files automatically, but if it doesn't,
 you can use the `configure' options `--x-includes=DIR' and
 `--x-libraries=DIR' to specify their locations.
 
+   Some packages offer the ability to configure how verbose the
+execution of `make' will be.  For these packages, running `./configure
+--enable-silent-rules' sets the default to minimal output, which can be
+overridden with `make V=1'; while running `./configure
+--disable-silent-rules' sets the default to verbose, which can be
+overridden with `make V=0'.
+
 Particular systems
 ==================
 
@@ -288,7 +351,7 @@ operates.
      `configure' can determine that directory automatically.
 
 `--prefix=DIR'
-     Use DIR as the installation prefix.  *Note Installation Names::
+     Use DIR as the installation prefix.  *note Installation Names::
      for more details, including other options available for fine-tuning
      the installation locations.
 
diff --git a/NEWS b/NEWS
index 00ffc27..e5cedb6 100644
--- a/NEWS
+++ b/NEWS
@@ -1,3 +1,8 @@
+0.9.2:
+
+* Added main page documentation for doxygen.
+  (David King, Murray Cumming)
+  
 0.9.1:
 
 * Use cluttermm-1.0 and Use clutter-box2d-0.10.
diff --git a/clutter-box2d/clutter-box2dmm.h b/clutter-box2d/clutter-box2dmm.h
index d277388..1dd46a9 100644
--- a/clutter-box2d/clutter-box2dmm.h
+++ b/clutter-box2d/clutter-box2dmm.h
@@ -24,9 +24,8 @@
  *
  * @section description Description
  *
- * clutter-box2dmm is a C++ wrapper for clutter-box2d.
- *
- * See also the <a href="http://www.clutter-project.org/";>clutter website</a>.
+ * clutter-box2dmm is a C++ wrapper for  <a href="http://www.clutter-project.org/";>clutter-box2d</a>.
+ * See Clutter::Box2D::Box2D
  *
  * @section basics Basic Usage
  * Include the clutter-box2dmm header:
diff --git a/clutter-box2d/src/box2d.hg b/clutter-box2d/src/box2d.hg
index 5e446d8..a5b0838 100644
--- a/clutter-box2d/src/box2d.hg
+++ b/clutter-box2d/src/box2d.hg
@@ -30,7 +30,7 @@ namespace Box2D
 
 _WRAP_ENUM(Type, ClutterBox2DType, NO_GTYPE)
 
-/** TODO: Documentation.
+/** This is a container that can physically simulate collisions between dynamic and static actors.
  * Use set_child_property() on the child actors.
  */
 class Box2D :
diff --git a/clutter-box2d/src/clutter-box2d_methods.defs b/clutter-box2d/src/clutter-box2d_methods.defs
index 9e2bc21..c201fc4 100644
--- a/clutter-box2d/src/clutter-box2d_methods.defs
+++ b/clutter-box2d/src/clutter-box2d_methods.defs
@@ -7,30 +7,33 @@
   (gtype-id "CLUTTER_TYPE_BOX2_D")
 )
 
-(define-object Box2DActor
+(define-object Box2DCollision
   (in-module "Clutter")
-  (parent "ClutterChildMeta")
-  (c-name "ClutterBox2DActor")
-  (gtype-id "CLUTTER_TYPE_BOX2_DACTOR")
+  (parent "GObject")
+  (c-name "ClutterBox2DCollision")
+  (gtype-id "CLUTTER_TYPE_BOX2_DCOLLISION")
 )
 
 ;; Enumerations and flags ...
 
 
-;; From clutter-box2d-actor.h
+;; From clutter-box2d-collision.h
 
-(define-method get_actor
-  (of-object "ClutterBox2D")
-  (c-name "clutter_box2d_get_actor")
-  (return-type "ClutterBox2DActor*")
-  (parameters
-    '("ClutterActor*" "actor")
-  )
+(define-function clutter_box2d_collision_get_type
+  (c-name "clutter_box2d_collision_get_type")
+  (return-type "GType")
 )
 
-(define-function clutter_box2d_actor_get_type
-  (c-name "clutter_box2d_actor_get_type")
-  (return-type "GType")
+
+
+;; From clutter-box2d-contact.h
+
+(define-function Result
+  (c-name "Result")
+  (return-type "none")
+  (parameters
+    '("const-b2ContactResult*" "point")
+  )
 )
 
 
@@ -127,7 +130,7 @@
   (return-type "ClutterBox2DJoint*")
   (parameters
     '("ClutterActor*" "actor")
-    '("ClutterVertex*" "target")
+    '("const-ClutterVertex*" "target")
   )
 )
 
@@ -148,6 +151,10 @@
 
 
 
+;; From clutter-box2d-marshal.h
+
+
+
 ;; From clutter-box2d-util.h
 
 (define-function clutter_box2d_actor_track
diff --git a/configure.ac b/configure.ac
index 35d921d..18c8e7b 100644
--- a/configure.ac
+++ b/configure.ac
@@ -15,7 +15,7 @@
 ## You should have received a copy of the GNU Lesser General Public License
 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-AC_INIT([clutter-box2dmm], [0.9.1],
+AC_INIT([clutter-box2dmm], [0.9.2],
         [http://bugzilla.gnome.org/enter_bug.cgi?product=clutter-box2dmm],
         [clutter-box2dmm], [http://www.gtkmm.org/])
 AC_PREREQ([2.59])
@@ -41,7 +41,7 @@ AC_DISABLE_STATIC
 AC_LIBTOOL_WIN32_DLL
 AC_PROG_LIBTOOL
 
-AC_SUBST([CLUTTER_BOX2DMM_MODULES], ['clutter-box2d-0.10 >= 0.10.0 cluttermm-1.0 >= 0.9.5'])
+AC_SUBST([CLUTTER_BOX2DMM_MODULES], ['clutter-box2d-0.10 >= 0.10.0 cluttermm-1.0 >= 0.9.6'])
 PKG_CHECK_MODULES([CLUTTER_BOX2DMM], [$CLUTTER_BOX2DMM_MODULES])
 MM_PKG_CONFIG_SUBST([GMMPROC_DIR], [--variable=gmmprocdir glibmm-2.4])
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]