Updated Doxygen documentation

compositemodel/include/GoTools/compositemodel/compositemodel-doxymain.h

@@ -9,25 +9,31 @@
 ///
 /// Contains tools for representing composite models.
 ///
+/// \if null
 /// An overview documentation for this module can be found in
 /// \ref compositemodel_doc.
-/// 
-/// This module depends on:
-/// - The GoTools Core library
+/// \endif
+///  
+/// This module depends on the following GoTools modules:
+/// - GoTools Core
 /// - GoTools Implicitization
 /// - GoTools Intersection
 /// - GoTools Parametrization
-/// - GoTools ttl
-/// - GoTools igeslib
-/// - SISL
-/// - GoTools topology
+/// - GoTools Igeslib
+/// - GoTools Topology
+///
+/// and the following modules external to GoTools:
+/// - SISL (SINTEF)
+/// - TTL (SINTEF)
 /// - The newmat matrix library, which is freely available from <a
 /// href ="http://www.robertnz.net/">www.robertnz.net</a>.
+///
+/// SISL, TTL and newmat is included for convenience.
 
-/// \namespace Go
-/// The Go namespace is the common namespace for all GoTools modules.
+// /// \namespace Go
+// /// The Go namespace is the common namespace for all GoTools modules.
 
-/// \namespace hetriang
-/// Namespace for classes in the half-edge data structure.
+// /// \namespace hetriang
+// /// Namespace for classes in the half-edge data structure.
 
 #endif // _COMPOSITEMODEL_DOXYMAIN_H

gotools-core/include/GoTools/utils/gotools-doxymain.h

@@ -61,6 +61,54 @@
 /// \li <a href="http://www.robertnz.net">newmat</a> (available with a permissive license), for various matrix operations.
 ///
 /// For convenience, these libraries are included in the GPL version of GoTools.
+///
+/// \section building Building GoTools
+///
+/// This GoTools package uses CMake to generate a Makefile (on Linux)
+/// or MS Visual Studio project file (on Windows).
+/// 
+/// For information on using CMake, see <a href="http://www.cmake.org">www.cmake.org</a>.
+/// 
+/// As a Quick Start Guide, on Linux, make a build directory somewhere:
+/// 
+/// \verbatim
+$ cd some_dir
+$ mkdir build
+$ cd build
+$ ccmake <path_to_source_code>
+\endverbatim
+///
+/// Follow the instructions of 'ccmake' - the CMake "GUI". Then:
+/// 
+/// \verbatim
+$ make
+$ sudo make install
+\endverbatim
+///
+/// On Windows, add a new build folder somewhere. Start the CMake
+/// executable and fill in the paths to the source and build folders. When
+/// you run CMake, a Visual Studio project solution file will be generated
+/// in the build folder.
+/// 
+/// \subsection compilers Compilers
+///
+/// The code uses certain features of the new C++ standard C++11, most
+/// notably the smart pointer \c std::shared_ptr. It has been tested
+/// on GCC 4.6.1 on Linux and Visual Studio 2010 on Windows.
+///
+/// A set of options to control the build can be accessed in CMake
+/// (names starting with \c GoTools). For example, you can turn on/off
+/// building the various modules by checking/unchecking \c
+/// GoTools_COMPILE_MODULE_<modulename>.
+///
+/// Also provided is the option \c GoTools_USE_BOOST. If this option
+/// is turned on, the building process uses \c boost::shared_ptr
+/// instead of \c std::shared_ptr. If a C++11 compliant compiler is
+/// not available, you may try this option and see if it
+/// works. Requires Boost: <a
+/// href="http://www.boost.org">www.boost.org</a>.
+
+
 
 #endif // _DOXYMAIN_H
 

igeslib/include/GoTools/igeslib-doxymain.h

@@ -12,9 +12,11 @@
 #define _IGESLIB-DOXYMAIN_H
 
 
+/// \if null
 /// \page igeslib GoTools Igeslib
 ///
 /// Basic IGES reading and writing utility.
+/// \endif
 
 #endif // _IGESLIB-DOXYMAIN_H
 

igeslib/include/GoTools/igeslib/igeslib_doxymain.h

@@ -1,3 +1,7 @@
+#ifndef _IGESLIB-DOXYMAIN_H
+#define _IGESLIB-DOXYMAIN_H
+
+
 /**
 \page igeslib GoTools Igeslib
 
@@ -30,3 +34,5 @@ convertor using the function addGeom which takes a GeomObject as parameter.
 The actual file is written by the command writeIGES.
 
 */
+
+#endif // _IGESLIB-DOXYMAIN_H

viewlib/include/GoTools/viewlib/viewlib_doxymain.h

@@ -50,6 +50,14 @@ goview is a utility and not a product. This implies unfortunately that the
 help functionality is not implemented. Visualization of trimmed surfaces can
 have some flaws, but they are normally repaired or minimized by increasing
 the resolution. 
+
+\section dependencies Dependencies
+
+Viewlib requires the following libraries to be installed on the system:
+- Qt4, <a href="http://qt.nokia.com">qt.nokia.com</a>
+- OpenGL and GLUT, <a href="http://www.opengl.org">www.opengl.org</a>
+- Boost, <a href="http://www.boost.org">www.boost.org</a>
+
 */
 
 #endif // _VIEWLIB_DOXYMAIN_H