From 4829684363d5f6a3892da8fa150de8185a9445a9 Mon Sep 17 00:00:00 2001 From: Mike Kremer Date: Tue, 2 Mar 2010 14:20:54 +0000 Subject: [PATCH] Disabled doxygen auto-referencing for OpenMesh keyword. git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@295 fdac6126-5c0c-442c-9429-916003d36597 --- Doc/misc.docu | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/Doc/misc.docu b/Doc/misc.docu index 7f6500d5..b2629bd7 100644 --- a/Doc/misc.docu +++ b/Doc/misc.docu @@ -3,7 +3,7 @@ /** \page naming_conventions Naming Conventions -The following naming conventions are used for the OpenMesh code: +The following naming conventions are used for the %OpenMesh code: Files: \li \c MyClass.cc for C++-Implementation of class \c MyClass @@ -31,7 +31,7 @@ The following naming conventions are used for the OpenMesh code: //----------------------------------------------------------------------------- -/** \page compiling Compiling OpenMesh +/** \page compiling Compiling %OpenMesh \section compilers Tested compilers @@ -76,9 +76,9 @@ Install the following external libraries / frameworks if you want to use the inc \section sec_compiling_unix Unix -\subsection linux_using_cmake Compiling OpenMesh using CMake +\subsection linux_using_cmake Compiling %OpenMesh using CMake -In order to compile OpenMesh, create a directory named e.g. "build" in +In order to compile %OpenMesh, create a directory named e.g. "build" in OpenMesh's root directory. Change to the newly created directory and type

@@ -93,7 +93,7 @@ Other flags are:
-DBUILD_APPS=OFF to disable build of applications and
-DCMAKE_INSTALL_PREFIX=<path> to specify the install path.
-When calling make install cmake will install OpenMesh into this +When calling make install cmake will install %OpenMesh into this directory using the subdirectories lib/include/bin. CMake builds both shared and static under Linux. @@ -108,30 +108,30 @@ There are some additional targets:
\section sec_compiling_windows Windows -\subsection windows_using_cmake Compiling OpenMesh using CMake +\subsection windows_using_cmake Compiling %OpenMesh using CMake If you want to use cmake to build your Visual Studio 2008 solution file,
download and install CMake from www.cmake.org.
-(Note: This is not mandatory since there are already VS2008 solution files included in OpenMesh).

+(Note: This is not mandatory since there are already VS2008 solution files included in %OpenMesh).

Install the OpenGL Extension Wrangler Library (GLEW) from http://glew.sourceforge.net.

-Note: Set the CMAKE_BUILD_TYPE variable to "Release" if you want OpenMesh to be built as release. +Note: Set the CMAKE_BUILD_TYPE variable to "Release" if you want %OpenMesh to be built as release. In Visual Studio 2008 choose "Release" in the appropriate select box and build the solution afterwards.
@@ -150,10 +150,10 @@ sudo port -v install glew to install glew headers and libraries. ( Darwin ports usually installs header files to \c /usr/local/include and libraries to \c /usr/local/lib. )

-\subsection mac_using_cmake Compiling OpenMesh using CMake +\subsection mac_using_cmake Compiling %OpenMesh using CMake If you're using cmake as preferred build system create a directory -named e.g. in OpenMesh's root directory and change to it. +named e.g. in %OpenMesh's root directory and change to it.

cmake ..            ## Generates the appropriate Makefiles