diff --git a/BaseLib/BuildInfo.h.in b/BaseLib/BuildInfo.h.in index 145411c6c79afdf91edc64b3ce9494a8acb3e082..5fd4d9e7b864f6fece74072cc188ad347611c25f 100644 --- a/BaseLib/BuildInfo.h.in +++ b/BaseLib/BuildInfo.h.in @@ -1,7 +1,14 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file BuildInfo.h.in - * 24/08/2010 LB Initial implementation - * #defines which gets set through CMake + * #defines which gets set through CMake. + * + * Created on 2010-08-24 by Lars Bilke */ #ifndef BUILDINFO_H @@ -23,5 +30,6 @@ #cmakedefine CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}" #cmakedefine CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE}" #cmakedefine CMAKE_GENERATOR "${CMAKE_GENERATOR}" +#cmakedefine HOSTNAME "${HOSTNAME}" #endif // BUILDINFO_H diff --git a/BaseLib/CPUTime.cpp b/BaseLib/CPUTime.cpp index a442b9b79e1cfa5aceb9bc4ab7656005c754a992..8f85cfc921e2cb0d7db0717af1962daccdeb0a99 100644 --- a/BaseLib/CPUTime.cpp +++ b/BaseLib/CPUTime.cpp @@ -1,8 +1,13 @@ -/* - * CPUTime.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: May 10, 2012 - * Author: TF + * + * \file CPUTime.cpp + * + * Created on 2012-05-10 by Thomas Fischer */ #include "CPUTime.h" diff --git a/BaseLib/CPUTime.h b/BaseLib/CPUTime.h index 7198c6d3ec2ac679228a0bbfefe595fa1f23a318..2a56a4c2f9217b43a4cbf64327eee7334c5b4684 100644 --- a/BaseLib/CPUTime.h +++ b/BaseLib/CPUTime.h @@ -1,8 +1,13 @@ -/* - * CPUTime.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: May 10, 2012 - * Author: TF + * + * \file CPUTime.h + * + * Created on 2012-05-10 by Thomas Fischer */ #ifndef CPUTIME_H diff --git a/BaseLib/Configure.h.in b/BaseLib/Configure.h.in index 307759a4d601d1bb95d4b22d4498d1569fed827a..9f6d3412999de462a9378e82da3ddd9df0272f6d 100644 --- a/BaseLib/Configure.h.in +++ b/BaseLib/Configure.h.in @@ -1,4 +1,10 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Configure.h.in * * #defines which gets set through CMake diff --git a/BaseLib/DateTools.cpp b/BaseLib/DateTools.cpp index c15b18ebf6c7e9a37c722e6e473e74364a15b53f..5e23c692b66545ff9b12ebfd41adb867f9969ac8 100644 --- a/BaseLib/DateTools.cpp +++ b/BaseLib/DateTools.cpp @@ -1,9 +1,13 @@ -/* - * DateTools.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 16, 2010 - * Author: KR Initial implementation (in header file) - * TF moved implementation to source file + * + * \file DateTools.cpp + * + * Created on 2010-06-16 by Karsten Rink */ #include "DateTools.h" diff --git a/BaseLib/DateTools.h b/BaseLib/DateTools.h index 1427e6ac08ca9fed3e3fc380cffff7e95625cb04..7e57eedca2110faeea655e2d8e1a747e3ae0e12b 100644 --- a/BaseLib/DateTools.h +++ b/BaseLib/DateTools.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file DateTools.h - * 22/01/2010 KR Initial implementation + * + * Created on 2010-01-22 by Karsten Rink */ #ifndef DATETOOLS_H diff --git a/BaseLib/FileFinder.h b/BaseLib/FileFinder.h index d518839e6789d457e71d42b8528fa84340319840..2da9c619b703e3175f176f8c46826653d03224b0 100644 --- a/BaseLib/FileFinder.h +++ b/BaseLib/FileFinder.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file FileFinder.h - * 26/10/2010 KR Initial implementation + * + * Created on 2010-10-26 by Karsten Rink */ #ifndef FILEFINDER_H diff --git a/BaseLib/FileTools.h b/BaseLib/FileTools.h index 0b2b428f25119e79fcb5cfdce80af076b2fe1972..471712fc86fa93997097cd0f8cdd57a01173934d 100644 --- a/BaseLib/FileTools.h +++ b/BaseLib/FileTools.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file FileTools.h - * 26/4/2010 LB Initial implementation + * + * Created on 2010-04-26 by Lars Bilke * */ diff --git a/BaseLib/MemWatch.cpp b/BaseLib/MemWatch.cpp index 7d2e6e294fc966f0e16e514281ad7f23099e641e..c36ad187b325e6036d66e02dcc87ed8d26e4abc6 100644 --- a/BaseLib/MemWatch.cpp +++ b/BaseLib/MemWatch.cpp @@ -1,8 +1,13 @@ -/* - * MemWatch.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: May 7, 2012 - * Author: TF + * + * \file MemWatch.cpp + * + * Created on 2012-05-07 by Thomas Fischer */ #include "MemWatch.h" diff --git a/BaseLib/MemWatch.h b/BaseLib/MemWatch.h index 2afa771ba80aeb18f1d90af4fd6bbaed78715286..26883d8e86280e1e1c17a138f0cf4b349b8dcb98 100644 --- a/BaseLib/MemWatch.h +++ b/BaseLib/MemWatch.h @@ -1,8 +1,13 @@ -/* - * MemWatch.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: May 7, 2012 - * Author: TF + * + * \file MemWatch.h + * + * Created on 2012-05-07 by Thomas Fischer */ #ifndef MEMWATCH_H_ diff --git a/BaseLib/RunTime.cpp b/BaseLib/RunTime.cpp index d9652790f4931792ad57b45322f981718c6f22bb..9038c7e5a0991f318c1e2ed4ddb48586e0b630bf 100644 --- a/BaseLib/RunTime.cpp +++ b/BaseLib/RunTime.cpp @@ -1,8 +1,13 @@ -/* - * RunTime.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: May 10, 2012 - * Author: TF + * + * \file RunTime.cpp + * + * Created on 2012-05-10 by Thomas Fischer */ #include "RunTime.h" diff --git a/BaseLib/RunTime.h b/BaseLib/RunTime.h index 8d282958829256a003e59603e90c977224eaa7ba..88a1647fc417dc6acea5488f19ae035287b54878 100644 --- a/BaseLib/RunTime.h +++ b/BaseLib/RunTime.h @@ -1,8 +1,13 @@ -/* - * RunTime.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: May 10, 2012 - * Author: TF + * + * \file RunTime.h + * + * Created on 2012-05-10 by Thomas Fischer */ #ifndef RUNTIME_H diff --git a/BaseLib/StringTools.cpp b/BaseLib/StringTools.cpp index 01fffcf4acc9a9817bab8918a1db808227e7694b..c8f192e01fb41433c5001ba419025f9cd61b87dc 100644 --- a/BaseLib/StringTools.cpp +++ b/BaseLib/StringTools.cpp @@ -1,8 +1,13 @@ -/* - * StringTools.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 16, 2010 - * Author: TF + * + * \file StringTools.cpp + * + * Created on 2010-06-16 by Thomas Fischer */ #include "StringTools.h" diff --git a/BaseLib/binarySearch.cpp b/BaseLib/binarySearch.cpp index fe924fa339a289485a3fabb6b99f9648d1027632..7a6f0ee81588011b744b90404e1f3360f4ec4253 100644 --- a/BaseLib/binarySearch.cpp +++ b/BaseLib/binarySearch.cpp @@ -1,8 +1,14 @@ -/* - * binarySearch.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file binarySearch.cpp + * + * Created on 2010-09-07 by Thomas Fischer * - * Created on: Sep 7, 2010 - * Author: TF */ #include "binarySearch.h" diff --git a/BaseLib/binarySearch.h b/BaseLib/binarySearch.h index 039244f3e89ecfe88861bf57864a94ab99aa5b74..2e8ddfda8b17ea2b080b8903167e8749a0a51b33 100644 --- a/BaseLib/binarySearch.h +++ b/BaseLib/binarySearch.h @@ -1,8 +1,14 @@ -/* - * binarySearch.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file binarySearch.h + * + * Created on 2010-06-07 by Thomas Fischer * - * Created on: Jun 7, 2010 - * Author: TF */ // STL diff --git a/BaseLib/printList.h b/BaseLib/printList.h index 7a4a4bb16f9336ffe35e388d5fe90bf8df098dad..f12338385855ccccea7be8658c6ec76709a94125 100644 --- a/BaseLib/printList.h +++ b/BaseLib/printList.h @@ -1,8 +1,13 @@ -/* - * printList.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Feb 23, 2011 - * Author: TF + * + * \file printList.h + * + * Created on 2011-02-23 by Thomas Fischer */ #ifndef PRINTLIST_H_ diff --git a/BaseLib/quicksort.h b/BaseLib/quicksort.h index 411d9aed1dad8580c30d098a151ea69b7fc4cabb..6e1b1dbedb49aa1327b78d0ffe8f4e6f870c84e0 100644 --- a/BaseLib/quicksort.h +++ b/BaseLib/quicksort.h @@ -1,8 +1,13 @@ -/* - * quicksort.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file quicksort.h * - * Created on: May 26, 2010 - * Author: TF + * Created on 2010-05-26 by Thomas Fischer */ #ifndef QUICKSORT_H_ diff --git a/BaseLib/uniqueListInsert.h b/BaseLib/uniqueListInsert.h index 38804f59dc72e8c395de923ae8dcd52aaa420234..711dd4726bb24481b2e33add747cae16996f4daa 100644 --- a/BaseLib/uniqueListInsert.h +++ b/BaseLib/uniqueListInsert.h @@ -1,8 +1,13 @@ -/* - * uniqueListInsert.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Feb 23, 2011 - * Author: TF + * + * \file uniqueListInsert.h + * + * Created on 2011-02-23 by Thomas Fischer */ #ifndef UNIQUELISTINSERT_H_ diff --git a/BaseLib/wait.h b/BaseLib/wait.h index c56de0311396508c69f0904ec886bd00fd562325..a24db3f265c1f0c078b465e3c6c9a88ef2c2725b 100644 --- a/BaseLib/wait.h +++ b/BaseLib/wait.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file DateTools.h - * 2011/02/17 KR Initial implementation + * + * Created on 2011-02-17 by Karsten Rink */ diff --git a/FemLib/DistributionInfo.cpp b/FemLib/DistributionInfo.cpp index df94f24793ebbf3749e661723cdf30c473495e06..022489df62c1b0aec4ef5f733a5c7165f33d427b 100644 --- a/FemLib/DistributionInfo.cpp +++ b/FemLib/DistributionInfo.cpp @@ -1,8 +1,13 @@ -/* - * DistributionInfo.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 28, 2010 - * Author: fischeth + * + * \file DistributionInfo.cpp + * + * Created on 2010-09-28 by Thomas Fischer */ #include "DistributionInfo.h" diff --git a/FemLib/DistributionInfo.h b/FemLib/DistributionInfo.h index 0d8bd9b78b40c8e418b6ea66e748ee40bf49c450..7a48bd0fcf76f3704a98f7c747a28a238b72da22 100644 --- a/FemLib/DistributionInfo.h +++ b/FemLib/DistributionInfo.h @@ -1,8 +1,13 @@ -/* - * DistributionInfo.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 28, 2010 - * Author: TF + * + * \file DistributionInfo.h + * + * Created on 2010-09-28 by Thomas Fischer */ #ifndef DISTRIBUTIONINFO_H_ diff --git a/FemLib/FEMCondition.cpp b/FemLib/FEMCondition.cpp index 5f5ec2a1f4169d91e17d30d381c3b7b9242fc747..6142eedabbfd0433260986043cedacecbf29bcfa 100644 --- a/FemLib/FEMCondition.cpp +++ b/FemLib/FEMCondition.cpp @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file FEMCondition.cpp - * 25/11/2010 KR inital implementation + * + * Created on 2010-11-25 by Karsten Rink * */ diff --git a/FemLib/FEMCondition.h b/FemLib/FEMCondition.h index b16d21044c7fdc300557eee0cfbf8b2469f737c6..db2a8c2c05cabd3f52c58da5e10598ced14d0d3f 100644 --- a/FemLib/FEMCondition.h +++ b/FemLib/FEMCondition.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file FEMCondition.h - * 25/11/2010 KR inital implementation + * + * Created on 2010-11-25 by Karsten Rink * */ @@ -77,7 +84,7 @@ public: /// The first value specifies the point id, the second the value for that point. void setDisValues(const std::vector< std::pair<size_t, double> > &dis_values); - /// Removes all distribution values + /// Removes all distribution values void clearDisValues() { _disValues.resize(0); }; /// Sets the name of the geo-object the condition is assigned to. diff --git a/FemLib/FEMEnums.cpp b/FemLib/FEMEnums.cpp index 04abcbc1687523b14faee240341e825be9ca5f9c..4cee24ab12d1653c352eed371760d34b71de6b33 100644 --- a/FemLib/FEMEnums.cpp +++ b/FemLib/FEMEnums.cpp @@ -1,8 +1,13 @@ -/* - * FEMEnums.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 2, 2010 - * Author: TF + * + * \file FEMEnums.cpp + * + * Created on 2010-09-02 by Thomas Fischer */ #include "FEMEnums.h" @@ -106,11 +111,11 @@ std::string convertProcessTypeToString ( ProcessType pcs_type ) bool isFlowProcess (ProcessType pcs_type) { - if ( pcs_type == LIQUID_FLOW || pcs_type == FLUID_FLOW + if ( pcs_type == LIQUID_FLOW || pcs_type == FLUID_FLOW || pcs_type == RICHARDS_FLOW || pcs_type == GROUNDWATER_FLOW || pcs_type == PS_GLOBAL || pcs_type == MULTI_PHASE_FLOW || pcs_type == DEFORMATION_FLOW || pcs_type == DEFORMATION_H2 - || pcs_type == TWO_PHASE_FLOW || pcs_type == OVERLAND_FLOW + || pcs_type == TWO_PHASE_FLOW || pcs_type == OVERLAND_FLOW || pcs_type == AIR_FLOW || pcs_type == PTC_FLOW) return true; return false; @@ -118,7 +123,7 @@ bool isFlowProcess (ProcessType pcs_type) bool isMultiFlowProcess (ProcessType pcs_type) { - if (pcs_type == PS_GLOBAL || + if (pcs_type == PS_GLOBAL || pcs_type == MULTI_PHASE_FLOW || pcs_type == TWO_PHASE_FLOW || pcs_type == DEFORMATION_H2) diff --git a/FemLib/FEMEnums.h b/FemLib/FEMEnums.h index 805eae4fedc0462fe40d1dfe4bb29edc9e143991..6a4101553ad62f7326e74a6df0a92a8340bb790c 100644 --- a/FemLib/FEMEnums.h +++ b/FemLib/FEMEnums.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file FEMEnums.h - * 31/08/2010 KR inital implementation + * + * Created on 2010-08-31 by Karsten Rink * */ @@ -205,7 +212,7 @@ const std::list<std::string> getAllDistributionNames(); /** \brief Types of error method supported by OpenGeoSys. * If you change this enum, make sure you apply the changes to * the functions convertErrorMethod(), convertErrorMethodToString() - Non-Linear and Coupling options (see also CRFProcess::CalcIterationNODError()): + Non-Linear and Coupling options (see also CRFProcess::CalcIterationNODError()): --> LMAX: max(|x1-x0|) -- Infinity norm: Local max error (across all elements) of solution vector delta (absolute error). Tolerance required for each primary variable. --> ENORM: |x1-x0| -- Euclidian norm: Norm of the solution vector delta (absolute error). Norm taken over entire solution vector (all primary variables) and checked against a single tolerance. --> EVNORM: |x1-x0| -- Euclidian varient norm: Norm of the solution vector delta (absolute error). Norm taken over solution vector of each primary variable, checked againes a tolerence specific to each variable. @@ -214,10 +221,10 @@ const std::list<std::string> getAllDistributionNames(); */ enum ErrorMethod { - INVALID_ERROR_METHOD = 0, + INVALID_ERROR_METHOD = 0, LMAX, - ENORM, - EVNORM, + ENORM, + EVNORM, ERNORM, BNORM }; diff --git a/FemLib/GeoInfo.cpp b/FemLib/GeoInfo.cpp index 2bb451eeb9c4d0fcd655602ff3304dc6f742c9d8..93fe3127433fbf5d713dbe278c0fd1ac052cdcf6 100644 --- a/FemLib/GeoInfo.cpp +++ b/FemLib/GeoInfo.cpp @@ -1,8 +1,13 @@ -/* - * GeoInfo.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 18, 2010 - * Author: TF + * + * \file GeoInfo.cpp + * + * Created on 2010-06-18 by Thomas Fischer */ // STL diff --git a/FemLib/GeoInfo.h b/FemLib/GeoInfo.h index 8cb4d2995afc9f485bc12a36bf629bf5587ca51f..e7ebac20926f26b82daaf506d31918aee728a835 100644 --- a/FemLib/GeoInfo.h +++ b/FemLib/GeoInfo.h @@ -1,8 +1,13 @@ -/* - * GeoInfo.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file GeoInfo.h * - * Created on: Jun 18, 2010 - * Author: TF + * Created on 2010-06-18 by Thomas Fischer */ #ifndef GEOINFO_H_ diff --git a/FemLib/ProcessInfo.cpp b/FemLib/ProcessInfo.cpp index a8273da8077f0b71c97aa3f030c5a3da1ee47c00..542bcf79683374fc7530b2df608a350d399afd60 100644 --- a/FemLib/ProcessInfo.cpp +++ b/FemLib/ProcessInfo.cpp @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file ProcessInfo.cpp * - * Created on: Sep 2, 2010 - * Author: TF + * Created on 2010-09-02 by Thomas Fischer */ //#include "rf_pcs.h" diff --git a/FemLib/ProcessInfo.h b/FemLib/ProcessInfo.h index 891129dcc0afa172822dde6cd6397808b42eb6a4..2569fa13e4d597aede75e9996d6701700c05bfc9 100644 --- a/FemLib/ProcessInfo.h +++ b/FemLib/ProcessInfo.h @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file ProcessInfo.h * - * Created on: Sep 2, 2010 - * Author: TF + * Created on 2010-09-02 by Thomas Fischer */ #ifndef PROCESSINFO_H_ diff --git a/FileIO/MeshIO.cpp b/FileIO/MeshIO.cpp index b01edcf9c0eee08fcecb23b55568086450089228..f2512dce2b38e73627079e0afa563a10ee443a91 100644 --- a/FileIO/MeshIO.cpp +++ b/FileIO/MeshIO.cpp @@ -1,8 +1,13 @@ /** - * MeshIO.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/08 - * Author: KR + * + * \file MeshIO.cpp + * + * Created on 2012-05-08 by Karsten Rink */ #include "GEOObjects.h" @@ -103,7 +108,7 @@ MeshLib::Mesh* MeshIO::loadMeshFromFile(const std::string& file_name) in.close(); return mesh; } - else + else { in.close(); return NULL; @@ -121,7 +126,7 @@ MeshLib::Element* MeshIO::readElement(const std::string& line, const std::vector unsigned* idx = new unsigned[8]; MeshLib::Element* elem; - + switch(elem_type) { case MshElemType::LINE: @@ -161,8 +166,8 @@ MeshLib::Element* MeshIO::readElement(const std::string& line, const std::vector break; default: elem = NULL; - } - + } + return elem; } diff --git a/FileIO/MeshIO.h b/FileIO/MeshIO.h index 1c58b75ad0b58f8a245cd412e4e40577eb008e57..d190ac8bb72d17bf8ec21a66d3205c8fd0b42f90 100644 --- a/FileIO/MeshIO.h +++ b/FileIO/MeshIO.h @@ -1,8 +1,13 @@ /** - * MeshIO.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/08 - * Author: KR + * + * \file MeshIO.h + * + * Created on 2012-05-08 by Karsten Rink */ /** diff --git a/FileIO/Writer.cpp b/FileIO/Writer.cpp index 06f6c8f1429fe9f0c5ada3ec89d06a9a86229b69..85cd3a33debacdcbe3f1e6293df4ccbf8bf28c63 100644 --- a/FileIO/Writer.cpp +++ b/FileIO/Writer.cpp @@ -1,8 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Writer.cpp - * 13/02/2012 LB Initial implementation * - * Implementation of the Writer class + * Created on 2012-02-13 by Lars Bilke */ // ** INCLUDES ** diff --git a/FileIO/Writer.h b/FileIO/Writer.h index f02dec1591fc9af7fabb3c967898f2bd14c770e5..a8b0375f7c84408f4594e27121a663198a690387 100644 --- a/FileIO/Writer.h +++ b/FileIO/Writer.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Writer.h - * 13/02/2012 LB Initial implementation + * + * Created on 2012-02-13 by Lars Bilke */ #ifndef WRITER_H diff --git a/FileIO/XmlIO/XMLInterface.cpp b/FileIO/XmlIO/XMLInterface.cpp index 0518da99a8e7bbd8711537bb6e0ec531cc8923c3..7a25653abb2db4d8127ca503b09cf931e52d79e8 100644 --- a/FileIO/XmlIO/XMLInterface.cpp +++ b/FileIO/XmlIO/XMLInterface.cpp @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XMLInterface.cpp - * 18/02/2010 KR Initial implementation + * + * Created on 2010-18-02 by Karsten Rink */ #include "ProjectData.h" diff --git a/FileIO/XmlIO/XMLInterface.h b/FileIO/XmlIO/XMLInterface.h index 09dc9082839e55b4b971c691f6b4fe1948ec992b..1875223a37113236f554df14fad71f1833fd4183 100644 --- a/FileIO/XmlIO/XMLInterface.h +++ b/FileIO/XmlIO/XMLInterface.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XMLInterface.h - * 18/02/2010 KR Initial implementation + * + * Created on 2010-02-18 by Karsten Rink */ #ifndef XMLINTERFACE_H diff --git a/FileIO/XmlIO/XmlCndInterface.cpp b/FileIO/XmlIO/XmlCndInterface.cpp index 1eeb989aec0573f5bc06c060e7594f1b2c7de6ca..a0434d0aa5ca506baae02b80414f3abfabaf613f 100644 --- a/FileIO/XmlIO/XmlCndInterface.cpp +++ b/FileIO/XmlIO/XmlCndInterface.cpp @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XmlCndInterface.cpp - * 2011/11/23 KR as derived class from XMLInterface + * + * Created on 2011-11-23 by Karsten Rink */ #include "XmlCndInterface.h" @@ -124,10 +131,10 @@ void XmlCndInterface::readConditions( const QDomNode &listRoot, { std::vector<size_t> disNodes; std::vector<double> disValues; - if (c->getProcessDistributionType()==FiniteElement::CONSTANT || + if (c->getProcessDistributionType()==FiniteElement::CONSTANT || c->getProcessDistributionType()==FiniteElement::CONSTANT_NEUMANN) disValues.push_back( strtod(distProps.at(j).toElement().text().toStdString().c_str(), 0) ); - else if (c->getProcessDistributionType()==FiniteElement::LINEAR || + else if (c->getProcessDistributionType()==FiniteElement::LINEAR || c->getProcessDistributionType()==FiniteElement::LINEAR_NEUMANN || c->getProcessDistributionType()==FiniteElement::DIRECT) { diff --git a/FileIO/XmlIO/XmlCndInterface.h b/FileIO/XmlIO/XmlCndInterface.h index 005539e0e1adaf7a4b27da3ccdcff45d052568fc..be7a8a3a51dcce9632d91dad165f4164c7fea1c6 100644 --- a/FileIO/XmlIO/XmlCndInterface.h +++ b/FileIO/XmlIO/XmlCndInterface.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XmlCndInterface.h - * 2011/11/23 KR as derived class from XMLInterface + * + * Created on 2011-11-23 by Karsten Rink */ #ifndef XMLCNDINTERFACE_H @@ -40,7 +47,7 @@ public: int readFile(std::vector<FEMCondition*> &conditions, const QString &fileName); void setConditionType(FEMCondition::CondType type) { _type = type; }; - + protected: int write(std::ostream& stream); diff --git a/FileIO/XmlIO/XmlGmlInterface.cpp b/FileIO/XmlIO/XmlGmlInterface.cpp index 929135dd8b5eb3918b8f1118589c70fba986a78f..1a93fc0690c217e7d934715091101d13c03e62a9 100644 --- a/FileIO/XmlIO/XmlGmlInterface.cpp +++ b/FileIO/XmlIO/XmlGmlInterface.cpp @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XmlGmlInterface.cpp - * 2011/11/23 KR as derived class from XMLInterface + * + * Created on 2011-11-23 by Karsten Rink */ #include "XmlGmlInterface.h" diff --git a/FileIO/XmlIO/XmlGmlInterface.h b/FileIO/XmlIO/XmlGmlInterface.h index 2fb9b3318a81b360637d69160cd1818d4327bea3..a022c37ff4ad3bc1b296658467dda52a5150cd03 100644 --- a/FileIO/XmlIO/XmlGmlInterface.h +++ b/FileIO/XmlIO/XmlGmlInterface.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XmlGmlInterface.h - * 2011/11/23 KR as derived class from XMLInterface + * + * Created on 2011-11-23 by Karsten Rink */ #ifndef XMLGMLINTERFACE_H diff --git a/FileIO/XmlIO/XmlGspInterface.cpp b/FileIO/XmlIO/XmlGspInterface.cpp index 0b976a961cd0b715bb6d0375d9c0491d20e323b8..84582fbb9349f9e130bd2c8883cf855a2faafd51 100644 --- a/FileIO/XmlIO/XmlGspInterface.cpp +++ b/FileIO/XmlIO/XmlGspInterface.cpp @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XmlGspInterface.cpp - * 2011/11/23 KR as derived class from XMLInterface + * + * Created on 2011-11-23 by Karsten Rink */ #include "XmlGspInterface.h" @@ -67,7 +74,7 @@ int XmlGspInterface::readFile(const QString &fileName) for(int j = 0; j < childList.count(); j++) { const QDomNode child_node (childList.at(j)); - if (child_node.nodeName().compare("file") == 0) + if (child_node.nodeName().compare("file") == 0) { std::cout << "path: " << path.toStdString() << "#" << std::endl; std::cout << "file name: " << (child_node.toElement().text()).toStdString() << "#" << std::endl; diff --git a/FileIO/XmlIO/XmlGspInterface.h b/FileIO/XmlIO/XmlGspInterface.h index 1524941655d728139fff08a6886fe9e15d6efab6..247380574489b4ccda80507d692bcdf66fb19372 100644 --- a/FileIO/XmlIO/XmlGspInterface.h +++ b/FileIO/XmlIO/XmlGspInterface.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XmlGspInterface.h - * 2011/11/23 KR as derived class from XMLInterface + * + * Created on 2011-11-23 by Karsten Rink */ #ifndef XMLGSPINTERFACE_H @@ -29,7 +36,7 @@ public: /// Reads an xml-file containing a GeoSys project. /// Project files currently cover only geo-, msh- and station-data. This will be expanded in the future. int readFile(const QString &fileName); - + int writeToFile(std::string filename); protected: diff --git a/FileIO/XmlIO/XmlLutReader.h b/FileIO/XmlIO/XmlLutReader.h index f46de52116a31723f4428ead8a826e20762a8123..3fb8a74bfdec988ee44e830eeca25acc4393a1c8 100644 --- a/FileIO/XmlIO/XmlLutReader.h +++ b/FileIO/XmlIO/XmlLutReader.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XmlLutReader.h - * 2011/01/30 KR Initial implementation + * + * Created on 2011-01-30 by Karsten Rink */ #ifndef XMLLUTREADER_H @@ -47,7 +54,7 @@ public: lut->setInterpolationType(VtkColorLookupTable::LINEAR); else if (docElement.attribute("interpolation").compare("Exponential") == 0) lut->setInterpolationType(VtkColorLookupTable::EXPONENTIAL); - else + else lut->setInterpolationType(VtkColorLookupTable::NONE); } else // default @@ -58,10 +65,10 @@ public: while (!point.isNull()) { - if ((point.nodeName().compare("Point") == 0 ) + if ((point.nodeName().compare("Point") == 0 ) && point.hasAttribute("x") - && point.hasAttribute("r") - && point.hasAttribute("g") + && point.hasAttribute("r") + && point.hasAttribute("g") && point.hasAttribute("b")) { double value = strtod((point.attribute("x")).toStdString().c_str(),0); diff --git a/FileIO/XmlIO/XmlStnInterface.cpp b/FileIO/XmlIO/XmlStnInterface.cpp index a2e4f1f9f8f687c427ec2226af90aa86ebf5ce53..39482f4c7a5955821d25be26926ca43e71c2f079 100644 --- a/FileIO/XmlIO/XmlStnInterface.cpp +++ b/FileIO/XmlIO/XmlStnInterface.cpp @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XmlStnInterface.cpp - * 2011/11/23 KR as derived class from XMLInterface + * + * Created on 2011-11-23 by Karsten Rink */ #include "XmlStnInterface.h" @@ -118,7 +125,7 @@ void XmlStnInterface::readStations( const QDomNode &stationsRoot, new GeoLib::Station( strtod((station.attribute("x")).toStdString().c_str(), 0), strtod((station.attribute("y")).toStdString().c_str(), 0), - zVal, + zVal, stationName); s->setStationValue(stationValue); stations->push_back(s); @@ -177,7 +184,7 @@ void XmlStnInterface::readStratigraphy( const QDomNode &stratRoot, GeoLib::Stati depth_check = depth; } else - std::cout << "Warning: Skipped layer \"" << horizonName << "\" in borehole \"" + std::cout << "Warning: Skipped layer \"" << horizonName << "\" in borehole \"" << borehole->getName() << "\" because of thickness 0.0." << std::endl; } else diff --git a/FileIO/XmlIO/XmlStnInterface.h b/FileIO/XmlIO/XmlStnInterface.h index 9126709982377b00020a44ddb6059effcaf0968b..b7e82ee5324ab722fdc76a0bc8eae3f3f7f764cc 100644 --- a/FileIO/XmlIO/XmlStnInterface.h +++ b/FileIO/XmlIO/XmlStnInterface.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file XmlStnInterface.h - * 2011/11/23 KR as derived class from XMLInterface + * + * Created on 2011-11-23 by Karsten Rink */ #ifndef XMLSTNINTERFACE_H diff --git a/GeoLib/AxisAlignedBoundingBox.cpp b/GeoLib/AxisAlignedBoundingBox.cpp index 7e42d1464b19ea1375f1cee57d4be1defca338f4..eaa34b59e68132ed8d8823e3677e2eb193c9e253 100644 --- a/GeoLib/AxisAlignedBoundingBox.cpp +++ b/GeoLib/AxisAlignedBoundingBox.cpp @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file AxisAlignedBoundingBox.cpp * - * Created on: April 22, 2010 - * Author: TF + * Created on 2010-04-22 by Thomas Fischer */ #include "AxisAlignedBoundingBox.h" diff --git a/GeoLib/AxisAlignedBoundingBox.h b/GeoLib/AxisAlignedBoundingBox.h index 844895fc0c20c1ba0481efcbcf1d9664d790dcec..d0ee1e8930b1db6500d05c2a68e1b0e8a6db00cd 100644 --- a/GeoLib/AxisAlignedBoundingBox.h +++ b/GeoLib/AxisAlignedBoundingBox.h @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file AxisAlignedBoundingBox.h * - * Created on: April 22, 2010 - * Author: TF + * Created on 2010-04-22 by Thomas Fischer */ #ifndef AXISALIGNEDBOUNDINGBOX_H_ diff --git a/GeoLib/BruteForceClosestPair.cpp b/GeoLib/BruteForceClosestPair.cpp index 73d46d105ed29da53935b782c36351ff08f1dfc4..13b93d8e64051c9dd3eed546fa14f684d586d463 100644 --- a/GeoLib/BruteForceClosestPair.cpp +++ b/GeoLib/BruteForceClosestPair.cpp @@ -1,8 +1,13 @@ -/* - * BruteForceClosestPair.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 25, 2011 - * Author: TF + * + * \file BruteForceClosestPair.cpp + * + * Created on 2011-01-25 by Thomas Fischer */ #include "BruteForceClosestPair.h" diff --git a/GeoLib/BruteForceClosestPair.h b/GeoLib/BruteForceClosestPair.h index 9682da6a30be6ecc65d948e2e57b5d51031b76b8..347daa9249c40552e68a8c54a4b043d1a4b95c11 100644 --- a/GeoLib/BruteForceClosestPair.h +++ b/GeoLib/BruteForceClosestPair.h @@ -1,8 +1,13 @@ -/* - * BruteForceClosestPair.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 25, 2011 - * Author: TF + * + * \file BruteForceClosestPair.h + * + * Created on 2011-01-25 by Thomas Fischer */ #ifndef BRUTEFORCECLOSESTPAIR_H_ diff --git a/GeoLib/ClosestPair.h b/GeoLib/ClosestPair.h index b8d7e822ccb17086d6281dce1f7bdc65891096f0..635347e405ab173c42427023c4b0cfd94c01117f 100644 --- a/GeoLib/ClosestPair.h +++ b/GeoLib/ClosestPair.h @@ -1,8 +1,13 @@ -/* - * ClosestPair.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 25, 2011 - * Author: TF + * + * \file ClosestPair.h + * + * Created on 2011-01-25 by Thomas Fischer */ #ifndef CLOSESTPAIR_H_ diff --git a/GeoLib/Color.cpp b/GeoLib/Color.cpp index 0387f08c2828ed414ef8f41fb92f61d3797fd289..9849bacf4de591bc75cfdf3d5f2be77583c7b9c7 100644 --- a/GeoLib/Color.cpp +++ b/GeoLib/Color.cpp @@ -1,9 +1,13 @@ -/* - * Color.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 16, 2010 - * Author: KR initial implementation in header - * TF moved implementation to separate source file + * + * \file Color.cpp + * + * Created on 2010-06-16 by Karsten Rink */ #include <iostream> diff --git a/GeoLib/Color.h b/GeoLib/Color.h index 3ac1419fc64f265cea377bb24828bb50211d5175..678636bfe0e0c95bb8e8fa3d150d5142934f16a3 100644 --- a/GeoLib/Color.h +++ b/GeoLib/Color.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Color.cpp - * 04/02/2010 KR Initial implementation + * + * Created on 2010-02-04 by Karsten Rink * */ diff --git a/GeoLib/GEOObjects.cpp b/GeoLib/GEOObjects.cpp index aa0aee8df3c36567a3967f558b4cc8908714b98d..77e86018bc7ddd690819b366df199a943194c9f5 100644 --- a/GeoLib/GEOObjects.cpp +++ b/GeoLib/GEOObjects.cpp @@ -1,8 +1,13 @@ -/* - * GEOObjects.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file GEOObjects.cpp * - * Created on: Jan 21, 2010 - * Author: TF / KR + * Created on 2010-01-21 by Thomas Fischer / Karsten Rink */ // GeoLib diff --git a/GeoLib/GEOObjects.h b/GeoLib/GEOObjects.h index 5525432c2503b1b464ab43d6f4f7341696320a07..7e515c119a454f92acd53b6a7fe80feee176195a 100644 --- a/GeoLib/GEOObjects.h +++ b/GeoLib/GEOObjects.h @@ -1,8 +1,13 @@ -/* - * GEOObjects.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file GEOObjects.h * - * Created on: Jan 21, 2010 - * Author: TF / KR + * Created on 2010-01-21 by Thomas Fischer / Karsten Rink */ #ifndef GEOOBJECTS_H_ diff --git a/GeoLib/GeoObject.h b/GeoLib/GeoObject.h index bacb696fd90c1a13c47a5734e9d25878da9bbf6d..1f9d6d3ddecbbc4c794d04741d1dadc73a8423d0 100644 --- a/GeoLib/GeoObject.h +++ b/GeoLib/GeoObject.h @@ -1,8 +1,13 @@ -/* - * GeoObject.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file GeoObject.h * - * Created on: Aug 27, 2010 - * Author: TF + * Created on 2010-08-27 by Thomas Fischer */ #ifndef GEOOBJECT_H_ diff --git a/GeoLib/GeoType.cpp b/GeoLib/GeoType.cpp index 4e06f10741a665aae54781ba1b8d760bdca6848e..c74a2feebc444b988dd3f8a087890dd1e65d77ad 100644 --- a/GeoLib/GeoType.cpp +++ b/GeoLib/GeoType.cpp @@ -1,8 +1,13 @@ -/* - * GeoType.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Dec 1, 2010 - * Author: TF + * + * \file GeoType.cpp + * + * Created on 2010-12-01 by Thomas Fischer */ #include "GeoType.h" diff --git a/GeoLib/GeoType.h b/GeoLib/GeoType.h index cd39a0bb8d0c559d8a373db3d42e4a64a18bb0c3..f584ee21c096503519b147c10f6fadebfa5271ab 100644 --- a/GeoLib/GeoType.h +++ b/GeoLib/GeoType.h @@ -1,8 +1,13 @@ -/* - * GeoType.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file GeoType.h * - * Created on: Jun 17, 2010 - * Author: TF + * Created on 2010-06-17 by Thomas Fischer */ #ifndef GEOTYPE_H_ @@ -23,7 +28,7 @@ enum GEOTYPE { SURFACE, //!< SURFACE VOLUME, //!< VOLUME GEODOMAIN, //!< GEODOMAIN - COLUMN //!< COLUMN. //WW/JOD + COLUMN //!< COLUMN. //WW/JOD }; GEOTYPE convertGeoType (const std::string& geo_type_str); diff --git a/GeoLib/Grid.h b/GeoLib/Grid.h index 2d35e7852eb8898f893748d5cbe9c258f5b80b9d..c7cf071d14cd96d5b79dc2257560b266014e67ef 100644 --- a/GeoLib/Grid.h +++ b/GeoLib/Grid.h @@ -1,8 +1,13 @@ -/* - * Grid.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Feb 2, 2012 - * Author: TF + * + * \file Grid.h + * + * Created on 2012-02-02 by Thomas Fischer */ #ifndef GRID_H_ diff --git a/GeoLib/OctTree.h b/GeoLib/OctTree.h index 31b43a184a43dffb12af11928b4fc7b5055d52bd..4ad432b5b6be277d66c54ef0fd2e8adec29ff0a9 100644 --- a/GeoLib/OctTree.h +++ b/GeoLib/OctTree.h @@ -1,8 +1,13 @@ -/* - * @file OctTree.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Feb 27, 2012 - * Author: TF + * + * \file OctTree.h + * + * Created on 2012-02-27 by Thomas Fischer */ #ifndef OCTTREE_H_ diff --git a/GeoLib/Point.cpp b/GeoLib/Point.cpp index f6796bf8550c0c17c98978750c9a0599a1053594..bb5234266131730dda0c0609adca91bb7516b99b 100644 --- a/GeoLib/Point.cpp +++ b/GeoLib/Point.cpp @@ -1,8 +1,13 @@ -/* - * Point.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 22, 2010 - * Author: TF + * + * \file Point.cpp + * + * Created on 2010-06-22 by Thomas Fischer */ diff --git a/GeoLib/Point.h b/GeoLib/Point.h index 10b66d7d4e0be1966b7b3f7b38cb1b2bdc0b9e1b..688688cfea7e6a67c09292de1264759dadc48da7 100644 --- a/GeoLib/Point.h +++ b/GeoLib/Point.h @@ -1,8 +1,14 @@ -/*************************************************************************** - * Point.h - * Created on: Jan 12, 2010 - * Author: TF -**************************************************************************/ +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file Point.h + * + * Created on 2010-01-12 by Thomas Fischer + */ #ifndef POINT_H_ #define POINT_H_ diff --git a/GeoLib/PointVec.cpp b/GeoLib/PointVec.cpp index 143c107bb1e15a0144694835ce670adf11fb9373..ea0b6dbd3a44fdb317e44828144b3456a37e4168 100644 --- a/GeoLib/PointVec.cpp +++ b/GeoLib/PointVec.cpp @@ -1,8 +1,13 @@ -/* - * PointVec.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 11, 2010 - * Author: TF + * + * \file PointVec.cpp + * + * Created on 2010-06-11 by Thomas Fischer */ // GeoLib diff --git a/GeoLib/PointVec.h b/GeoLib/PointVec.h index 4d6c47f51e9056ed406c561264b667597003ff37..49a2fb17a8443934f2e0f1e57a62f1f493b26f86 100644 --- a/GeoLib/PointVec.h +++ b/GeoLib/PointVec.h @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file PointVec.h * - * Created on: Feb 2, 2010 - * Author: TF / KR + * Created on 2010-02-02 by Thomas Fischer / Karsten Rink */ // GeoLib diff --git a/GeoLib/PointWithID.h b/GeoLib/PointWithID.h index e0a0fd085454b4158e5493cf82f527c12fa2004f..152fdf374937e803a46f746a35f145c5593f0d8d 100644 --- a/GeoLib/PointWithID.h +++ b/GeoLib/PointWithID.h @@ -1,8 +1,13 @@ -/* - * PointWithID.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file PointWithID.h * - * Created on: Jan 25, 2011 - * Author: TF + * Created on 2011-01-25 by Thomas Fischer */ #ifndef POINTWITHID_H_ diff --git a/GeoLib/Polygon.cpp b/GeoLib/Polygon.cpp index d55def1ceadbae269d821148ff292823b0c1e91e..52af10b251191545c51b0d032d924d70bd86345c 100644 --- a/GeoLib/Polygon.cpp +++ b/GeoLib/Polygon.cpp @@ -1,8 +1,13 @@ -/* - * Polygon.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 21, 2010 - * Author: TF + * + * \file Polygon.cpp + * + * Created on 2010-06-21 by Thomas Fischer */ #include <cstdlib> // for exit diff --git a/GeoLib/Polygon.h b/GeoLib/Polygon.h index 7c01a4c06ddb65179aad4330150302dad5980b61..5a6ff1ff3bef714ad033ee9f0512fdf5e3f7b83e 100644 --- a/GeoLib/Polygon.h +++ b/GeoLib/Polygon.h @@ -1,8 +1,13 @@ -/* - * Polygon.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file Polygon.h * - * Created on: Jun 21, 2010 - * Author: TF + * Created on 2010-06-21 by Thomas Fischer */ #ifndef POLYGON_H_ diff --git a/GeoLib/Polyline.cpp b/GeoLib/Polyline.cpp index 5b4e3dda14b1699ee40ca368eb6306cf1d799827..f717929b1115a7d1ad63dfee0f7c407892726175 100644 --- a/GeoLib/Polyline.cpp +++ b/GeoLib/Polyline.cpp @@ -1,8 +1,13 @@ -/* - * Polyline.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 21, 2010 - * Author: TF + * + * \file Polyline.cpp + * + * Created on 2010-06-21 by Thomas Fischer */ // Base diff --git a/GeoLib/Polyline.h b/GeoLib/Polyline.h index 2cfdeefeb1dacc3fa2ceac7aaa7f3de5292a3a8e..dc20d8593b0a621a341ef74a3e4c34821c4b21ed 100644 --- a/GeoLib/Polyline.h +++ b/GeoLib/Polyline.h @@ -1,8 +1,13 @@ -/* - * PolyLine.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file PolyLine.h * - * Created on: Jan 14, 2010 - * Author: TF + * Created on 2010-01-14 by Thomas Fischer */ #ifndef POLYLINE_H_ diff --git a/GeoLib/PolylineVec.h b/GeoLib/PolylineVec.h index 23ad584a3e9eee566af1e969d37509d3bfb31fed..be3188bdaf01907409507af8acf33cee2cee8067 100644 --- a/GeoLib/PolylineVec.h +++ b/GeoLib/PolylineVec.h @@ -1,8 +1,13 @@ -/* - * PolylineVec.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file PolylineVec.h * - * Created on: Feb 9, 2010 - * Author: TF + * Created on 2010-02-09 by Thomas Fischer */ #ifndef POLYLINEVEC_H_ diff --git a/GeoLib/PropertyBounds.h b/GeoLib/PropertyBounds.h index 9615d0c7df9c968dacf36aa2a9abea6fc0101e06..8c6b09cee3c5fa0ad79e5a6a281d321b133285b3 100644 --- a/GeoLib/PropertyBounds.h +++ b/GeoLib/PropertyBounds.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file PropertyBounds.h - * 18/01/2010 KR Initial implementation + * + * Created on 2010-01-18 by Karsten Rink */ #ifndef PROPERTYBOUNDS_H diff --git a/GeoLib/QuadTree.h b/GeoLib/QuadTree.h index b82f4aa9d537f0a267fd67f953dbfbcd6f342c60..e314f84a06da3beab5b83a2da8e7316178fa39bf 100644 --- a/GeoLib/QuadTree.h +++ b/GeoLib/QuadTree.h @@ -1,8 +1,13 @@ -/* - * QuadTree.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file QuadTree.h * - * Created on: Nov 9, 2010 - * Author: TF + * Created on 2010-11-09 by Thomas Fischer */ #ifndef QUADTREE_H_ diff --git a/GeoLib/Raster.cpp b/GeoLib/Raster.cpp index 53b90dfd6c1c5407fc45bc7877e394fc24241a4a..1ab6ad6f5915e0c232662c056fb1f0ab5bf364ae 100644 --- a/GeoLib/Raster.cpp +++ b/GeoLib/Raster.cpp @@ -1,8 +1,13 @@ -/* - * Raster.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 7, 2011 - * Author: TF + * + * \file Raster.cpp + * + * Created on 2011-09-07 by Thomas Fischer */ #include "Raster.h" diff --git a/GeoLib/Raster.h b/GeoLib/Raster.h index 829584d42d830ce14da519af2f736f7a801fc79e..c1173356c078c2f3972e947cb4bd351c51c18b3b 100644 --- a/GeoLib/Raster.h +++ b/GeoLib/Raster.h @@ -1,8 +1,13 @@ -/* - * Raster.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 7, 2011 - * Author: TF + * + * \file Raster.h + * + * Created on 2011-09-07 by Thomas Fischer */ #ifndef RASTER_H_ diff --git a/GeoLib/SimplePolygonTree.cpp b/GeoLib/SimplePolygonTree.cpp index 6c0cd25e927e698ae2f715b6b0b2b2f108a45c7c..bf0435cee8dc3da450696de7dfe92e1d6c1ae9f9 100644 --- a/GeoLib/SimplePolygonTree.cpp +++ b/GeoLib/SimplePolygonTree.cpp @@ -1,8 +1,13 @@ -/* - * SimplePolygonTree.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 22, 2010 - * Author: TF + * + * \file SimplePolygonTree.cpp + * + * Created on 2010-06-22 by Thomas Fischer */ #include "SimplePolygonTree.h" diff --git a/GeoLib/SimplePolygonTree.h b/GeoLib/SimplePolygonTree.h index d88c42f936ead181089146124a6f5a81334153eb..579ed2bc1d74e5f5fda0cae91075c735ea55af6b 100644 --- a/GeoLib/SimplePolygonTree.h +++ b/GeoLib/SimplePolygonTree.h @@ -1,8 +1,13 @@ -/* - * SimplePolygonTree.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file SimplePolygonTree.h * - * Created on: Jun 22, 2010 - * Author: TF + * Created on 2010-06-22 by Thomas Fischer */ #ifndef SIMPLEPOLYGONTREE_H_ diff --git a/GeoLib/Station.cpp b/GeoLib/Station.cpp index 9f3ad4a9e29bd8ca1fd44a5757ceca04f46d4d0a..cc927df5839f8f193d09774f3cb50a2d6e7557e9 100644 --- a/GeoLib/Station.cpp +++ b/GeoLib/Station.cpp @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Station.cpp - * KR Initial implementation + * + * Created by Karsten Rink */ #include <cmath> @@ -247,7 +254,7 @@ int StationBorehole::addStratigraphy(const std::vector<GeoLib::Point*> &profile, } return 1; } - + std::cout << "Error in StationBorehole::addStratigraphy() - Length of parameter vectors does not match." << std::endl; return 0; } diff --git a/GeoLib/Station.h b/GeoLib/Station.h index b05d5daea16bb8c90c4380087288dbeff32b48b8..81ed77ed85eb165224bb389857ceb8f129ab1b93 100644 --- a/GeoLib/Station.h +++ b/GeoLib/Station.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Station.h - * KR Initial implementation + * + * Created by Karsten Rink */ #ifndef GEO_STATION_H diff --git a/GeoLib/Surface.cpp b/GeoLib/Surface.cpp index 82e9b93330841ed1bed2b84a56434bbcd4829348..6f205943a908a1f40c841006c98eee4008233c36 100644 --- a/GeoLib/Surface.cpp +++ b/GeoLib/Surface.cpp @@ -1,8 +1,13 @@ -/* - * Surface.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Apr 22, 2010 - * Author: TF + * + * \file Surface.cpp + * + * Created on 2010-04-22 by Thomas Fischer */ #include <list> diff --git a/GeoLib/Surface.h b/GeoLib/Surface.h index 2f5991624ffdd8546c9b269349ecbdb2ac6f34c1..dce0aec699283e6800896a656969e9c0b814e732 100644 --- a/GeoLib/Surface.h +++ b/GeoLib/Surface.h @@ -1,8 +1,13 @@ -/* - * Surface.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file Surface.h * - * Created on: Jan 22, 2010 - * Author: TF + * Created on 2010-01-22 by Thomas Fischer */ #ifndef SURFACE_H_ diff --git a/GeoLib/SurfaceVec.h b/GeoLib/SurfaceVec.h index e69604693b59e96fee643bdb36b7d308d3b1be3e..9fbaa0f7fe9157bd454668737345c89297462e65 100644 --- a/GeoLib/SurfaceVec.h +++ b/GeoLib/SurfaceVec.h @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file SurfaceVec.h * - * Created on: Feb 9, 2010 - * Author: fischeth + * Created on 2010-02-09 by Thomas Fischer */ diff --git a/GeoLib/TemplatePoint.h b/GeoLib/TemplatePoint.h index a9d3c74c9601ae079b8361ca01f01e975f80ab3d..ad0385269d6bc40d69bbba877bcfc6c9829b0572 100644 --- a/GeoLib/TemplatePoint.h +++ b/GeoLib/TemplatePoint.h @@ -1,8 +1,13 @@ -/* - * TemplatePoint.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file TemplatePoint.h * - * Created on: Jan 28, 2010 - * Author: fischeth + * Created on 2010-01-28 by Thomas Fischer */ #ifndef TEMPLATEPOINT_H_ diff --git a/GeoLib/TemplateVec.h b/GeoLib/TemplateVec.h index 1406f6e5de7ca4bef165917e8aeffd84d88a5f33..d3eeb04fb70540212b20ec8a31ced56126c2f28e 100644 --- a/GeoLib/TemplateVec.h +++ b/GeoLib/TemplateVec.h @@ -1,8 +1,13 @@ -/* - * TemplateVec.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file TemplateVec.h * - * Created on: Feb 26, 2010 - * Author: TF + * Created on 2010-02-26 by Thomas Fischer */ #ifndef TEMPLATEVEC_H_ diff --git a/GeoLib/Triangle.cpp b/GeoLib/Triangle.cpp index 0992089f0ed58d44f7bf904ae8a179ee190a9997..b6c17c4a4250875cf7a4cfa165913714fcb73160 100644 --- a/GeoLib/Triangle.cpp +++ b/GeoLib/Triangle.cpp @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Triangle.cpp * - * Created on: Jun 6, 2011 - * Author: TF + * Created on 2011-06-06 by Thomas Fischer */ #include "Triangle.h" diff --git a/GeoLib/Triangle.h b/GeoLib/Triangle.h index b404844d80ea4ec83298cfdf13cbb3bf31277c11..8264a5f1ee9a2c2ca7896ad62630c03818278f8a 100644 --- a/GeoLib/Triangle.h +++ b/GeoLib/Triangle.h @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Triangle.h * - * Created on: Mar 23, 2010 - * Author: TF + * Created on 2010-03-23 by Thomas Fischer */ #ifndef TRIANGLE_H_ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..6b0e2493bad4b3229914aac9a5ea4d088b64e0a5 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,30 @@ +Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. All advertising materials mentioning features or use of this software + must display the following acknowledgement: + This product includes software developed by the OpenGeoSys Community. +4. Neither the name of the OpenGeoSys Community nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. +5. Attribute the OpenGeoSys Community, preferably citing an appropriate + paper listed on the OpenGeoSys Community homepage: + http://www.opengeosys.net/papers + +THIS SOFTWARE IS PROVIDED BY THE OpenGeoSys Community ''AS IS'' AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE OpenGeoSys Community BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/MathLib/AnalyticalGeometry.cpp b/MathLib/AnalyticalGeometry.cpp index e4b2037c4b08525e1f2c67afcac88a245f3a3993..2ccf82e1c29e899fd93be9525e7e43882e67de1f 100644 --- a/MathLib/AnalyticalGeometry.cpp +++ b/MathLib/AnalyticalGeometry.cpp @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file AnalyticalGeometry.cpp * - * Created on: Mar 17, 2010 - * Author: TF + * Created on 2010-03-17 by Thomas Fischer */ #include <cmath> diff --git a/MathLib/AnalyticalGeometry.h b/MathLib/AnalyticalGeometry.h index a6219ab73a288949f04f082e5f8055e69057df66..ddb5dfe136ec53259e0cdd667fdc532072d49b9e 100644 --- a/MathLib/AnalyticalGeometry.h +++ b/MathLib/AnalyticalGeometry.h @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file AnalyticalGeometry.h * - * Created on: Mar 17, 2010 - * Author: TF + * Created on 2010-03-17 by Thomas Fischer */ #ifndef ANALYTICAL_GEOMETRY_H_ diff --git a/MathLib/EarClippingTriangulation.cpp b/MathLib/EarClippingTriangulation.cpp index d95e8e66db86383c949676c0e8cfcf8189861e36..6397aa9fd02b6b891b92cf35c0d2540da7f84abe 100644 --- a/MathLib/EarClippingTriangulation.cpp +++ b/MathLib/EarClippingTriangulation.cpp @@ -1,8 +1,13 @@ -/* - * EarClippingTriangulation.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Feb 23, 2011 - * Author: TF + * + * \file EarClippingTriangulation.cpp + * + * Created on 2011-02-23 by Thomas Fischer */ // STL diff --git a/MathLib/EarClippingTriangulation.h b/MathLib/EarClippingTriangulation.h index 4e0fc9d96dabddc86452a603f7e55bfe3d58918a..95a4e6004fe1c5efb05b512f3f23360738991e45 100644 --- a/MathLib/EarClippingTriangulation.h +++ b/MathLib/EarClippingTriangulation.h @@ -1,8 +1,13 @@ -/* - * EarClippingTriangulation.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Feb 23, 2011 - * Author: TF + * + * \file EarClippingTriangulation.h + * + * Created on 2011-02-23 by Thomas Fischer */ #ifndef EARCLIPPINGTRIANGULATION_H_ diff --git a/MathLib/InterpolationAlgorithms/LinearIntervalInterpolation.h b/MathLib/InterpolationAlgorithms/LinearIntervalInterpolation.h index 40f728ad8006d5d36c195d7a957ce538707a169a..bc78efc69d32c46fe8dc4c19cef4f09b804a1c3d 100644 --- a/MathLib/InterpolationAlgorithms/LinearIntervalInterpolation.h +++ b/MathLib/InterpolationAlgorithms/LinearIntervalInterpolation.h @@ -1,8 +1,13 @@ -/* - * @file LinearIntervalInterpolation.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file LinearIntervalInterpolation.h * - * Created on: May 22, 2012 - * Author: fischeth + * Created on 2012-05-22 by Thomas Fischer */ #ifndef LINEARINTERVALINTERPOLATION_H_ diff --git a/MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.cpp b/MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.cpp index f7c282ed11b91b0f919df73dd76d4ffd0d9b77fb..1b6b4e6e8ca63c6ceb1d2fc5dd618544ac767e05 100644 --- a/MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.cpp +++ b/MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.cpp @@ -1,8 +1,13 @@ -/* - * PiecewiseLinearInterpolation.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 7, 2010 - * Author: TF + * + * \file PiecewiseLinearInterpolation.cpp + * + * Created on 2010-09-07 by Thomas Fischer */ #include "PiecewiseLinearInterpolation.h" diff --git a/MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.h b/MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.h index e7f70d5a2a1138ed21d625fab01a27127f989aeb..f911386d23ed0f9f96e2fded1d533c38b8882c07 100644 --- a/MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.h +++ b/MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.h @@ -1,8 +1,13 @@ -/* - * PiecewiseLinearInterpolation.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 7, 2010 - * Author: TF + * + * \file PiecewiseLinearInterpolation.h + * + * Created on 2010-09-07 by Thomas Fischer */ #ifndef PIECEWISELINEARINTERPOLATION_H_ diff --git a/MathLib/LinAlg/Dense/Matrix.h b/MathLib/LinAlg/Dense/Matrix.h index 86b282039d36bc2696d3c1d89dbf0b7747d88ed3..2f30e88b02ad8b6b635390d1a9182fefd5ab4b96 100644 --- a/MathLib/LinAlg/Dense/Matrix.h +++ b/MathLib/LinAlg/Dense/Matrix.h @@ -1,10 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Matrix.h * - * Created on: Mar 24, 2010 - * Author: TF - * modified on:Jul 13, 2010 - * HS & ZC + * Created on 2011-05-24 by Thomas Fischer */ #ifndef MATRIX_H diff --git a/MathLib/LinAlg/MatrixBase.h b/MathLib/LinAlg/MatrixBase.h index 77877db23e965b299ae917a8f76cd3827d471f7f..97267b805b7b4fcb0193b491b4f776e4559221b8 100644 --- a/MathLib/LinAlg/MatrixBase.h +++ b/MathLib/LinAlg/MatrixBase.h @@ -1,8 +1,13 @@ -/* - * MatrixBase.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file MatrixBase.h * - * Created on: Sep 27, 2011 - * Author: TF + * Created on 2011-09-27 by Thomas Fischer */ #ifndef MATRIXBASE_H_ diff --git a/MathLib/LinAlg/Preconditioner/generateDiagPrecond.h b/MathLib/LinAlg/Preconditioner/generateDiagPrecond.h index 7d7568a74e0c1bf3599ebb4ee2269543fcc491c6..4ed3dacbb9c12c78bba62af07283a8ba3d472f77 100644 --- a/MathLib/LinAlg/Preconditioner/generateDiagPrecond.h +++ b/MathLib/LinAlg/Preconditioner/generateDiagPrecond.h @@ -1,8 +1,13 @@ -/* - * generateDiagPrecond.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file generateDiagPrecond.h * - * Created on: Sep 28, 2011 - * Author: TF + * Created on 2011-09-28 by Thomas Fischer */ #ifndef GENERATEDIAGPRECOND_H_ diff --git a/MathLib/LinAlg/Solvers/BiCGStab.cpp b/MathLib/LinAlg/Solvers/BiCGStab.cpp index 7f6a4ef3deb685f84ecb47141ad857585016b1de..b1218b6dabd9691995ae2b4af66963e8b5db574a 100644 --- a/MathLib/LinAlg/Solvers/BiCGStab.cpp +++ b/MathLib/LinAlg/Solvers/BiCGStab.cpp @@ -1,8 +1,13 @@ -/* - * BiCGStab.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Oct 4, 2011 - * Author: TF + * + * \file BiCGStab.cpp + * + * Created on 2011-10-04 by Thomas Fischer */ #include "BiCGStab.h" diff --git a/MathLib/LinAlg/Solvers/BiCGStab.h b/MathLib/LinAlg/Solvers/BiCGStab.h index cdf699d336a27bffcf621a140e109ae03880cce2..58fc5ccc7aa42109b550d0f244ca0bb25aeecd0a 100644 --- a/MathLib/LinAlg/Solvers/BiCGStab.h +++ b/MathLib/LinAlg/Solvers/BiCGStab.h @@ -1,8 +1,13 @@ -/* - * BiCGStab.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Oct 4, 2011 - * Author: TF + * + * \file BiCGStab.h + * + * Created on 2011-10-04 by Thomas Fischer */ #ifndef BICGSTAB_H_ diff --git a/MathLib/LinAlg/Solvers/CG.cpp b/MathLib/LinAlg/Solvers/CG.cpp index 93da2db1a53dd7e483af5346f121c39eed639911..661f6e185defaae8b16f477c8e758b28b4552265 100644 --- a/MathLib/LinAlg/Solvers/CG.cpp +++ b/MathLib/LinAlg/Solvers/CG.cpp @@ -1,8 +1,13 @@ -/* - * CG.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 27, 2011 - * Author: TF + * + * \file CG.cpp + * + * Created on 2011-09-27 by Thomas Fischer */ #include <limits> diff --git a/MathLib/LinAlg/Solvers/CG.h b/MathLib/LinAlg/Solvers/CG.h index 9996a872cbe9df765c3f1455abd54e279809fc94..0a359504ffff547926f86d6f851ae5dc9cef9b37 100644 --- a/MathLib/LinAlg/Solvers/CG.h +++ b/MathLib/LinAlg/Solvers/CG.h @@ -1,8 +1,13 @@ -/* - * solver.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 27, 2011 - * Author: TF + * + * \file solver.h + * + * Created on 2011-09-27 by Thomas Fischer */ #ifndef CG_H_ diff --git a/MathLib/LinAlg/Solvers/CGParallel.cpp b/MathLib/LinAlg/Solvers/CGParallel.cpp index f14824dc4af645b89fc64fcbd65a788fbce605bc..72a4f2a652b4c8e4ec5e47df25d4a878c65f8d8b 100644 --- a/MathLib/LinAlg/Solvers/CGParallel.cpp +++ b/MathLib/LinAlg/Solvers/CGParallel.cpp @@ -1,8 +1,13 @@ -/* - * CGParallel.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Dec 2, 2011 - * Author: TF + * + * \file CGParallel.cpp + * + * Created on 2011-12-02 by Thomas Fischer */ #include <limits> diff --git a/MathLib/LinAlg/Solvers/DenseDirectLinearSolver.h b/MathLib/LinAlg/Solvers/DenseDirectLinearSolver.h index 3ef0205c502fc07d7b133515a933f7fe1c504493..3ee0d240254e80e1790b5b7c285cf99c2e92a5e1 100644 --- a/MathLib/LinAlg/Solvers/DenseDirectLinearSolver.h +++ b/MathLib/LinAlg/Solvers/DenseDirectLinearSolver.h @@ -1,8 +1,13 @@ -/* - * DenseDirectLinearSolver.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 7, 2011 - * Author: TF + * + * \file DenseDirectLinearSolver.h + * + * Created on 2011-01-07 by Thomas Fischer */ #ifndef DENSEDIRECTLINEARSOLVER_H_ diff --git a/MathLib/LinAlg/Solvers/DirectLinearSolver.h b/MathLib/LinAlg/Solvers/DirectLinearSolver.h index 46daf3b2f4f20eebe85b60c8d9821dde345f0e95..18495f3d232b8b4bcad32accb3651d625d864049 100644 --- a/MathLib/LinAlg/Solvers/DirectLinearSolver.h +++ b/MathLib/LinAlg/Solvers/DirectLinearSolver.h @@ -1,8 +1,13 @@ -/* - * DirectLinearSolver.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 7, 2011 - * Author: TF + * + * \file DirectLinearSolver.h + * + * Created on 2011-01-07 by Thomas Fischer */ #ifndef DIRECTLINEARSOLVER_H_ diff --git a/MathLib/LinAlg/Solvers/GMRes.cpp b/MathLib/LinAlg/Solvers/GMRes.cpp index 871431f40d8023210ac1eca11b6138d12ff3a3d8..0381d1fc29e98ada7700eddfa3b3a7a427f068a5 100644 --- a/MathLib/LinAlg/Solvers/GMRes.cpp +++ b/MathLib/LinAlg/Solvers/GMRes.cpp @@ -1,8 +1,13 @@ -/* - * GMRes.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Oct 4, 2011 - * Author: TF + * + * \file GMRes.cpp + * + * Created on 2011-10-04 by Thomas Fischer */ #include "GMRes.h" diff --git a/MathLib/LinAlg/Solvers/GMRes.h b/MathLib/LinAlg/Solvers/GMRes.h index 732c560b425b78483a16c2179fc91540d1658831..01c17c90b440d30662e40ee58df5ffc7d8292e38 100644 --- a/MathLib/LinAlg/Solvers/GMRes.h +++ b/MathLib/LinAlg/Solvers/GMRes.h @@ -1,8 +1,13 @@ -/* - * GMRes.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Oct 4, 2011 - * Author: TF + * + * \file GMRes.h + * + * Created on 2011-10-04 by Thomas Fischer */ #ifndef GMRES_H_ diff --git a/MathLib/LinAlg/Solvers/GaussAlgorithm.cpp b/MathLib/LinAlg/Solvers/GaussAlgorithm.cpp index 2f0031c3035fa1880f63c85af2683abf16bebb48..fca395da0b661a5ae66f388b9a9962104547bc9e 100644 --- a/MathLib/LinAlg/Solvers/GaussAlgorithm.cpp +++ b/MathLib/LinAlg/Solvers/GaussAlgorithm.cpp @@ -1,8 +1,13 @@ -/* - * GaussAlgorithm.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: May 6, 2010 - * Author: TF + * + * \file GaussAlgorithm.cpp + * + * Created on 2011-05-06 by Thomas Fischer */ #include <cmath> diff --git a/MathLib/LinAlg/Solvers/GaussAlgorithm.h b/MathLib/LinAlg/Solvers/GaussAlgorithm.h index ad1422593965c248090086d97fd6717b0550a62c..82e9b253e62f79869869e008c46aa7b11f3ff6b5 100644 --- a/MathLib/LinAlg/Solvers/GaussAlgorithm.h +++ b/MathLib/LinAlg/Solvers/GaussAlgorithm.h @@ -1,8 +1,13 @@ -/* - * GaussAlgorithm.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file GaussAlgorithm.h * - * Created on: May 6, 2010 - * Author: TF + * Created on 2011-05-06 by Thomas Fischer */ #ifndef GAUSSALGORITHM_H_ diff --git a/MathLib/LinAlg/Solvers/IterativeLinearSolver.h b/MathLib/LinAlg/Solvers/IterativeLinearSolver.h index 6e8b9e39202287f5d31da85591a23f45e2a89d11..cc70422dae1cf5d13c1d826eee3bab14af53ae67 100644 --- a/MathLib/LinAlg/Solvers/IterativeLinearSolver.h +++ b/MathLib/LinAlg/Solvers/IterativeLinearSolver.h @@ -1,8 +1,13 @@ -/* - * IterativeLinearSolver.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 7, 2011 - * Author: TF + * + * \file IterativeLinearSolver.h + * + * Created on 2011-01-07 by Thomas Fischer */ #ifndef ITERATIVELINEARSOLVER_H_ diff --git a/MathLib/LinAlg/Solvers/LinearSolver.h b/MathLib/LinAlg/Solvers/LinearSolver.h index 1264649dc08598cad631767856a48ad77fb05264..6b1bcac90ef8daab5ab71cac4bd6927d9b546eda 100644 --- a/MathLib/LinAlg/Solvers/LinearSolver.h +++ b/MathLib/LinAlg/Solvers/LinearSolver.h @@ -1,8 +1,13 @@ -/* - * LinearSolver.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file LinearSolver.h * - * Created on: Jan 7, 2011 - * Author: TF + * Created on 2011-01-07 by Thomas Fischer */ #ifndef LINEARSOLVER_H_ diff --git a/MathLib/LinAlg/Solvers/TriangularSolve.cpp b/MathLib/LinAlg/Solvers/TriangularSolve.cpp index 8fbfb5e3306162eacb258cafb8f74a85576bdd6e..ef236eabace5d2a4547c86f906bbe4ee40f9e7e2 100644 --- a/MathLib/LinAlg/Solvers/TriangularSolve.cpp +++ b/MathLib/LinAlg/Solvers/TriangularSolve.cpp @@ -1,8 +1,13 @@ -/* - * TriangularSolve.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: May 5, 2010 - * Author: TF + * + * \file TriangularSolve.cpp + * + * Created on 2011-05-05 by Thomas Fischer */ #include "../Dense/Matrix.h" diff --git a/MathLib/LinAlg/Solvers/TriangularSolve.h b/MathLib/LinAlg/Solvers/TriangularSolve.h index d7cd92664327f7e5246d905e3771da000c35d70b..984d671b60b3b3058be941499475727645a1b189 100644 --- a/MathLib/LinAlg/Solvers/TriangularSolve.h +++ b/MathLib/LinAlg/Solvers/TriangularSolve.h @@ -1,8 +1,13 @@ -/* - * TriangularSolve.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file TriangularSolve.h * - * Created on: May 6, 2010 - * Author: TF + * Created on 2011-05-06 by Thomas Fischer */ #ifndef TRIANGULARSOLVE_H_ diff --git a/MathLib/LinAlg/Solvers/solver.h b/MathLib/LinAlg/Solvers/solver.h index 280a62ac9afdea49467446ab5a61417d06b748a2..a815e88f8dadfa52e2c2bd123709a0240ea9ffb6 100644 --- a/MathLib/LinAlg/Solvers/solver.h +++ b/MathLib/LinAlg/Solvers/solver.h @@ -1,8 +1,13 @@ -/* - * solver.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 27, 2011 - * Author: TF + * + * \file solver.h + * + * Created on 2011-09-27 by Thomas Fischer */ #ifndef SOLVER_H_ diff --git a/MathLib/LinAlg/Sparse/CRSMatrix.h b/MathLib/LinAlg/Sparse/CRSMatrix.h index bd141bc4a6fac8db301a12b5bdd009dc60f67562..7eb908d7bfc598716fead4e7e0e8120dc15b3f94 100644 --- a/MathLib/LinAlg/Sparse/CRSMatrix.h +++ b/MathLib/LinAlg/Sparse/CRSMatrix.h @@ -1,8 +1,13 @@ -/* - * CRSMatrix.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 20, 2011 - * Author: TF + * + * \file CRSMatrix.h + * + * Created on 2011-09-20 by Thomas Fischer */ #ifndef CRSMATRIX_H diff --git a/MathLib/LinAlg/Sparse/CRSMatrixOpenMP.h b/MathLib/LinAlg/Sparse/CRSMatrixOpenMP.h index e60f4f43761e2e6c9794c18483dee3678fc944b6..ec7c6e2fdd64a88ab83ef2408ed08d93b21c1e86 100644 --- a/MathLib/LinAlg/Sparse/CRSMatrixOpenMP.h +++ b/MathLib/LinAlg/Sparse/CRSMatrixOpenMP.h @@ -1,8 +1,13 @@ -/* - * CRSMatrixOpenMP.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Aug 8, 2011 - * Author: TF + * + * \file CRSMatrixOpenMP.h + * + * Created on 2011-08-08 by Thomas Fischer */ #ifndef CRSMATRIXOPENMP_H_ diff --git a/MathLib/LinAlg/Sparse/CRSMatrixPThreads.h b/MathLib/LinAlg/Sparse/CRSMatrixPThreads.h index 32ca857f505bd713bb3c771623da92dedc8e196c..86495c0013ad673b5ebec7ea2ea94a586365fb5f 100644 --- a/MathLib/LinAlg/Sparse/CRSMatrixPThreads.h +++ b/MathLib/LinAlg/Sparse/CRSMatrixPThreads.h @@ -1,8 +1,13 @@ -/* - * CRSMatrixPThreads.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Aug 2, 2011 - * Author: TF + * + * \file CRSMatrixPThreads.h + * + * Created on 2011-08-02 by Thomas Fischer */ #ifndef CRSMATRIXPTHREADS_H diff --git a/MathLib/LinAlg/Sparse/CRSSymMatrix.h b/MathLib/LinAlg/Sparse/CRSSymMatrix.h index 37a75ed86f7966a1d3d543a81bf0ba6ddafeb6c0..70045509980443016fb9095bb70781dbb26b3c3f 100644 --- a/MathLib/LinAlg/Sparse/CRSSymMatrix.h +++ b/MathLib/LinAlg/Sparse/CRSSymMatrix.h @@ -1,8 +1,13 @@ -/* - * CRSSymMatrix.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jul 22, 2011 - * Author: fischeth + * + * \file CRSSymMatrix.h + * + * Created on 2011-07-22 by Thomas Fischer */ #ifndef CRSSYMMATRIX_H_ diff --git a/MathLib/LinAlg/Sparse/CRSTranspose.h b/MathLib/LinAlg/Sparse/CRSTranspose.h index 010a49e5a31126c57d14232f3185573857892aff..5385d4bbc42783265b752698bc9c0d5750f89285 100644 --- a/MathLib/LinAlg/Sparse/CRSTranspose.h +++ b/MathLib/LinAlg/Sparse/CRSTranspose.h @@ -1,8 +1,13 @@ -/* - * CRSTranspose.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 27, 2011 - * Author: TF + * + * \file CRSTranspose.h + * + * Created on 2011-09-27 by Thomas Fischer */ #ifndef CRSTRANSPOSE_H_ diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/AdjMat.cpp b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/AdjMat.cpp index d01e2272d1f32595d1840c02c4ea2d4f4ffa1a04..6de26e686d6dd550cef7e37fae9021b5dbfcac48 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/AdjMat.cpp +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/AdjMat.cpp @@ -1,8 +1,13 @@ -/* - * AdjMat.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file AdjMat.cpp * - * Created on: 02.01.2012 - * Author: TF + * Created on 2012-01-02 by Thomas Fischer */ // Base diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/AdjMat.h b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/AdjMat.h index 2b1c21ccde03f88e12c4fbe3d290725ee065265d..7c8381d7bb285e8f95a0a5b0986cb4d1e3c1f839 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/AdjMat.h +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/AdjMat.h @@ -1,8 +1,13 @@ -/* - * AdjMat.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: 02.01.2012 - * Author: TF + * + * \file AdjMat.h + * + * Created on 2012-01-02 by Thomas Fischer */ #ifndef ADJMAT_H_ diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReordered.cpp b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReordered.cpp index 18093b91dbe70b4f3755d49ec4f56f592c271d5b..2f1ef5de93d9c4f4e51c8d0babf611adac75ede1 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReordered.cpp +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReordered.cpp @@ -1,8 +1,13 @@ -/* - * CRSMatrixReordered.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 3, 2012 - * Author: TF + * + * \file CRSMatrixReordered.cpp + * + * Created on 2012-01-03 by Thomas Fischer */ // BaseLib diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReordered.h b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReordered.h index a7d372ff033568ab830509c3c5bd9e550b173916..ff4d4b2a921581303311cb78f82fec0b2bfe78bf 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReordered.h +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReordered.h @@ -1,8 +1,13 @@ -/* - * CRSMatrixReordered.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 3, 2012 - * Author: TF + * + * \file CRSMatrixReordered.h + * + * Created on 2012-01-03 by Thomas Fischer */ #ifndef CRSMATRIXREORDERED_H_ diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReorderedOpenMP.cpp b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReorderedOpenMP.cpp index f773702c42ef58eac66f16ba5591560f11555339..276b9b55c868d415a8a3fdc2cebb4628b331cca9 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReorderedOpenMP.cpp +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReorderedOpenMP.cpp @@ -1,8 +1,13 @@ -/* - * CRSMatrixReorderedOpenMP.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 20, 2012 - * Author: TF + * + * \file CRSMatrixReorderedOpenMP.cpp + * + * Created on 2012-01-12 by Thomas Fischer */ #ifdef _OPENMP diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReorderedOpenMP.h b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReorderedOpenMP.h index 471a91980e8b4ab5d5952589f0c16fd4d28a49b7..ec122da171b7cf1cec7c3af0d13bac55f7e3bed8 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReorderedOpenMP.h +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/CRSMatrixReorderedOpenMP.h @@ -1,8 +1,13 @@ -/* - * CRSMatrixReorderedOpenMP.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 20, 2012 - * Author: TF + * + * \file CRSMatrixReorderedOpenMP.h + * + * Created on 2012-01-20 by Thomas Fischer */ #ifndef CRSMATRIXREORDEREDOPENMP_H_ diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.cpp b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.cpp index 99fe759cc2a2a2a2010263a29fcf08e50b6c95d2..1b1e28397ce9216e6436ee184d3e27c42d195196 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.cpp +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.cpp @@ -1,8 +1,13 @@ -/* - * Cluster.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: 02.01.2012 - * Author: TF + * + * \fileCluster.cpp + * + * Created on 2012-01-02 by Thomas Fischer */ #include "metis.h" diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.h b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.h index 1ee767c2b454e4e8dba4afad2e43c589cc068eb5..96464179f045a6cc6d6eb81edc3e8d7ba502ffca 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.h +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.h @@ -1,8 +1,7 @@ /* - * Cluster.h + * \file Cluster.h * - * Created on: 02.01.2012 - * Author: TF + * Created on 2012-01-02 by Thomas Fischer */ #ifndef CLUSTER_H_ diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.cpp b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.cpp index 23565205a7bc4b5aa0517c0d13952b7f7eb82a32..7f2420657b2dff2917d7b1fbfddc0845dfabd9ed 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.cpp +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.cpp @@ -1,8 +1,13 @@ -/* - * ClusterBase.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: 02.01.2012 - * Author: TF + * + * \file ClusterBase.cpp + * + * Created on 2012-01-02 by Thomas Fischer */ //#include "blas.h" diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.h b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.h index 1f682f6acd354548bb2381f3e6dfc6ebdaa03bea..ef4f63bc09cb0f11a7658e1e6ea6bbc81f4c0925 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.h +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.h @@ -1,8 +1,13 @@ -/* - * ClusterBase.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: 02.01.2012 - * Author: TF + * + * \file ClusterBase.h + * + * Created on 2012-01-02 by Thomas Fischer */ #ifndef CLUSTERBASE_H_ diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Separator.cpp b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Separator.cpp index 226329ef83e5b35deb278bce2a1b6c660ff3b6d1..23a11046623e3d7b11790f7f63b5212488fe8539 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Separator.cpp +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Separator.cpp @@ -1,8 +1,13 @@ -/* - * Separator.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: 02.01.2012 - * Author: TF + * + * \file Separator.cpp + * + * Created on 2012-01-02 by Thomas Fischer */ // BaseLib diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Separator.h b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Separator.h index a90ba000139b037cb21646eb461d06b685ce963e..e7e273fc06482e76b4097808eed3e2aee86af6c5 100644 --- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Separator.h +++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Separator.h @@ -1,8 +1,7 @@ -/* +/** * Separator.h * - * Created on: 02.01.2012 - * Author: TF + * Created on 2012-01-02 by Thomas Fischer */ #ifndef SEPARATOR_H_ diff --git a/MathLib/LinAlg/Sparse/amuxCRS.cpp b/MathLib/LinAlg/Sparse/amuxCRS.cpp index 9821984763d7749e14c29019b2141d4fc8fcb405..fb66858c2673bdbb3ce2750b1aaac2694663715f 100644 --- a/MathLib/LinAlg/Sparse/amuxCRS.cpp +++ b/MathLib/LinAlg/Sparse/amuxCRS.cpp @@ -1,8 +1,13 @@ -/* - * CRSMatrix.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Sep 20, 2011 - * Author: TF + * + * \file CRSMatrix.h + * + * Created on 2011-09-20 by Thomas Fischer */ #include "amuxCRS.h" diff --git a/MathLib/LinAlg/VectorNorms.h b/MathLib/LinAlg/VectorNorms.h index 31bbf802f8cd969b12b14f6f4f12d7cb94d89d66..285e7e3d6d61b6c5acea8cbda7cd3738a165f01b 100644 --- a/MathLib/LinAlg/VectorNorms.h +++ b/MathLib/LinAlg/VectorNorms.h @@ -1,8 +1,13 @@ -/* - * VectorNorms.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jun 6, 2011 - * Author: TF + * + * \file VectorNorms.h + * + * Created on 2011-06-06 by Thomas Fischer */ #ifndef VECTORNORMS_H_ diff --git a/MathLib/MathTools.cpp b/MathLib/MathTools.cpp index 244319305a99f04e47ee6b7c99a45d1fec673a07..241cdad6ed8d9e523f74163889cb1c6e020c4f86 100644 --- a/MathLib/MathTools.cpp +++ b/MathLib/MathTools.cpp @@ -1,8 +1,13 @@ -/* - * MathTools.cpp +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Created on: Jan 13, 2010 - * Author: TF + * + * \file MathTools.cpp + * + * Created on 2010-01-13 by Thomas Fischer */ #include "MathTools.h" diff --git a/MathLib/MathTools.h b/MathLib/MathTools.h index b1d046c7a5091e0a52c2aea490b2656bd6ada38e..3e4774dabe43dada6e3a8a216d21e34e459cf6e0 100644 --- a/MathLib/MathTools.h +++ b/MathLib/MathTools.h @@ -1,8 +1,13 @@ -/* +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file MathTools.h * - * Created on: Jan 13, 2010 - * Author: TF + * Created on 2010-01-13 by Thomas Fischer */ #ifndef MATHTOOLS_H_ diff --git a/MathLib/Vector3.h b/MathLib/Vector3.h index 02114a8bde45030922fabff51f53d728c9f4447a..87be3c7872fedcf740eed52c3863e165b444637f 100644 --- a/MathLib/Vector3.h +++ b/MathLib/Vector3.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file Vector3.h - * 27/10/2009 LB Initial implementation + * + * Created on 2009-10-27 by Lars Bilke * From: http://www.strout.net/info/coding/classlib/intro.html * with modifications to derive from TemplatePoint */ diff --git a/MathLib/max.h b/MathLib/max.h index f98c375dd6d23236ab91c2c088e50348c2dc3d2b..3021de82f338ca3b147dd0a368501bad6c80f8fc 100644 --- a/MathLib/max.h +++ b/MathLib/max.h @@ -1,8 +1,13 @@ -/* - * max.h +/** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * + * \file max.h * - * Created on: Apr 20, 2010 - * Author: TF + * Created on 2010-04-20 by Thomas Fischer */ #ifndef MAX_H_ diff --git a/MeshLib/Elements/Cell.cpp b/MeshLib/Elements/Cell.cpp index 2b8a9d0806877e5e38664865a15ebda386cee201..7a3c9f202b6b12f301a4091ab6c90ca2db2105c3 100644 --- a/MeshLib/Elements/Cell.cpp +++ b/MeshLib/Elements/Cell.cpp @@ -1,8 +1,13 @@ /** - * Cell.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Cell.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Cell.h" diff --git a/MeshLib/Elements/Cell.h b/MeshLib/Elements/Cell.h index 58f9fcbfc2f690bbf44592f29f221c3bfdbbd169..8c63a4ada0a4e42f81e728f4fc7ecef5c4ecb4f4 100644 --- a/MeshLib/Elements/Cell.h +++ b/MeshLib/Elements/Cell.h @@ -1,8 +1,13 @@ /** - * Cell.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Cell.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef CELL_H_ @@ -45,7 +50,7 @@ protected: }; /* class */ -} +} #endif /* CELL_H_ */ diff --git a/MeshLib/Elements/Edge.cpp b/MeshLib/Elements/Edge.cpp index 7b27c132ff18eea1e7508b27249ac263f9b4bf10..e79c14c0cfe04c6d2835702735f1445fe9fff14f 100644 --- a/MeshLib/Elements/Edge.cpp +++ b/MeshLib/Elements/Edge.cpp @@ -1,8 +1,13 @@ /** - * Edge.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Edge.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Edge.h" diff --git a/MeshLib/Elements/Edge.h b/MeshLib/Elements/Edge.h index 09854162cc0a9dd352e79a92cc635670b2558fdf..d374596c984a04ffb5487418f13a0372d4e2d4c5 100644 --- a/MeshLib/Elements/Edge.h +++ b/MeshLib/Elements/Edge.h @@ -1,8 +1,13 @@ /** - * Edge.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Edge.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef EDGE_H_ diff --git a/MeshLib/Elements/Element.cpp b/MeshLib/Elements/Element.cpp index 77e8c4a9253909c39b2221694c0ab30050a1575c..ffa9f35aa86e121769cc2dcad367aa4df16c7b18 100644 --- a/MeshLib/Elements/Element.cpp +++ b/MeshLib/Elements/Element.cpp @@ -1,8 +1,13 @@ /** - * Element.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Element.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Element.h" @@ -70,7 +75,7 @@ const Node* Element::getNode(unsigned i) const return NULL; } -unsigned Element::getNodeIndex(unsigned i) const +unsigned Element::getNodeIndex(unsigned i) const { if (i<getNNodes()) return _nodes[i]->getID(); diff --git a/MeshLib/Elements/Element.h b/MeshLib/Elements/Element.h index 862a27c84345cba85ecff47cd0ee6f7b772a22de..1e30a3a61860f4a3d8fb75e7f76c46cccf91a61a 100644 --- a/MeshLib/Elements/Element.h +++ b/MeshLib/Elements/Element.h @@ -1,8 +1,13 @@ /** - * Element.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Element.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef ELEMENT_H_ @@ -24,7 +29,7 @@ class Element /* friend functions: */ friend class Mesh;//void Mesh::setElementInformationForNodes(); //friend void Mesh::addElement(Element*); - + public: /// Compute the minimum and maximum squared edge length for this element @@ -53,7 +58,7 @@ public: /// Get the number of nodes for face i. virtual unsigned getNFaceNodes(unsigned i) const = 0; - + /// Get the number of faces for this element. virtual unsigned getNFaces() const = 0; diff --git a/MeshLib/Elements/Face.cpp b/MeshLib/Elements/Face.cpp index d8ae6693c42a936b70517230f07a20f6bfbe5964..e634b37aec9f75dbabb3d339e398d10219855ef8 100644 --- a/MeshLib/Elements/Face.cpp +++ b/MeshLib/Elements/Face.cpp @@ -1,8 +1,13 @@ /** - * Face.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Face.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Face.h" diff --git a/MeshLib/Elements/Face.h b/MeshLib/Elements/Face.h index 0bd277a20d0fe8ff3c8f52488253d2e23871fa73..8c88f0fc4b6514e35906d2c3138ba2e56486a3f2 100644 --- a/MeshLib/Elements/Face.h +++ b/MeshLib/Elements/Face.h @@ -1,8 +1,13 @@ /** - * Face.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Face.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef FACE_H_ @@ -53,7 +58,7 @@ protected: double _area; private: - + }; /* class */ diff --git a/MeshLib/Elements/FemElem.cpp b/MeshLib/Elements/FemElem.cpp index ac3c2026221adfb0d9a43d773b490d34dd18dc93..4dba31288e4f7d6a2ce3bf6e0b1e10f729c85c23 100644 --- a/MeshLib/Elements/FemElem.cpp +++ b/MeshLib/Elements/FemElem.cpp @@ -1,8 +1,13 @@ /** - * Tet.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/03 - * Author: KR + * + * \file Tet.cpp + * + * Created on 2012-05-03 by Karsten Rink */ #include "FemElem.h" diff --git a/MeshLib/Elements/FemElem.h b/MeshLib/Elements/FemElem.h index a5229d743088b84aa99ba096928609e4411efd7e..e5a3f3d7c9c3a9644827ee6dadde082d671cd3b5 100644 --- a/MeshLib/Elements/FemElem.h +++ b/MeshLib/Elements/FemElem.h @@ -1,8 +1,13 @@ /** - * FemElem.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/03 - * Author: KR + * + * \file FemElem.h + * + * Created on 2012-05-03 by Karsten Rink */ #ifndef FEMELEM_H_ diff --git a/MeshLib/Elements/Hex.cpp b/MeshLib/Elements/Hex.cpp index 55ef9a299cce451fdc1daa7df78312a01a4cd26c..152025a68ba699bb15eedf72ce7421d25b79c717 100644 --- a/MeshLib/Elements/Hex.cpp +++ b/MeshLib/Elements/Hex.cpp @@ -1,8 +1,13 @@ /** - * Hex.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Hex.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Hex.h" @@ -23,7 +28,7 @@ const unsigned Hex::_face_nodes[6][4] = {3, 0, 4, 7}, // Face 4 {4, 5, 6, 7} // Face 5 }; - + const unsigned Hex::_edge_nodes[12][2] = { {0, 1}, // Edge 0 diff --git a/MeshLib/Elements/Hex.h b/MeshLib/Elements/Hex.h index 68fa469be217438e76c07c39a8cd330f19d638fc..2cfb64de18446e4b7266f1cbec257dec371f493f 100644 --- a/MeshLib/Elements/Hex.h +++ b/MeshLib/Elements/Hex.h @@ -1,8 +1,13 @@ /** - * Hex.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Hex.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef HEX_H_ diff --git a/MeshLib/Elements/Prism.cpp b/MeshLib/Elements/Prism.cpp index e75aac59ced33a7db51fe1d1f5f860749863d683..5c52b3f11a5c13f75dea8131a0f4443a4971002a 100644 --- a/MeshLib/Elements/Prism.cpp +++ b/MeshLib/Elements/Prism.cpp @@ -1,8 +1,13 @@ /** - * Prism.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Prism.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Prism.h" @@ -22,7 +27,7 @@ const unsigned Prism::_face_nodes[5][4] = {2, 0, 3, 5}, // Face 3 {3, 4, 5, 99} // Face 4 }; - + const unsigned Prism::_edge_nodes[9][2] = { {0, 1}, // Edge 0 diff --git a/MeshLib/Elements/Prism.h b/MeshLib/Elements/Prism.h index d4604e63f63866a1c73e3e5bbd2fc0aa18e46e7a..2beb5639461665f72c0dbe4f009f362fdde7c067 100644 --- a/MeshLib/Elements/Prism.h +++ b/MeshLib/Elements/Prism.h @@ -1,8 +1,13 @@ /** - * Prism.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Prism.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef PRISM_H_ diff --git a/MeshLib/Elements/Pyramid.cpp b/MeshLib/Elements/Pyramid.cpp index 994d4403b31de37d325aeb00918d2d85b8e0f232..e24f2ea2d9786631eb00580ce484b3c2bca4ca04 100644 --- a/MeshLib/Elements/Pyramid.cpp +++ b/MeshLib/Elements/Pyramid.cpp @@ -1,8 +1,13 @@ /** - * Pyramid.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Pyramid.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Pyramid.h" @@ -22,7 +27,7 @@ const unsigned Pyramid::_face_nodes[5][4] = {3, 0, 4, 99}, // Face 3 {0, 3, 2, 1} // Face 4 }; - + const unsigned Pyramid::_edge_nodes[8][2] = { {0, 1}, // Edge 0 diff --git a/MeshLib/Elements/Pyramid.h b/MeshLib/Elements/Pyramid.h index 35eb1da38371e791b31dfbb77f47da6252de75aa..1fabff349858ce4a42ebd77dbd1e6edf7c358a8e 100644 --- a/MeshLib/Elements/Pyramid.h +++ b/MeshLib/Elements/Pyramid.h @@ -1,8 +1,13 @@ /** - * Pyramid.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Pyramid.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef PYRAMID_H_ diff --git a/MeshLib/Elements/Quad.cpp b/MeshLib/Elements/Quad.cpp index f909f4ae1e5c39ead4cbc15d1e53165a8fbca8cb..57c3ad9c2ecd34e7bbdc82f48e96179add17b627 100644 --- a/MeshLib/Elements/Quad.cpp +++ b/MeshLib/Elements/Quad.cpp @@ -1,15 +1,20 @@ /** - * Quad.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Quad.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Quad.h" #include "Node.h" #include "MathTools.h" - + namespace MeshLib { diff --git a/MeshLib/Elements/Quad.h b/MeshLib/Elements/Quad.h index 305ec5bb9a8dc20bc34e81f0631a7a5d87c81b5a..cfa2983aede16fa8dd5721743b6d5dc4d95343bb 100644 --- a/MeshLib/Elements/Quad.h +++ b/MeshLib/Elements/Quad.h @@ -1,8 +1,13 @@ /** - * Quad.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Quad.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef QUAD_H_ diff --git a/MeshLib/Elements/Tet.cpp b/MeshLib/Elements/Tet.cpp index c3878998e590a1f9d9f9c041788feb4ab42c7473..3c30f48ee142e68747434bb410cd28ded3068626 100644 --- a/MeshLib/Elements/Tet.cpp +++ b/MeshLib/Elements/Tet.cpp @@ -1,8 +1,13 @@ /** - * Tet.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Tet.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Tet.h" @@ -21,7 +26,7 @@ const unsigned Tet::_face_nodes[4][3] = {1, 2, 3}, // Face 2 {2, 0, 3} // Face 3 }; - + const unsigned Tet::_edge_nodes[6][2] = { {0, 1}, // Edge 0 diff --git a/MeshLib/Elements/Tet.h b/MeshLib/Elements/Tet.h index a0bec989b332c8b78fca7812a824a6891402c1da..7c4a23396549035f1afc5348856144092dc4fbcc 100644 --- a/MeshLib/Elements/Tet.h +++ b/MeshLib/Elements/Tet.h @@ -1,8 +1,13 @@ /** - * Tet.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Tet.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef TET_H_ @@ -50,7 +55,7 @@ public: /// Get the number of edges for this element. unsigned getNEdges() const { return 6; }; - + /// Get the number of nodes for face i. unsigned getNFaceNodes(unsigned i) const { (void)i; return 3; }; diff --git a/MeshLib/Elements/Tet10.cpp b/MeshLib/Elements/Tet10.cpp index cd65836d38f527371df58244f1cf51905aaf2594..93064840e172de66cbbf87c08105b246f610200e 100644 --- a/MeshLib/Elements/Tet10.cpp +++ b/MeshLib/Elements/Tet10.cpp @@ -1,8 +1,13 @@ /** - * Tet10.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/03 - * Author: KR + * + * \file Tet10.cpp + * + * Created on 2012-05-03 by Karsten Rink */ #include "Tet10.h" diff --git a/MeshLib/Elements/Tet10.h b/MeshLib/Elements/Tet10.h index c82e535469218edac2d4ae70ffbcfa7e8380b633..e6db7f3cccd61986e03e4b5a70f4b103921af906 100644 --- a/MeshLib/Elements/Tet10.h +++ b/MeshLib/Elements/Tet10.h @@ -1,8 +1,13 @@ /** - * Tet10.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/03 - * Author: KR + * + * \file Tet10.h + * + * Created on 2012-05-03 by Karsten Rink */ #ifndef TET10_H_ diff --git a/MeshLib/Elements/Tet4.cpp b/MeshLib/Elements/Tet4.cpp index c759eebc8da2a15dd771e37a4ab0b41706962233..dd8261bfee7f5f7a2853c2c046171b33a9da602a 100644 --- a/MeshLib/Elements/Tet4.cpp +++ b/MeshLib/Elements/Tet4.cpp @@ -1,8 +1,13 @@ /** - * Tet4.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/03 - * Author: KR + * + * \file Tet4.cpp + * + * Created on 2012-05-03 by Karsten Rink */ #include "Tet4.h" diff --git a/MeshLib/Elements/Tet4.h b/MeshLib/Elements/Tet4.h index ceefe2da107fa33d3f684f76305ee94abb3e9839..bc248b09b65ce37a9e559c48b7f0ebec6b140f1c 100644 --- a/MeshLib/Elements/Tet4.h +++ b/MeshLib/Elements/Tet4.h @@ -1,8 +1,13 @@ /** - * Tet4.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/03 - * Author: KR + * + * \file Tet4.h + * + * Created on 2012-05-03 by Karsten Rink */ #ifndef TET4_H_ diff --git a/MeshLib/Elements/Tri.cpp b/MeshLib/Elements/Tri.cpp index ea8c987cfe9a0c4b99cb3068ed4cdd12918e1acd..0b5ea299d588beed0b562b059978ccd3d66cfef5 100644 --- a/MeshLib/Elements/Tri.cpp +++ b/MeshLib/Elements/Tri.cpp @@ -1,8 +1,13 @@ /** - * Tri.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Tri.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Tri.h" diff --git a/MeshLib/Elements/Tri.h b/MeshLib/Elements/Tri.h index 9ab7c925081b1384ff6a8ece592be1c0a283d405..397b4d701b80ad48c0fa81e75ab58a8b89f02a4f 100644 --- a/MeshLib/Elements/Tri.h +++ b/MeshLib/Elements/Tri.h @@ -1,8 +1,13 @@ /** - * Tri.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Tri.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef TRI_H_ @@ -58,7 +63,7 @@ protected: /// Return a specific edge node. inline Node* getEdgeNode(unsigned edge_id, unsigned node_id) const { return _nodes[_edge_nodes[edge_id][node_id]]; }; - + static const unsigned _edge_nodes[3][2]; }; /* class */ diff --git a/MeshLib/FemMesh.cpp b/MeshLib/FemMesh.cpp index 57139554a5c88ee42c7afd2e8fa3a87573de2b0d..c5e6211f2d15d0c6d5cf003be13ccc5085a95d0f 100644 --- a/MeshLib/FemMesh.cpp +++ b/MeshLib/FemMesh.cpp @@ -1,8 +1,13 @@ /** - * FemMesh.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file FemMesh.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "FemMesh.h" diff --git a/MeshLib/FemMesh.h b/MeshLib/FemMesh.h index 9cf4617441d44bb23b4cf535e4e8b67e3e4fb3ff..c4a96558fc02db770efea6bc8b3d938e76cd3a7b 100644 --- a/MeshLib/FemMesh.h +++ b/MeshLib/FemMesh.h @@ -1,8 +1,13 @@ /** - * FemMesh.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file FemMesh.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef FEMMESH_H_ diff --git a/MeshLib/FemNode.cpp b/MeshLib/FemNode.cpp index 93c458c2dbbc0007757fc230d7f54ff04794121e..ca2dd18139c7117bc1ff4ac80164eba6eaf80bdc 100644 --- a/MeshLib/FemNode.cpp +++ b/MeshLib/FemNode.cpp @@ -1,8 +1,13 @@ /** - * FemNode.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file FemNode.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "FemNode.h" diff --git a/MeshLib/FemNode.h b/MeshLib/FemNode.h index 6b49a4893080057c39743c71a959f38d6cd713dc..e93cfa50336a2862d94ed42a61847dc729a6016e 100644 --- a/MeshLib/FemNode.h +++ b/MeshLib/FemNode.h @@ -1,8 +1,13 @@ /** - * FemNode.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file FemNode.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef FEMNODE_H_ @@ -20,7 +25,7 @@ class FemNode : public Node public: /// Constructor using a coordinate array FemNode(double const*const coords, unsigned id = std::numeric_limits<unsigned>::max()); - + /// Constructor using single coordinates FemNode(double x, double y, double z, unsigned id = std::numeric_limits<unsigned>::max()); diff --git a/MeshLib/Mesh.cpp b/MeshLib/Mesh.cpp index a7e5e5cf88f58899a4553d85caeb0c8f084568a7..9037936c9146d727c569340b0f0bcd30009a0f3d 100644 --- a/MeshLib/Mesh.cpp +++ b/MeshLib/Mesh.cpp @@ -1,8 +1,13 @@ /** - * Mesh.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Mesh.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Mesh.h" @@ -47,7 +52,7 @@ void Mesh::makeNodesUnique() { //check for unique mesh nodes //PointVec::makePntsUnique - + //replace node pointers in elements unsigned nElements (_elements.size()); for (unsigned i=0; i<nElements; i++) @@ -58,17 +63,17 @@ void Mesh::makeNodesUnique() } //set correct id for each node - + } void Mesh::addNode(Node* node) { - _nodes.push_back(node); + _nodes.push_back(node); } -void Mesh::addElement(Element* elem) +void Mesh::addElement(Element* elem) { - _elements.push_back(elem); + _elements.push_back(elem); // add element informatin to nodes unsigned nNodes (elem->getNNodes()); @@ -111,7 +116,7 @@ void Mesh::setNeighborInformationForElements() for (unsigned j=0; j<nNodes; j++) { const Node* node = elem->getNode(j); - + } } */ diff --git a/MeshLib/Mesh.h b/MeshLib/Mesh.h index 89edf6f0048e4133bfdff68187f11f654b345856..a83e9eb7077b691a29a00ea28ae2b3dab125e9e5 100644 --- a/MeshLib/Mesh.h +++ b/MeshLib/Mesh.h @@ -1,8 +1,13 @@ /** - * Mesh.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Mesh.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef MESH_H_ @@ -12,7 +17,7 @@ #include <string> #include <vector> -namespace MeshLib +namespace MeshLib { class Node; class Element; @@ -72,13 +77,13 @@ public: /// Get the element-vector for the mesh. const std::vector<Element*> getElements() const { return _elements; }; - /** + /** * Set the minimum and maximum length over the edges of the mesh. - * This should have been previously calcumlated using the Element::computeSqrEdgeLengthRange(min, max) + * This should have been previously calcumlated using the Element::computeSqrEdgeLengthRange(min, max) * function or by some other means. */ void setEdgeLengthRange(const double &min_length, const double &max_length); - + protected: /// Checks the coordinates of all mesh nodes and removes identical nodes. Elements are adapted accordingly. void makeNodesUnique(); diff --git a/MeshLib/MshEnums.cpp b/MeshLib/MshEnums.cpp index 123205ce94f57ea50fc81cd9793535b64c0990ed..572e17ba18281b71b85903fdb8c70174007fac7d 100644 --- a/MeshLib/MshEnums.cpp +++ b/MeshLib/MshEnums.cpp @@ -1,8 +1,13 @@ /** - * MshEnums.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file MshEnums.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "MshEnums.h" diff --git a/MeshLib/MshEnums.h b/MeshLib/MshEnums.h index 8a2084adb6da1fbfb4e715734c308ee75d3a4a0f..b017a14e555ce16c69c1e1a8aab0a98d2ebf57cd 100644 --- a/MeshLib/MshEnums.h +++ b/MeshLib/MshEnums.h @@ -1,8 +1,13 @@ /** - * MshEnums.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file MshEnums.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef MSHENUMS_H diff --git a/MeshLib/Node.cpp b/MeshLib/Node.cpp index 7e49a8259a91472e3860399642503cffc3658d50..0522716c747c11459bfaf4342419caea172de1c0 100644 --- a/MeshLib/Node.cpp +++ b/MeshLib/Node.cpp @@ -1,8 +1,13 @@ /** - * Node.cpp + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Node.cpp + * + * Created on 2012-05-02 by Karsten Rink */ #include "Node.h" diff --git a/MeshLib/Node.h b/MeshLib/Node.h index 1a64a2c9c21ff8cf6f084e4be2a9ff82fd870d0a..eac76578a0465ffc635902f3980ebc88abedbd86 100644 --- a/MeshLib/Node.h +++ b/MeshLib/Node.h @@ -1,8 +1,13 @@ /** - * Node.h + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt * - * Date: 2012/05/02 - * Author: KR + * + * \file Node.h + * + * Created on 2012-05-02 by Karsten Rink */ #ifndef NODE_H_ @@ -27,7 +32,7 @@ class Node : public GeoLib::PointWithID /* friend functions: */ friend class Mesh;//void Mesh::setElementInformationForNodes(); //friend void Mesh::addElement(Element*); - + public: /// Constructor using a coordinate array diff --git a/OGS/ProjectData.cpp b/OGS/ProjectData.cpp index 4cd68b19acc94ce1892bd55b2907029b20e304a7..6bb15ffa9012a49cc03ef1e5e4e37cf6ac54a026 100644 --- a/OGS/ProjectData.cpp +++ b/OGS/ProjectData.cpp @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file ProjectData.cpp - * 25/08/2010 KR Initial implementation + * + * Created on 2010-08-25 by Karsten Rink */ #include "ProjectData.h" @@ -63,7 +70,7 @@ const ProcessInfo* ProjectData::getProcess(FiniteElement::ProcessType type) cons if ((*it)->getProcessType() == type) return *it; - std::cout << "Error in ProjectData::getProcess() - No " + std::cout << "Error in ProjectData::getProcess() - No " << FiniteElement::convertProcessTypeToString(type) << " process found..." << std::endl; return NULL; } @@ -114,7 +121,7 @@ const std::vector<FEMCondition*> ProjectData::getConditions(FiniteElement::Proce std::string geo_name, FEMCondition::CondType cond_type) const { - // if all + // if all if (pcs_type == FiniteElement::INVALID_PROCESS && geo_name.empty() && cond_type == FEMCondition::UNSPECIFIED) return _cond_vec; diff --git a/OGS/ProjectData.h b/OGS/ProjectData.h index 7ccd75bb71d30713a6208465689be51b1c92ba33..2b0e5620210b58daf09be2ad50320ca0c5e0f0d5 100644 --- a/OGS/ProjectData.h +++ b/OGS/ProjectData.h @@ -1,6 +1,13 @@ /** + * Copyright (c) 2012, OpenGeoSys Community (http://www.opengeosys.net) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.net/LICENSE.txt + * + * * \file ProjectData.h - * 25/08/2010 KR Initial implementation + * + * Created on 2010-08-25 by Karsten Rink */ #ifndef PROJECTDATA_H_ @@ -89,7 +96,7 @@ public: const std::string &cond_name); /// Removes all FEM Conditions with the given type from the given process - virtual void removeConditions(FiniteElement::ProcessType pcs_type = FiniteElement::INVALID_PROCESS, + virtual void removeConditions(FiniteElement::ProcessType pcs_type = FiniteElement::INVALID_PROCESS, std::string geo_name = "", FEMCondition::CondType cond_type = FEMCondition::UNSPECIFIED); diff --git a/README.md b/README.md index 9ba4484771b8fedacff88d622cf843e868613517..2c0197e9c38b145773aae41a5aeeee4e5ec45d9d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,8 @@ # OpenGeoSys 6 # -## Intro ## +***This is the source code of the next generation [OpenGeoSys][ogs].*** -***This is the source code of the next generation [OpenGeoSys](http://www.opengeosys.net).*** - -At the moment we are evaluating Git and Github as our main development infrastructure. -To get started with Github have a look at these [customized help pages](http://ufz.github.com/help) or at -[these slides](https://svn.ufz.de/ogs/raw-attachment/wiki/ogs6plan/Collaborative%20development%20with%20Git%20and%20Github%2C%20Lars%20Bilke.pdf). - -## OpenGeoSys ## +## The OpenGeoSys-project ## OpenGeoSys (OGS) is a scientific open source project for the development of numerical methods for the simulation of thermo-hydro-mechanical-chemical @@ -17,10 +11,24 @@ is object-oriented with an focus on the numerical solution of coupled multi-fiel problems (multi-physics). Parallel versions of OGS are available relying on both MPI and OpenMP concepts. Application areas of OGS are currently CO2 sequestration, geothermal energy, water resources management, hydrology and -waste deposition. +waste deposition. OGS is comprised of the THMC-simulator (simply referred to as +*"OGS"*) and a visualization tool (*"Data Explorer"*). OGS is developed by the +[OpenGeoSys Community][ogs]. + +## Software development ## + +- To get started checkout the [developer guide][devguide] +- For the actual build status see the [Jenkins-CI server][jenkins-ci] +- Have a look at the [Doxygen documentation][docs] + +## License ## -## Development ## +OpenGeoSys is distributed under a Modified BSD License which encourages users to +attribute the work of the OpenGeoSys Community especially in scientific +publications. See the [LICENSE.txt][license-source] for the license text. -- To get started checkout the [developer guide](http://ufz.github.com/devguide) -- For the actual build status see the [Jenkins-CI server](https://svn.ufz.de/hudson/view/OGS-6/) -- Have a look at the [Doxygen documentation](https://svn.ufz.de/hudson/view/OGS-6/job/OGS-6-Docs/lastSuccessfulBuild/artifact/build/docs/index.html) \ No newline at end of file +[ogs]: http://www.opengeosys.net +[devguide]: http://ufz.github.com/devguide +[jenkins-ci]: https://svn.ufz.de/hudson/view/OGS-6/ +[docs]: https://svn.ufz.de/hudson/view/OGS-6/job/OGS-6-Docs/lastSuccessfulBuild/artifact/build/docs/index.html +[license-source]: https://github.com/ufz/ogs/blob/master/LICENSE.txt diff --git a/SimpleTests/MatrixTests/MatMult.cpp b/SimpleTests/MatrixTests/MatMult.cpp index 9b1dc8fb162ec8ca965074e7c7542649826e633c..dcef87a134fdd1f42f307c75afda1ddc93ee132a 100644 --- a/SimpleTests/MatrixTests/MatMult.cpp +++ b/SimpleTests/MatrixTests/MatMult.cpp @@ -1,8 +1,7 @@ -/* +/** * MatMult.cpp * - * Created on: Jan 3, 2012 - * Author: TF + * Created on 2012-01-03 by Thomas Fischer */ #include <fstream> @@ -26,7 +25,6 @@ #ifdef OGS_BUILD_INFO #include "BuildInfo.h" -#include <sys/unistd.h> #endif #ifdef _OPENMP @@ -98,11 +96,7 @@ int main(int argc, char *argv[]) } else { INFO("CXX_FLAGS: %s %s", CMAKE_CXX_FLAGS, CMAKE_CXX_FLAGS_DEBUG); } - const size_t length(256); - char *hostname(new char[length]); - gethostname (hostname, length); - INFO("hostname: %s", hostname); - delete [] hostname; + INFO("hostname: %s", HOSTNAME); #endif // *** reading matrix in crs format from file diff --git a/SimpleTests/MatrixTests/MatTestRemoveRowsCols.cpp b/SimpleTests/MatrixTests/MatTestRemoveRowsCols.cpp index 446bb7c8bf176a528cb1280a4d49fbe5b3cbf29f..8b3cc72dd65c41c22851ed02b7fa85ef9eef6c5d 100644 --- a/SimpleTests/MatrixTests/MatTestRemoveRowsCols.cpp +++ b/SimpleTests/MatrixTests/MatTestRemoveRowsCols.cpp @@ -1,8 +1,7 @@ -/* +/** * MatTestRemoveRowsCols.cpp * - * Created on: Nov 8, 2011 - * Author: TF + * Created on 2011-11-08 by Thomas Fischer */ #include <fstream> diff --git a/SimpleTests/MatrixTests/MatVecMultNDPerm.cpp b/SimpleTests/MatrixTests/MatVecMultNDPerm.cpp index 464db6143d65b795e3eabd653b46e2413f3571ec..0e2474671a4dcaf3a17aa0473f84a0844bcceb83 100644 --- a/SimpleTests/MatrixTests/MatVecMultNDPerm.cpp +++ b/SimpleTests/MatrixTests/MatVecMultNDPerm.cpp @@ -1,8 +1,7 @@ -/* +/** * MatVecMultNDPerm.cpp * - * Created on: Jan 3, 2012 - * Author: TF + * Created on 2012-01-03 by Thomas Fischer */ #include <cstdlib> diff --git a/SimpleTests/MatrixTests/MatVecMultNDPermOpenMP.cpp b/SimpleTests/MatrixTests/MatVecMultNDPermOpenMP.cpp index 4516c70382905bf945dd84afc36c18637fa5e429..6998eae46b623e573d114a6b8383dd60530e962c 100644 --- a/SimpleTests/MatrixTests/MatVecMultNDPermOpenMP.cpp +++ b/SimpleTests/MatrixTests/MatVecMultNDPermOpenMP.cpp @@ -1,8 +1,7 @@ -/* +/** * MatVecMultNDPermOpenMP.cpp * - * Created on: Jan 20, 2012 - * Author: TF + * Created on 2012-01-20 by Thomas Fischer */ #include <cstdlib> diff --git a/SimpleTests/MeshTests/MeshRead.cpp b/SimpleTests/MeshTests/MeshRead.cpp index 2e0da48402e8f6985617a8eefd5e6f1fcc0606c7..0dadf05f8bb3d10a447d9bc2d8c95eef15ba5a57 100644 --- a/SimpleTests/MeshTests/MeshRead.cpp +++ b/SimpleTests/MeshTests/MeshRead.cpp @@ -1,8 +1,7 @@ /* * MeshRead.cpp * - * Created on: 2012/05/09 - * Author: KR + * Created on 2012/05/09 by Karsten Rink */ // BaseLib diff --git a/SimpleTests/SolverTests/ConjugateGradientUnpreconditioned.cpp b/SimpleTests/SolverTests/ConjugateGradientUnpreconditioned.cpp index 96ead4200cfefbc8748f32f50f0a11acc05b01fa..89fcee8f806ac9fc29430806f521233890a6d8a2 100644 --- a/SimpleTests/SolverTests/ConjugateGradientUnpreconditioned.cpp +++ b/SimpleTests/SolverTests/ConjugateGradientUnpreconditioned.cpp @@ -16,7 +16,7 @@ int main(int argc, char *argv[]) (void) argv; // *** reading matrix in crs format from file - std::string fname("/work/fischeth/data/testmat.bin"); + std::string fname("/work/Thomas Fischer/data/testmat.bin"); // std::ifstream in(fname.c_str(), std::ios::binary); MathLib::CRSMatrix<double, unsigned> *mat (new MathLib::CRSMatrix<double, unsigned>(fname)); /* double *A(NULL); @@ -40,7 +40,7 @@ int main(int argc, char *argv[]) x[k] = 1.0; } // *** read rhs - fname = "/work/fischeth/data/rhs.dat"; + fname = "/work/Thomas Fischer/data/rhs.dat"; std::ifstream in(fname.c_str()); if (in) { read (in, n, b); diff --git a/SimpleTests/SolverTests/GMResDiagPrecond.cpp b/SimpleTests/SolverTests/GMResDiagPrecond.cpp index 7062cb20993fb5b10051067cb864ae687de14c9c..cd4c963cb4fc57faaaee9cf6e7f9a997a5e23edf 100644 --- a/SimpleTests/SolverTests/GMResDiagPrecond.cpp +++ b/SimpleTests/SolverTests/GMResDiagPrecond.cpp @@ -1,8 +1,7 @@ -/* +/** * GMResDiagPrecond.cpp * - * Created on: Oct 5, 2011 - * Author: TF + * Created on 2011-10-05 by Thomas Fischer */ #include <iostream> diff --git a/scripts/cmake/CMakeSetup.cmake b/scripts/cmake/CMakeSetup.cmake index 0deb262cf768e6e66beecba97eda144ea824c8b6..d22d40589e22879ad16ab37f009ff3e592b0dbe2 100644 --- a/scripts/cmake/CMakeSetup.cmake +++ b/scripts/cmake/CMakeSetup.cmake @@ -16,3 +16,6 @@ CMAKE_POLICY(SET CMP0011 OLD) IF (${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION} GREATER 2.7) CMAKE_POLICY(SET CMP0014 OLD) ENDIF () + +# Get the hostname +SITE_NAME(HOSTNAME) diff --git a/scripts/docs/Doxyfile.in b/scripts/docs/Doxyfile.in index 841a4522a8650ac4f8d9a8f1550f52c349a0433c..957147da7e50f91fcf7faf145d73d109dd30290d 100644 --- a/scripts/docs/Doxyfile.in +++ b/scripts/docs/Doxyfile.in @@ -14,76 +14,76 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = "OpenGeoSys-6 source code documentation" -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = ${OGS_VERSION} -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = ${PROJECT_BINARY_DIR}/docs -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = YES -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, -# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, -# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, # Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = "The $name class" \ @@ -98,202 +98,202 @@ ABBREVIATE_BRIEF = "The $name class" \ an \ the -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = +STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = YES -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 4 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = +ALIASES = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO -# Doxygen selects the parser to use depending on the extension of the files it parses. -# With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this tag. -# The format is ext=language, where ext is a file extension, and language is one of -# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, -# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat -# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C -EXTENSION_MAPPING = +EXTENSION_MAPPING = -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES -# If you use Microsoft's C++/CLI language, you should set this option to YES to +# If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen to replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penality. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will rougly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols SYMBOL_CACHE_SIZE = 0 @@ -302,213 +302,207 @@ SYMBOL_CACHE_SIZE = 0 # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = YES -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default # anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = YES -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = YES -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = NO -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = YES -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. This will remove the Namespaces entry from the Quick Index +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = NO -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command <command> <input-file>, where <command> is the value of -# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file -# provided by doxygen. Whatever the program writes to standard output +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. -FILE_VERSION_FILTER = +FILE_VERSION_FILTER = -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by -# doxygen. The layout file controls the global structure of the generated output files -# in an output format independent way. The create the layout file that represents -# doxygen's defaults, run doxygen with the -l option. You can optionally specify a -# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name # of the layout file. LAYOUT_FILE = ${CMAKE_SOURCE_DIR}/scripts/docs/DoxygenLayout.xml @@ -517,167 +511,169 @@ LAYOUT_FILE = ${CMAKE_SOURCE_DIR}/scripts/docs/DoxygenLayout.xml # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = YES -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = ${CMAKE_SOURCE_DIR}/Base \ +INPUT = ${CMAKE_SOURCE_DIR}/BaseLib \ + ${CMAKE_SOURCE_DIR}/FemLib \ + ${CMAKE_SOURCE_DIR}/FileIO \ ${CMAKE_SOURCE_DIR}/GeoLib \ ${CMAKE_SOURCE_DIR}/MathLib \ ${CMAKE_SOURCE_DIR}/MeshLib -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = *.h *.cpp *.dox -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = ${CMAKE_SOURCE_DIR}/BaseLib/logog -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = moc_* \ - ui_* \ - CMake* + ui_* \ + CMake* -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = +EXAMPLE_PATH = -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left # blank all files are included. -EXAMPLE_PATTERNS = +EXAMPLE_PATTERNS = -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command <filter> <input-file>, where <filter> -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be # ignored. -INPUT_FILTER = +INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. -FILTER_PATTERNS = +FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO @@ -686,53 +682,53 @@ FILTER_SOURCE_FILES = NO # configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body +# Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = NO -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = NO -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES @@ -741,238 +737,232 @@ VERBATIM_HEADERS = YES # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = ./ -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = +HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = +HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = doxygen.css - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES +HTML_STYLESHEET = ${CMAKE_SOURCE_DIR}/scripts/docs/doxygen.css -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). HTML_DYNAMIC_SECTIONS = NO -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be # written to the html output directory. -CHM_FILE = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. -HHC_LOCATION = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. -CHM_INDEX_ENCODING = +CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members +# The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER -# are set, an additional index file will be generated that can be used as input for -# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated # HTML documentation. GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. -QCH_FILE = +QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace -QHP_NAMESPACE = +QHP_NAMESPACE = -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = doc -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. -# For more information please see +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters -QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. -QHP_CUST_FILTER_ATTRS = +QHP_CUST_FILTER_ATTRS = -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's -# filter section matches. +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. -QHP_SECT_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. -QHG_LOCATION = +QHG_LOCATION = -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO -# This tag can be used to set the number of enum values (range [1..20]) +# This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to FRAME, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. Other possible values -# for this tag are: HIERARCHIES, which will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list; -# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which -# disables this behavior completely. For backwards compatibility with previous -# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE # respectively. GENERATE_TREEVIEW = YES -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 @@ -990,74 +980,74 @@ USE_MATHJAX = YES # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. -EXTRA_PACKAGES = +EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! -LATEX_HEADER = +LATEX_HEADER = -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = NO -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO @@ -1066,68 +1056,68 @@ LATEX_HIDE_INDICES = NO # configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man -# The MAN_EXTENSION tag determines the extension that is added to +# The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO @@ -1136,33 +1126,33 @@ MAN_LINKS = NO # configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_SCHEMA = +XML_SCHEMA = -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_DTD = +XML_DTD = -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES @@ -1171,10 +1161,10 @@ XML_PROGRAMLISTING = YES # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO @@ -1183,334 +1173,334 @@ GENERATE_AUTOGEN_DEF = NO # configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by # the preprocessor. -INCLUDE_PATH = +INCLUDE_PATH = -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = +PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = +GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES -# The PERL_PATH should be the absolute path and name of the perl script +# The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. -MSCGEN_PATH = +MSCGEN_PATH = -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = ${DOT_FOUND} -# By default doxygen will write a font called FreeSans.ttf to the output -# directory and reference it in all dot files that doxygen generates. This -# font does not include all possible unicode characters however, so when you need -# these (or just want a differently looking font) you can specify the font name -# using DOT_FONTNAME. You need need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. DOT_FONTNAME = FreeSans -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 -# By default doxygen will tell dot to use the output directory to look for the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. -DOT_FONTPATH = +DOT_FONTPATH = -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = ${DOCS_GENERATE_COLLABORATION_GRAPHS_STRING} -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO -# If set to YES, the inheritance and collaboration graphs will show the +# If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = ${DOCS_GENERATE_CALL_GRAPHS_STRING} -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = ${DOT_TOOL_PATH_ONLY} -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the # \dotfile command). -DOTFILE_DIRS = +DOTFILE_DIRS = -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = NO -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES @@ -1519,7 +1509,7 @@ DOT_CLEANUP = YES # Options related to the search engine #--------------------------------------------------------------------------- -# The SEARCHENGINE tag specifies whether or not a search engine should be +# The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = YES diff --git a/scripts/docs/DoxygenLayout.xml b/scripts/docs/DoxygenLayout.xml index 97599d196a4aea9c49e9804d9ea50ee2cf9a7786..be8b869b9eb200aad4425a82e4b0ee81b2d6dddb 100644 --- a/scripts/docs/DoxygenLayout.xml +++ b/scripts/docs/DoxygenLayout.xml @@ -10,7 +10,7 @@ </tab> <tab type="classes" visible="yes" title=""> <tab type="classes" visible="yes" title="" intro=""/> - <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> <tab type="hierarchy" visible="yes" title="" intro=""/> <tab type="classmembers" visible="no" title="" intro=""/> </tab> @@ -18,8 +18,7 @@ <tab type="files" visible="yes" title="" intro=""/> <tab type="globals" visible="yes" title="" intro=""/> </tab> - <tab type="dirs" visible="yes" title="" intro=""/> - <tab type="examples" visible="yes" title="" intro=""/> + <tab type="examples" visible="yes" title="" intro=""/> </navindex> <!-- Layout definition for a class page --> @@ -133,7 +132,6 @@ <memberdecl> <classes visible="yes" title=""/> <namespaces visible="yes" title=""/> - <dirs visible="yes" title=""/> <nestedgroups visible="yes" title=""/> <files visible="yes" title=""/> <defines title=""/> @@ -177,7 +175,6 @@ <briefdescription visible="yes"/> <directorygraph visible="yes"/> <memberdecl> - <dirs visible="yes"/> <files visible="yes"/> </memberdecl> <detaileddescription title=""/>