diff --git a/BaseLib/Histogram.h b/BaseLib/Histogram.h index 8ae04be9d180d4896cb4d1eaeb97a417e80652b6..9c889c6911895e623c15170724daf50cd20b40fa 100644 --- a/BaseLib/Histogram.h +++ b/BaseLib/Histogram.h @@ -14,7 +14,7 @@ #include <ostream> #include <vector> -namespace BASELIB +namespace BaseLib { /** Basic Histogram implementation. @@ -159,6 +159,6 @@ operator<<(std::ostream& os, const Histogram<T>& h) return os << std::endl; } -} // namespace BASELIB +} // namespace BaseLib #endif // BASELIB_HISTOGRAM_H diff --git a/BaseLib/zlib/CMakeLists.txt b/BaseLib/zlib/CMakeLists.txt index 93af750c457f534a3ca9373399956c3836a8c726..4152a4e824c42db36e92731e42164aa7296f79e7 100644 --- a/BaseLib/zlib/CMakeLists.txt +++ b/BaseLib/zlib/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 2.4.4) set(CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS ON) - +cmake_policy(SET CMP0003 NEW) project(zlib C) set(ZLIB_VERSION "1.2.7") diff --git a/CMakeLists.txt b/CMakeLists.txt index 5e3e4d71f367f9b8a17bb334cbfd67a4b8f23322..fd49d63f6a15b10ed518075143a5e43338b721e4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -8,6 +8,17 @@ CMAKE_MINIMUM_REQUIRED(VERSION 2.8.3) # Project name PROJECT( OGS-6 ) +########################################################################### +### OGS version information. Adjust these if you release a new version. ### +########################################################################### +SET (OGS_VERSION_MAJOR 0) +SET (OGS_VERSION_MINOR 0) +SET (OGS_VERSION_PATCH 1) +SET (OGS_RELEASE_PERSONS "LB/TF/KR") +SET (OGS_VERSION "${OGS_VERSION_MAJOR}.${OGS_VERSION_MINOR}.${OGS_VERSION_PATCH}") +SET (OGS_VERSION_AND_PERSONS "${OGS_VERSION} (${OGS_RELEASE_PERSONS})") +SET (OGS_DATE "2012-08-20") + ### CMake includes ### INCLUDE(scripts/cmake/CheckTypeSizes.cmake) INCLUDE(scripts/cmake/FindIncludeHeader.cmake) @@ -24,17 +35,6 @@ IF(OGS_COVERAGE) INCLUDE(scripts/cmake/Coverage.cmake) ENDIF() -########################################################################### -### OGS version information. Adjust these if you release a new version. ### -########################################################################### -SET (OGS_VERSION_MAJOR 0) -SET (OGS_VERSION_MINOR 0) -SET (OGS_VERSION_PATCH 1) -SET (OGS_RELEASE_PERSONS "LB/TF/KR") -SET (OGS_VERSION "${OGS_VERSION_MAJOR}.${OGS_VERSION_MINOR}.${OGS_VERSION_PATCH}") -SET (OGS_VERSION_AND_PERSONS "${OGS_VERSION} (${OGS_RELEASE_PERSONS})") -SET (OGS_DATE "2012-08-20") - ############### ### Options ### ############### diff --git a/FileIO/CMakeLists.txt b/FileIO/CMakeLists.txt index ec8801dd3a398c6c83a6b10a635882bbe17bf8e9..cfb8a2fc207b4f2990146ff9deea7b32d9c92c42 100644 --- a/FileIO/CMakeLists.txt +++ b/FileIO/CMakeLists.txt @@ -10,7 +10,8 @@ SET( SOURCES ) GET_SOURCE_FILES(SOURCES_LEGACY Legacy) GET_SOURCE_FILES(SOURCES_MESHIO MeshIO) -SET ( SOURCES ${SOURCES} ${SOURCES_LEGACY} ${SOURCES_MESHIO}) +GET_SOURCE_FILES(SOURCES_RAPID_XML RapidXmlIO) +SET ( SOURCES ${SOURCES} ${SOURCES_LEGACY} ${SOURCES_MESHIO} ${SOURCES_RAPID_XML}) IF (QT4_FOUND) GET_SOURCE_FILES(SOURCES_XML XmlIO) diff --git a/FileIO/XmlIO/RapidXMLInterface.cpp b/FileIO/RapidXmlIO/RapidStnInterface.cpp similarity index 93% rename from FileIO/XmlIO/RapidXMLInterface.cpp rename to FileIO/RapidXmlIO/RapidStnInterface.cpp index 4e30244ff8ac3da55306828a9eff489706f964d3..9b4d9dc3b3d42f3a09194890a56f36312e95a962 100644 --- a/FileIO/XmlIO/RapidXMLInterface.cpp +++ b/FileIO/RapidXmlIO/RapidStnInterface.cpp @@ -4,12 +4,12 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file RapidXMLInterface.cpp + * \file RapidStnInterface.cpp * * Created on 2012-08-16 by Karsten Rink */ //RapidXML -#include "RapidXMLInterface.h" +#include "RapidStnInterface.h" #include <iostream> #include "StringTools.h" @@ -18,7 +18,7 @@ namespace FileIO { -std::vector<GeoLib::Point*> *RapidXMLInterface::readStationFile(const std::string &fileName) +std::vector<GeoLib::Point*> *RapidStnInterface::readStationFile(const std::string &fileName) { std::vector<GeoLib::Point*> *stations = new std::vector<GeoLib::Point*>; std::ifstream in(fileName.c_str()); @@ -58,9 +58,9 @@ std::vector<GeoLib::Point*> *RapidXMLInterface::readStationFile(const std::strin { std::string b(list_item->name()); if (std::string(list_item->name()).compare("stations") == 0) - RapidXMLInterface::readStations(list_item, stations, fileName); + RapidStnInterface::readStations(list_item, stations, fileName); if (std::string(list_item->name()).compare("boreholes") == 0) - RapidXMLInterface::readStations(list_item, stations, fileName); + RapidStnInterface::readStations(list_item, stations, fileName); } } @@ -70,7 +70,7 @@ std::vector<GeoLib::Point*> *RapidXMLInterface::readStationFile(const std::strin return stations; } /* -int RapidXMLInterface::rapidReadFile(const std::string &fileName) +int RapidStnInterface::rapidReadFile(const std::string &fileName) { GEOLIB::GEOObjects* geoObjects = _project->getGEOObjects(); @@ -129,7 +129,7 @@ int RapidXMLInterface::rapidReadFile(const std::string &fileName) return 1; } */ -void RapidXMLInterface::readStations(const rapidxml::xml_node<>* station_root, std::vector<GeoLib::Point*> *stations, const std::string &file_name) +void RapidStnInterface::readStations(const rapidxml::xml_node<>* station_root, std::vector<GeoLib::Point*> *stations, const std::string &file_name) { for (rapidxml::xml_node<>* station_node = station_root->first_node(); station_node; station_node = station_node->next_sibling()) { @@ -179,7 +179,7 @@ void RapidXMLInterface::readStations(const rapidxml::xml_node<>* station_root, s s->setStationValue(station_value); if (station_node->first_node("strat")) - RapidXMLInterface::readStratigraphy(station_node->first_node("strat"), s); + RapidStnInterface::readStratigraphy(station_node->first_node("strat"), s); stations->push_back(s); @@ -190,7 +190,7 @@ void RapidXMLInterface::readStations(const rapidxml::xml_node<>* station_root, s } } -void RapidXMLInterface::readStratigraphy( const rapidxml::xml_node<>* strat_root, GeoLib::StationBorehole* borehole ) +void RapidStnInterface::readStratigraphy( const rapidxml::xml_node<>* strat_root, GeoLib::StationBorehole* borehole ) { double depth_check((*borehole)[2]); diff --git a/FileIO/XmlIO/RapidXMLInterface.h b/FileIO/RapidXmlIO/RapidStnInterface.h similarity index 96% rename from FileIO/XmlIO/RapidXMLInterface.h rename to FileIO/RapidXmlIO/RapidStnInterface.h index 0ba9cd598e6e12a7525cba4733d715dbf59052ab..ba8dc7be19defe5dbbb7853eb898c5835468b5c6 100644 --- a/FileIO/XmlIO/RapidXMLInterface.h +++ b/FileIO/RapidXmlIO/RapidStnInterface.h @@ -4,7 +4,7 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file RapidXMLInterface.h + * \file RapidStnInterface.h * * Created on 2012-08-16 by Karsten Rink */ @@ -27,7 +27,7 @@ namespace FileIO /** * \brief Base class for writing any information to and from XML files. */ -class RapidXMLInterface +class RapidStnInterface { public: /// Reads an xml-file using the RapidXML parser integrated in the source code (i.e. this function is usable without Qt) diff --git a/FileIO/XmlIO/VTKInterface.cpp b/FileIO/RapidXmlIO/RapidVtuInterface.cpp similarity index 87% rename from FileIO/XmlIO/VTKInterface.cpp rename to FileIO/RapidXmlIO/RapidVtuInterface.cpp index df5c7b631020b0e3198cce04de91b7cccfa1b724..f7c257d6da8b3e0c29aac6f5299ada1ce648ba4a 100644 --- a/FileIO/XmlIO/VTKInterface.cpp +++ b/FileIO/RapidXmlIO/RapidVtuInterface.cpp @@ -4,12 +4,12 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file VTKInterface.cpp + * \file RapidVtuInterface.cpp * * Created on 2012-08-30 by Karsten Rink */ -#include "VTKInterface.h" +#include "RapidVtuInterface.h" #include <iostream> #include <fstream> @@ -33,23 +33,23 @@ namespace FileIO { using namespace rapidxml; -VTKInterface::VTKInterface() +RapidVtuInterface::RapidVtuInterface() : _export_name(""), _mesh(NULL), _doc(new xml_document<>), _use_compressor(false) { } -VTKInterface::~VTKInterface() +RapidVtuInterface::~RapidVtuInterface() { delete _doc; } -MeshLib::Mesh* VTKInterface::readVTUFile(const std::string &file_name) +MeshLib::Mesh* RapidVtuInterface::readVTUFile(const std::string &file_name) { std::cout << "Reading OGS mesh ... " << std::endl; std::ifstream in(file_name.c_str()); if (in.fail()) { - std::cout << "\nVTKInterface::readVTUFile() - Can't open xml-file." << std::endl; + std::cout << "\nRapidVtuInterface::readVTUFile() - Can't open xml-file." << std::endl; return NULL; } @@ -80,7 +80,7 @@ MeshLib::Mesh* VTKInterface::readVTUFile(const std::string &file_name) } else { - std::cout << "VTKInterface::readVTUFile() - Unknown compression method." << std::endl; + std::cout << "RapidVtuInterface::readVTUFile() - Unknown compression method." << std::endl; return NULL; } } @@ -109,7 +109,7 @@ MeshLib::Mesh* VTKInterface::readVTUFile(const std::string &file_name) } } else - std::cout << "Warning in VTKInterface::readVTUFile() - MaterialID array not found." << std::endl; + std::cout << "Warning in RapidVtuInterface::readVTUFile() - MaterialID array not found." << std::endl; const rapidxml::xml_node<>* points_node (piece_node->first_node("Points")->first_node("DataArray")); @@ -130,7 +130,7 @@ MeshLib::Mesh* VTKInterface::readVTUFile(const std::string &file_name) } else { - std::cout << "Error in VTKInterface::readVTUFile() - Points array not found." << std::endl; + std::cout << "Error in RapidVtuInterface::readVTUFile() - Points array not found." << std::endl; return NULL; } @@ -169,7 +169,7 @@ MeshLib::Mesh* VTKInterface::readVTUFile(const std::string &file_name) } else { - std::cout << "Error in VTKInterface::readVTUFile() - Cell data not found." << std::endl; + std::cout << "Error in RapidVtuInterface::readVTUFile() - Cell data not found." << std::endl; return NULL; } @@ -180,7 +180,7 @@ MeshLib::Mesh* VTKInterface::readVTUFile(const std::string &file_name) return new MeshLib::Mesh(BaseLib::getFileNameFromPath(file_name), nodes, elements); } else { - std::cout << "Error in VTKInterface::readVTUFile() - Number of nodes and elements not specified." << std::endl; + std::cout << "Error in RapidVtuInterface::readVTUFile() - Number of nodes and elements not specified." << std::endl; delete [] buffer; } } @@ -188,7 +188,7 @@ MeshLib::Mesh* VTKInterface::readVTUFile(const std::string &file_name) return NULL; } -MeshLib::Element* VTKInterface::readElement(std::stringstream &iss, const std::vector<MeshLib::Node*> &nodes, unsigned material, unsigned type) +MeshLib::Element* RapidVtuInterface::readElement(std::stringstream &iss, const std::vector<MeshLib::Node*> &nodes, unsigned material, unsigned type) { unsigned node_ids[8]; switch (type) @@ -275,44 +275,44 @@ MeshLib::Element* VTKInterface::readElement(std::stringstream &iss, const std::v break; } default: - std::cout << "Error in VTKInterface::readElement() - Unknown mesh element type \"" << type << "\" ..." << std::endl; + std::cout << "Error in RapidVtuInterface::readElement() - Unknown mesh element type \"" << type << "\" ..." << std::endl; return NULL; } } -bool VTKInterface::isVTKFile(const rapidxml::xml_node<>* vtk_root) +bool RapidVtuInterface::isVTKFile(const rapidxml::xml_node<>* vtk_root) { if (vtk_root == NULL || std::string(vtk_root->name()).compare("VTKFile")) { - std::cout << "Error in VTKInterface::readVTUFile() - Not a VTK File." << std::endl; + std::cout << "Error in RapidVtuInterface::readVTUFile() - Not a VTK File." << std::endl; return false; } if (std::string(vtk_root->first_attribute("version")->value()).compare("0.1")) { - std::cout << "Error in VTKInterface::readVTUFile() - Unsupported file format version." << std::endl; + std::cout << "Error in RapidVtuInterface::readVTUFile() - Unsupported file format version." << std::endl; return false; } if (std::string(vtk_root->first_attribute("byte_order")->value()).compare("LittleEndian")) { - std::cout << "Error in VTKInterface::readVTUFile() - Only little endian files are supported." << std::endl; + std::cout << "Error in RapidVtuInterface::readVTUFile() - Only little endian files are supported." << std::endl; return false; } return true; } -bool VTKInterface::isVTKUnstructuredGrid(const rapidxml::xml_node<>* vtk_root) +bool RapidVtuInterface::isVTKUnstructuredGrid(const rapidxml::xml_node<>* vtk_root) { if (isVTKFile(vtk_root)) { if (std::string(vtk_root->first_node()->name()).compare("UnstructuredGrid") == 0) return true; - std::cout << "Error in VTKInterface::readVTUFile() - Not an unstructured grid." << std::endl; + std::cout << "Error in RapidVtuInterface::readVTUFile() - Not an unstructured grid." << std::endl; } return false; } -unsigned char* VTKInterface::uncompressData(const rapidxml::xml_node<>* node) +unsigned char* RapidVtuInterface::uncompressData(const rapidxml::xml_node<>* node) { rapidxml::xml_node<>* data_node = node->first_node("AppendedData"); char* compressed_data (NULL); @@ -324,7 +324,7 @@ unsigned char* VTKInterface::uncompressData(const rapidxml::xml_node<>* node) -int VTKInterface::write(std::ostream& stream) +int RapidVtuInterface::write(std::ostream& stream) { //if (this->_export_name.empty()) if (!_mesh) @@ -423,7 +423,7 @@ int VTKInterface::write(std::ostream& stream) return 1; } -unsigned VTKInterface::getVTKElementID(MshElemType::type type) const +unsigned RapidVtuInterface::getVTKElementID(MshElemType::type type) const { switch (type) { @@ -446,7 +446,7 @@ unsigned VTKInterface::getVTKElementID(MshElemType::type type) const } } -xml_node<>* VTKInterface::addDataArray(const std::string &name, const std::string &data_type, const std::string &data, unsigned nComponents) +xml_node<>* RapidVtuInterface::addDataArray(const std::string &name, const std::string &data_type, const std::string &data, unsigned nComponents) { xml_attribute<> *attr (NULL); diff --git a/FileIO/XmlIO/VTKInterface.h b/FileIO/RapidXmlIO/RapidVtuInterface.h similarity index 96% rename from FileIO/XmlIO/VTKInterface.h rename to FileIO/RapidXmlIO/RapidVtuInterface.h index 6127937d16561d54d60f343c86be79ce205cf244..5a341a4405ee9783c1423d05aaf89336bb7db4f7 100644 --- a/FileIO/XmlIO/VTKInterface.h +++ b/FileIO/RapidXmlIO/RapidVtuInterface.h @@ -38,11 +38,11 @@ namespace FileIO * of copies of strings, i.e. strings used in the DOM tree need to be available as long the DOM tree * is needed. */ -class VTKInterface : public Writer +class RapidVtuInterface : public Writer { public: - VTKInterface(); - ~VTKInterface(); + RapidVtuInterface(); + ~RapidVtuInterface(); /// Read an unstructured grid from a VTU file static MeshLib::Mesh* readVTUFile(const std::string &file_name); @@ -58,7 +58,7 @@ protected: rapidxml::xml_node<>* addDataArray(const std::string &name, const std::string &data_type, const std::string &data, unsigned nComponents = 1); int write(std::ostream& stream); - + std::string _export_name; MeshLib::Mesh* _mesh; rapidxml::xml_document<> *_doc; diff --git a/FileIO/readMeshFromFile.cpp b/FileIO/readMeshFromFile.cpp index a5027db1ad15f7d65536162e15e68c7549e10a5f..ad817c8a210bb12aeb2902d24f53addb014d23c4 100644 --- a/FileIO/readMeshFromFile.cpp +++ b/FileIO/readMeshFromFile.cpp @@ -13,7 +13,7 @@ #include "readMeshFromFile.h" #include "StringTools.h" #include "Mesh.h" -#include "XmlIO/VTKInterface.h" +#include "RapidXmlIO/RapidVtuInterface.h" #include "Legacy/MeshIO.h" namespace FileIO { @@ -29,7 +29,7 @@ MeshLib::Mesh* readMeshFromFile(const std::string &file_name) mesh = meshIO.loadMeshFromFile(file_name); } else if (suffix.compare("vtu") == 0 || suffix.compare("VTU") == 0) - mesh = FileIO::VTKInterface::readVTUFile(file_name); + mesh = FileIO::RapidVtuInterface::readVTUFile(file_name); else std::cout << "Unknown mesh file format" << std::endl; diff --git a/Gui/DataView/DataView.cpp b/Gui/DataView/DataView.cpp index 60342a3a436731a5a4ac40536d893b9cb576751d..d60a4d7e59f1b8b2e985e57f8a8658b22772387c 100644 --- a/Gui/DataView/DataView.cpp +++ b/Gui/DataView/DataView.cpp @@ -26,7 +26,7 @@ #include <QSettings> #include "Legacy/MeshIO.h" -#include "XmlIO/VTKInterface.h" +#include "RapidXmlIO/RapidVtuInterface.h" #include "Writer.h" // necessary to avoid Linker Error in Windows DataView::DataView( QWidget* parent /*= 0*/ ) @@ -140,7 +140,7 @@ int DataView::writeMeshToFile() const QFileInfo fi(fileName); if (fi.suffix().toLower() == "vtu") { - FileIO::VTKInterface vtkIO; + FileIO::RapidVtuInterface vtkIO; vtkIO.setMesh(mesh); vtkIO.writeToFile(fileName.toStdString().c_str()); } diff --git a/Gui/VtkVis/VtkVisPipeline.cpp b/Gui/VtkVis/VtkVisPipeline.cpp index c3b0819353f61fc162d12b8138cb1a2a5acac3e9..e9a42d86e58c23c97787cc24f9308637a76f35ab 100644 --- a/Gui/VtkVis/VtkVisPipeline.cpp +++ b/Gui/VtkVis/VtkVisPipeline.cpp @@ -526,7 +526,7 @@ void VtkVisPipeline::checkMeshQuality(VtkMeshSource* source, MshQualityType::typ // size_t size (static_cast<size_t>(QInputDialog::getInt(NULL, "OGS-Histogram", "number of histogram classes/spins (min: 1, max: 10000)", static_cast<int>(nclasses), 1, 10000, 1, &ok))); // if (ok) ... - BASELIB::Histogram<double> histogram (checker->getHistogram(nclasses)); + BaseLib::Histogram<double> histogram (checker->getHistogram(nclasses)); std::ofstream out ("mesh_histogram.txt"); if (out) { out << "# histogram depicts mesh quality criterion " << MshQualityType2String(t) diff --git a/Gui/mainwindow.cpp b/Gui/mainwindow.cpp index 4ba7fe73bee7cfb1e4f69fc3cfbbaa69b17b9626..f3b39a758f004702224ec247920614169f8699ec 100644 --- a/Gui/mainwindow.cpp +++ b/Gui/mainwindow.cpp @@ -63,7 +63,7 @@ #include "MeshIO/GMSHInterface.h" #include "MeshIO/TetGenInterface.h" #include "PetrelInterface.h" -#include "XmlIO/VTKInterface.h" +#include "RapidXmlIO/RapidVtuInterface.h" #include "XmlIO/XmlCndInterface.h" #include "XmlIO/XmlGmlInterface.h" #include "XmlIO/XmlGspInterface.h" diff --git a/MeshLib/MeshQuality/MeshQualityChecker.cpp b/MeshLib/MeshQuality/MeshQualityChecker.cpp index 2c6c88694da1626234876121db81c43a11d1a261..83fad02943f17e26d7cdbe5b0db4fb56d7cdbc56 100644 --- a/MeshLib/MeshQuality/MeshQualityChecker.cpp +++ b/MeshLib/MeshQuality/MeshQualityChecker.cpp @@ -24,14 +24,14 @@ MeshQualityChecker::MeshQualityChecker(Mesh const* const mesh) : _mesh_quality_measure.resize (_mesh->getNElements(), -1.0); } -BASELIB::Histogram<double> MeshQualityChecker::getHistogram (size_t nclasses) const +BaseLib::Histogram<double> MeshQualityChecker::getHistogram (size_t nclasses) const { if (nclasses == 0) { // simple suggestion: number of classes with Sturges criterion nclasses = static_cast<size_t>(1 + 3.3 * log (static_cast<float>((_mesh->getNElements())))); } - return BASELIB::Histogram<double>(getMeshQuality(), nclasses, true); + return BaseLib::Histogram<double>(getMeshQuality(), nclasses, true); } void MeshQualityChecker::errorMsg (const Element* elem, size_t idx) const diff --git a/MeshLib/MeshQuality/MeshQualityChecker.h b/MeshLib/MeshQuality/MeshQualityChecker.h index 66e9c0dce28ad1935fd3900c12d963ce99c1a2fb..e4cbcaa27ec9e66d1f05094585f61784891ab99e 100644 --- a/MeshLib/MeshQuality/MeshQualityChecker.h +++ b/MeshLib/MeshQuality/MeshQualityChecker.h @@ -36,7 +36,7 @@ public: std::vector<double> const& getMeshQuality () const; double getMinValue() const; double getMaxValue() const; - virtual BASELIB::Histogram<double> getHistogram (std::size_t nclasses = 0) const; + virtual BaseLib::Histogram<double> getHistogram (std::size_t nclasses = 0) const; protected: void errorMsg (const Element* elem, std::size_t idx) const; diff --git a/README.md b/README.md index c68f6f79df791a807d11e7d1af182835f426ad36..63a9eced130c61d9a12d269c474f42b44120b0e2 100644 --- a/README.md +++ b/README.md @@ -27,5 +27,5 @@ publications. See the [LICENSE.txt][license-source] for the license text. [ogs]: http://www.opengeosys.com [devguide]: http://ufz.github.com/devguide [jenkins-ci]: https://svn.ufz.de/hudson/job/OGS-6/ -[docs]: https://svn.ufz.de/hudson/view/OGS-6/job/OGS-6-Docs/lastSuccessfulBuild/artifact/build/docs/index.html +[docs]: https://svn.ufz.de/hudson/job/OGS-6/job/Docs/lastSuccessfulBuild/artifact/build/docs/index.html [license-source]: https://github.com/ufz/ogs/blob/master/LICENSE.txt diff --git a/SimpleTests/MeshTests/CMakeLists.txt b/SimpleTests/MeshTests/CMakeLists.txt index 50a0aa50cd68e5be5dbaa0f356d91a42805d8f89..f266d6e6e49289862b71f3542d86c4869f35af98 100644 --- a/SimpleTests/MeshTests/CMakeLists.txt +++ b/SimpleTests/MeshTests/CMakeLists.txt @@ -12,26 +12,22 @@ INCLUDE_DIRECTORIES( ${CMAKE_SOURCE_DIR}/MeshLib/ ) -IF(VTK_FOUND) - INCLUDE( ${VTK_USE_FILE} ) - - # Create the executable - ADD_EXECUTABLE( MeshRead - MeshRead.cpp - ${SOURCES} - ${HEADERS} - ) +# Create the executable +ADD_EXECUTABLE( MeshRead + MeshRead.cpp + ${SOURCES} + ${HEADERS} +) - TARGET_LINK_LIBRARIES ( MeshRead - MeshLib - FileIO - MathLib - BaseLib - GeoLib - logog - ${ADDITIONAL_LIBS} - ) -ENDIF() +TARGET_LINK_LIBRARIES ( MeshRead + MeshLib + FileIO + MathLib + BaseLib + GeoLib + logog + ${ADDITIONAL_LIBS} +) # Create CollapseMeshNodes executable ADD_EXECUTABLE( CollapseMeshNodes diff --git a/SimpleTests/MeshTests/MeshRead.cpp b/SimpleTests/MeshTests/MeshRead.cpp index bb0bcf2e3097d5dd5ac623335c3177d8a555b652..dc14c0fac49158fd10b1891c8806b64a03aaa7d4 100644 --- a/SimpleTests/MeshTests/MeshRead.cpp +++ b/SimpleTests/MeshTests/MeshRead.cpp @@ -15,7 +15,7 @@ #include "logog.hpp" // FileIO -#include "XmlIO/VTKInterface.h" +#include "RapidXmlIO/RapidVtuInterface.h" #include "Legacy/MeshIO.h" // MeshLib @@ -57,7 +57,7 @@ int main(int argc, char *argv[]) if (BaseLib::getSuffixFromPath(fname).compare("msh") == 0) { mesh = mesh_io.loadMeshFromFile(fname); } else { - mesh = FileIO::VTKInterface::readVTUFile(fname); + mesh = FileIO::RapidVtuInterface::readVTUFile(fname); } #ifndef WIN32 unsigned long mem_with_mesh (mem_watch.getVirtMemUsage()); diff --git a/scripts/docs/Doxyfile.in b/scripts/docs/Doxyfile.in index 02bd7fb7931b0fe84e3d3066d8a4d95f5955d27e..aa1990dae95f50adfe6ee4b2ecd193e3cc3776b2 100644 --- a/scripts/docs/Doxyfile.in +++ b/scripts/docs/Doxyfile.in @@ -1,14 +1,14 @@ -# Doxyfile 1.5.8 +# Doxyfile 1.8.2 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# All text after a hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") +# Values that contain spaces should be placed between quotes (" "). #--------------------------------------------------------------------------- # Project related configuration options @@ -22,10 +22,11 @@ DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. -PROJECT_NAME = "OpenGeoSys-6 source code documentation" +PROJECT_NAME = "OGS" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or @@ -33,6 +34,19 @@ PROJECT_NAME = "OpenGeoSys-6 source code documentation" PROJECT_NUMBER = ${OGS_VERSION} +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Source code documentation" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = ${PROJECT_SOURCE_DIR}/scripts/docs/OpenGeoSys-Logo.png + # 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 @@ -54,11 +68,11 @@ CREATE_SUBDIRS = YES # 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. +# Croatian, Czech, Danish, Dutch, Esperanto, 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-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English @@ -122,7 +136,9 @@ FULL_PATH_NAMES = YES # 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. +# path to strip. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. STRIP_FROM_PATH = ${CMAKE_SOURCE_DIR} @@ -136,7 +152,7 @@ STRIP_FROM_PATH = ${CMAKE_SOURCE_DIR} 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 +# (but less readable) file names. This can be useful if your file system # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO @@ -191,6 +207,13 @@ TAB_SIZE = 4 ALIASES = +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + # 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 @@ -217,22 +240,40 @@ OPTIMIZE_FOR_FORTRAN = NO 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), -# use: inc=Fortran f=C +# 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, CSharp, 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. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. EXTENSION_MAPPING = +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented classes, +# or namespaces to their corresponding documentation. Such a link can be +# prevented in individual cases by by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. + +AUTOLINK_SUPPORT = YES + # 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 +# func(std::string) {}). This also makes the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES @@ -248,12 +289,7 @@ CPP_CLI_SUPPORT = NO 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 -# methods anyway, you should set this option to 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 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 @@ -272,6 +308,22 @@ DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + # 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 @@ -288,16 +340,27 @@ TYPEDEF_HIDES_STRUCT = NO # 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. +# causing a significant performance penalty. # 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 +# a logarithmic scale so increasing the size by one will roughly 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 +# corresponding to a cache size of 2^16 = 65536 symbols. SYMBOL_CACHE_SIZE = 0 +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -314,6 +377,11 @@ EXTRACT_ALL = YES EXTRACT_PRIVATE = YES +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. @@ -336,7 +404,7 @@ EXTRACT_LOCAL_METHODS = NO # 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. +# anonymous namespaces are hidden. EXTRACT_ANON_NSPACES = NO @@ -396,6 +464,12 @@ HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. @@ -415,6 +489,16 @@ SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = 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) # the group names will appear in their defined order. @@ -431,6 +515,15 @@ SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = YES +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + # 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. @@ -461,10 +554,10 @@ GENERATE_DEPRECATEDLIST= YES 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 initial value of a variable or macro 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 +# The appearance of the initializer of individual variables and macros in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. @@ -483,7 +576,8 @@ SHOW_USED_FILES = 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 +# 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 = YES @@ -498,15 +592,25 @@ SHOW_NAMESPACES = YES 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 -# of the layout file. +# 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. To 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 +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -535,7 +639,7 @@ WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES -# This WARN_NO_PARAMDOC option can be abled to get warnings for +# The WARN_NO_PARAMDOC option can be enabled 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 @@ -588,10 +692,13 @@ INPUT_ENCODING = UTF-8 # 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 +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl -FILE_PATTERNS = *.h *.cpp *.dox +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. @@ -599,15 +706,17 @@ FILE_PATTERNS = *.h *.cpp *.dox RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should +# The EXCLUDE tag can be used to specify files and/or directories that should be # 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. +# Note that relative paths are relative to the directory from which doxygen is +# run. EXCLUDE = ${CMAKE_SOURCE_DIR}/BaseLib/logog \ ${CMAKE_SOURCE_DIR}/BaseLib/tclap -# 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 to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO @@ -661,17 +770,20 @@ IMAGE_PATH = # 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 +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be # ignored. 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: +# 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. +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = @@ -681,6 +793,14 @@ FILTER_PATTERNS = FILTER_SOURCE_FILES = NO +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- @@ -699,7 +819,7 @@ 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 -# fragments. Normal C and C++ comments will always remain visible. +# fragments. Normal C, C++ and Fortran comments will always remain visible. STRIP_CODE_COMMENTS = YES @@ -718,7 +838,8 @@ 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 -# link to the source code. Otherwise they will link to the documentation. +# link to the source code. +# Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES @@ -782,7 +903,14 @@ 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 -# standard header. +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! HTML_HEADER = @@ -794,21 +922,80 @@ 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 -# stylesheet in the HTML output directory as well, or it will be erased! +# fine-tune the look of the HTML output. If left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. HTML_STYLESHEET = ${CMAKE_SOURCE_DIR}/scripts/docs/doxygen.css +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + # 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). +# page has loaded. HTML_DYNAMIC_SECTIONS = NO +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + # 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). @@ -817,7 +1004,8 @@ HTML_DYNAMIC_SECTIONS = NO # 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. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. GENERATE_DOCSET = ${DOCS_GENERATE_DOCSET_STRING} @@ -835,6 +1023,16 @@ DOCSET_FEEDNAME = "Doxygen generated docs" DOCSET_BUNDLE_ID = org.doxygen.Project +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely +# identify the documentation publisher. This should be a reverse domain-name +# style string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + # 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) @@ -879,10 +1077,10 @@ BINARY_TOC = NO 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 -# HTML documentation. +# 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 @@ -904,20 +1102,24 @@ QHP_NAMESPACE = 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 = -# 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>. +# 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 = -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# 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>. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> +# Qt Help Project / Filter Attributes</a>. QHP_SECT_FILTER_ATTRS = @@ -928,40 +1130,61 @@ QHP_SECT_FILTER_ATTRS = 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 value YES disables it. +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. -DISABLE_INDEX = ${DOCS_DISABLE_INDEX_STRING} +GENERATE_ECLIPSEHELP = NO -# 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. +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. -ENUM_VALUES_PER_LINE = 4 +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = ${DOCS_DISABLE_INDEX_STRING} # 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 +# If the tag value is set to YES, 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. +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. GENERATE_TREEVIEW = ${DOCS_GENERATE_TREEVIEW_STRING} +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + # 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 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + # 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 @@ -970,15 +1193,60 @@ TREEVIEW_WIDTH = 250 FORMULA_FONTSIZE = 10 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax # (see http://www.mathjax.org) which uses client side Javascript for the # rendering instead of using prerendered bitmaps. Use this if you do not # have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you also need to install MathJax separately and +# output. When enabled you may also need to install MathJax separately and # configure the path to it using the MATHJAX_RELPATH option. USE_MATHJAX = YES +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -996,6 +1264,9 @@ LATEX_OUTPUT = latex # 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. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. LATEX_CMD_NAME = latex @@ -1012,7 +1283,7 @@ MAKEINDEX_CMD_NAME = makeindex 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 +# by the printer. Possible values are: a4, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide @@ -1029,6 +1300,13 @@ EXTRA_PACKAGES = LATEX_HEADER = +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + # 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 @@ -1055,6 +1333,19 @@ LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- @@ -1086,7 +1377,7 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's +# Load style sheet 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. @@ -1191,8 +1482,10 @@ GENERATE_PERLMOD = NO 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 +# 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. @@ -1229,7 +1522,7 @@ MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO # 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. +# pointed to by INCLUDE_PATH will be searched when a #include is found. SEARCH_INCLUDES = YES @@ -1259,15 +1552,15 @@ 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. -# Use the PREDEFINED tag if you want to use a different macro definition. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. 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 -# the parser if not removed. +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. SKIP_FUNCTION_MACROS = YES @@ -1275,20 +1568,18 @@ SKIP_FUNCTION_MACROS = YES # 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 ... +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. 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 = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. 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 = @@ -1321,9 +1612,8 @@ PERL_PATH = /usr/bin/perl # 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. +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. CLASS_DIAGRAMS = YES @@ -1349,14 +1639,20 @@ HIDE_UNDOC_RELATIONS = YES 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 -# containing the font. +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You 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 @@ -1365,17 +1661,16 @@ DOT_FONTNAME = FreeSans 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 -# can find it using this tag. +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. 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 -# the CLASS_DIAGRAMS tag to NO. +# CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES @@ -1397,6 +1692,15 @@ GROUP_GRAPHS = YES UML_LOOK = NO +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. @@ -1433,11 +1737,11 @@ CALL_GRAPH = ${DOCS_GENERATE_CALL_GRAPHS_STRING} CALLER_GRAPH = NO # 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. +# will generate a 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 +# If the DIRECTORY_GRAPH 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. @@ -1445,11 +1749,22 @@ GRAPHICAL_HIERARCHY = YES 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 -# If left blank png will be used. +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). DOT_IMAGE_FORMAT = png +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + # 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. @@ -1461,6 +1776,12 @@ DOT_PATH = ${DOT_TOOL_PATH_ONLY} DOTFILE_DIRS = +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_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 @@ -1507,12 +1828,3 @@ GENERATE_LEGEND = YES # the various graphs. DOT_CLEANUP = YES - -#--------------------------------------------------------------------------- -# Options related to the search engine -#--------------------------------------------------------------------------- - -# 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/OpenGeoSys-Logo.png b/scripts/docs/OpenGeoSys-Logo.png new file mode 100644 index 0000000000000000000000000000000000000000..96cec45180ac020f2d25742bef1d3c5ae3647cc0 Binary files /dev/null and b/scripts/docs/OpenGeoSys-Logo.png differ diff --git a/scripts/docs/doxygen.css b/scripts/docs/doxygen.css index e981e2c04c8b3362ccb2bd6bd2392bb5066e7cfd..c151fde3de811e449b5481f929ae97e842aa8545 100644 --- a/scripts/docs/doxygen.css +++ b/scripts/docs/doxygen.css @@ -1,43 +1,29 @@ -/* The standard CSS for doxygen - - modified by RossCairns.com -*/ +/* The standard CSS for doxygen */ body, table, div, p, dl { font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; - font-size: 12px; -} - -p, div, dl { - color:#3E3E3E; -} - -div.contents p { - - # font-family:Monaco, courier; - + font-size: 13px; + line-height: 1.3; } /* @group Heading Levels */ h1 { - margin-bottom: 10px; - font-size: 30px; - padding: 0px 0px 20px 0px ; - - border-bottom:1px dotted #E0E0E0; + font-size: 150%; +} + +.title { + font-size: 150%; + font-weight: bold; + margin: 10px 2px; } h2 { - padding-top: 30px; - font-size: 17px; - color:#42657B; - font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 120%; } h3 { - font-size: 17px; - font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 100%; } dt { @@ -80,16 +66,13 @@ span.legend { h3.version { font-size: 90%; - padding-bottom:10px; - border-bottom:1px dotted #E0E0E0; + text-align: center; } div.qindex, div.navtab{ - background-color: #e8eef2; - border: 1px solid #84b0c7; + background-color: #EBEFF6; + border: 1px solid #A3B4D7; text-align: center; - margin: 2px; - padding: 2px; } div.qindex, div.navpath { @@ -104,13 +87,13 @@ div.navtab { /* @group Link Styling */ a { - color: #153788; + color: #3D578C; font-weight: normal; text-decoration: none; } .contents a:visited { - color: #1b77c5; + color: #4665A2; } a:hover { @@ -123,9 +106,9 @@ a.qindex { a.qindexHL { font-weight: bold; - background-color: #6666cc; + background-color: #9CAFD4; color: #ffffff; - border: 1px double #9295C2; + border: 1px double #869DCA; } .contents a.qindexHL:visited { @@ -139,12 +122,12 @@ a.el { a.elRef { } -a.code { - color: #3030f0; +a.code, a.code:visited { + color: #4665A2; } -a.codeRef { - color: #3030f0; +a.codeRef, a.codeRef:visited { + color: #4665A2; } /* @end */ @@ -159,8 +142,8 @@ dl.el { } pre.fragment { - border: 1px solid #CCCCCC; - background-color: #f5f5f5; + border: 1px solid #C4CFE5; + background-color: #FBFCFD; padding: 4px 6px; margin: 4px 8px 4px 2px; overflow: auto; @@ -174,13 +157,22 @@ div.ah { font-weight: bold; color: #ffffff; margin-bottom: 3px; - margin-top: 3px + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); } div.groupHeader { margin-left: 16px; margin-top: 12px; - margin-bottom: 6px; font-weight: bold; } @@ -189,36 +181,37 @@ div.groupText { font-style: italic; } -div.headertitle div { - padding-top: 20px; - font-size: 20px; - font-weiht: bold; -} - body { - background: white; + background-color: white; color: black; - margin-right: 20px; - margin-left: 20px; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 8px; + margin-right: 8px; } td.indexkey { - background-color: #F1F5F9; + background-color: #EBEFF6; font-weight: bold; - border: 1px solid #CCCCCC; + border: 1px solid #C4CFE5; margin: 2px 0px 2px 0; padding: 2px 10px; + white-space: nowrap; + vertical-align: top; } td.indexvalue { - background-color: #F1F5F9; - border: 1px solid #CCCCCC; + background-color: #EBEFF6; + border: 1px solid #C4CFE5; padding: 2px 10px; margin: 2px 0px; } tr.memlist { - background-color: #f0f0f0; + background-color: #EEF1F7; } p.formulaDsp { @@ -244,6 +237,11 @@ div.center img { border: 0px; } +address.footer { + text-align: right; + padding-right: 12px; +} + img.footer { border: 0px; vertical-align: middle; @@ -295,8 +293,16 @@ span.vhdllogic { color: #ff0000 } +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + /* @end */ +/* .search { color: #003399; font-weight: bold; @@ -311,8 +317,9 @@ input.search { font-size: 75%; color: #000080; font-weight: normal; - background-color: #F1F5F9; + background-color: #e8eef2; } +*/ td.tiny { font-size: 75%; @@ -321,26 +328,35 @@ td.tiny { .dirtab { padding: 4px; border-collapse: collapse; - border: 1px solid #84b0c7; + border: 1px solid #A3B4D7; } th.dirtab { - background: #F1F5F9; + background: #EBEFF6; font-weight: bold; } hr { - height: 0; + height: 0px; border: none; - border-top: 1px solid #666; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; } /* @group Member Descriptions */ +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + .mdescLeft, .mdescRight, .memItemLeft, .memItemRight, .memTemplItemLeft, .memTemplItemRight, .memTemplParams { - background-color: #FAFAFA; + background-color: #F9FAFC; border: none; margin: 4px; padding: 1px 0 0 8px; @@ -352,16 +368,19 @@ hr { } .memItemLeft, .memItemRight, .memTemplParams { - border-top: 1px solid #ccc; - background-color: #F9F9F9; + border-top: 1px solid #C4CFE5; } .memItemLeft, .memTemplItemLeft { white-space: nowrap; } +.memItemRight { + width: 100%; +} + .memTemplParams { - color: #606060; + color: #4665A2; white-space: nowrap; } @@ -373,51 +392,92 @@ hr { .memtemplate { font-size: 80%; - color: #606060; + color: #4665A2; font-weight: normal; - margin-left: 3px; + margin-left: 9px; } .memnav { - background-color: #F1F5F9; - border: 1px solid #84b0c7; + background-color: #EBEFF6; + border: 1px solid #A3B4D7; text-align: center; margin: 2px; margin-right: 15px; padding: 2px; } +.mempage { + width: 100%; +} + .memitem { padding: 0; - margin-bottom: 30px; + margin-bottom: 10px; + margin-right: 5px; } .memname { - white-space: nowrap; - font-weight: bold; - color:#42657B; - padding:3px 5px; -} - -.memproto, .memdoc { - border: 1px dotted #E0E0E0; -} - -.memproto { - padding: 0; - background-color: #F9F9F9; - font-weight: bold; + white-space: nowrap; + font-weight: bold; + margin-left: 6px; +} + +.memproto, dl.reflist dt { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 8px; + border-top-left-radius: 8px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 8px; + -moz-border-radius-topleft: 8px; + /* webkit specific markup */ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 8px; + -webkit-border-top-left-radius: 8px; + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 2px 5px; + background-color: #FBFCFD; + border-top-width: 0; + /* opera specific markup */ + border-bottom-left-radius: 8px; + border-bottom-right-radius: 8px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7); + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7)); +} +dl.reflist dt { + padding: 5px; } -.memdoc { - padding: 2px 20px 20px; - background-color: #FFFFFF; - border-top-width: 0; - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; } .paramkey { @@ -429,13 +489,35 @@ hr { } .paramname { - color: #885656; + color: #602020; white-space: nowrap; } .paramname em { font-style: normal; } +.params, .retval, .exception, .tparams { + border-spacing: 6px 2px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + + + + /* @end */ /* @group Directory (tree) */ @@ -444,7 +526,7 @@ hr { .ftvtree { font-family: sans-serif; - margin: 0.5em; + margin: 0px; } /* these are for tree view when used as main index */ @@ -452,6 +534,7 @@ hr { .directory { font-size: 9pt; font-weight: bold; + margin: 5px; } .directory h3 { @@ -529,44 +612,401 @@ proper pixel height of your image. /* @end */ +div.dynheader { + margin-top: 8px; +} + address { font-style: normal; - color: #333; + color: #2A3D61; } table.doxtable { border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; } table.doxtable td, table.doxtable th { - border: 1px solid #153788; + border: 1px solid #2D4068; padding: 3px 7px 2px; } table.doxtable th { - background-color: #254798; + background-color: #374F7F; color: #FFFFFF; font-size: 110%; padding-bottom: 4px; padding-top: 5px; - text-align:left; } +table.fieldtable { + width: 100%; + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} -hr { - border-top:1px dotted #E0E0E0; - border-bottom:1px dotted #E0E0E0; - margin-top:30px; - padding-top:10px; +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; } -.contents { - padding-top: 30px; +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; } -h1 { - margin-top:0; +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + width: 100%; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.ingroups +{ + margin-left: 5px; + font-size: 8pt; + padding-left: 5px; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 7px; +} + +dl +{ + padding: 0 0 0 10px; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section +{ + border-left:4px solid; + padding: 0 0 0 6px; +} + +dl.note +{ + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + border-color: #00D000; +} + +dl.deprecated +{ + border-color: #505050; +} + +dl.todo +{ + border-color: #00C0E0; +} + +dl.test +{ + border-color: #3030E0; +} + +dl.bug +{ + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectname +{ + font: 300% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 120% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; } -.contents .dynsection { - margin-top:10px; + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #90A5CE; } + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 20px 10px 10px; + width: 200px; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } + pre.fragment + { + overflow: visible; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + } +} + diff --git a/scripts/docs/tabs.css b/scripts/docs/tabs.css index 3557a2cd5a0b5262a93d195ff4f202093011e3b6..21920562a831f80ad5df7d913b1d3d64db994510 100644 --- a/scripts/docs/tabs.css +++ b/scripts/docs/tabs.css @@ -1,138 +1,59 @@ -/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ - -div.navigation { - display:block; - float:left; - clear:both; - width:100%; - padding-top:10px; - padding-bottom:30px; - border-bottom:1px dotted #E0E0E0; - height: 60px; - background:url(background_navigation.png); -} - -div.contents { - float:left; - clear:both; - -} - -address { - display:none; -} - -DIV.tabs, DIV.tabs2 -{ - float : left; - width : 100%; - margin-bottom : 4px; -} - -DIV.tabs UL, DIV.tabs2 UL -{ - margin : 0px; - padding-left : 0px; - list-style : none; +.tabs, .tabs2, .tabs3 { + background-image: url('tab_b.png'); + width: 100%; + z-index: 101; + font-size: 13px; } -DIV.tabs LI, DIV.tabs FORM, , DIV.tabs2 LI, DIV.tabs2 FORM -{ - display : inline; - margin : 0px; - padding : 0px; - background-color:#FFFFFF; +.tabs2 { + font-size: 10px; } - -DIV.tabs FORM, DIV.tabs2 FORM -{ - float : right; -} - -DIV.tabs A -{ - float : left; - font-size : 120%; - font-weight : bold; - text-decoration : none; +.tabs3 { + font-size: 9px; } -DIV.tabs2 A -{ - float : left; - font-size : 100%; - font-weight : bold; - text-decoration : none; +.tablist { + margin: 0; + padding: 0; + display: table; } -DIV.tabs A:hover, DIV.tabs2 A:hover -{ - background-position: 100% -150px; +.tablist li { + float: left; + display: table-cell; + background-image: url('tab_b.png'); + line-height: 36px; + list-style: none; } -DIV.tabs A:link, DIV.tabs A:visited, -DIV.tabs A:active, DIV.tabs A:hover, -DIV.tabs2 A:link, DIV.tabs2 A:visited, -DIV.tabs2 A:active, DIV.tabs2 A:hover -{ - color: #1A419D; -} - -DIV.tabs SPAN, DIV.tabs2 SPAN -{ - float : left; - display : block; - padding : 5px 9px; - white-space : nowrap; - border-top:1px dotted #E0E0E0; - border-bottom:1px dotted #E0E0E0; -} - -DIV.tabs #MSearchBox, DIV.tabs2 #MSearchBox -{ - float : right; - display : inline; - font-size : 1em; -} - -DIV.tabs TD, DIV.tabs2 TD -{ - font-size : 80%; - font-weight : bold; - text-decoration : none; -} - - - -/* Commented Backslash Hack hides rule from IE5-Mac \*/ -DIV.tabs SPAN {float : none;} -/* End IE5-Mac hack */ - -DIV.tabs A:hover SPAN -{ - background-position: 0% -150px; +.tablist a { + display: block; + padding: 0 20px; + font-weight: bold; + background-image:url('tab_s.png'); + background-repeat:no-repeat; + background-position:right; + color: #283A5D; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; + outline: none; } -DIV.tabs LI.current A -{ - background-position: 100% -150px; - border-width : 0px; - background-color: #F0F0F0; - background: #F0F0F0 url(img_downArrow.png) center bottom no-repeat; +.tabs3 .tablist a { + padding: 0 10px; } -DIV.tabs LI.current SPAN -{ - background-position: 0% -150px; - padding-bottom : 6px; +.tablist a:hover { + background-image: url('tab_h.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + text-decoration: none; } -DIV.navpath -{ - background : none; - border : none; - border-bottom : 1px solid #84B0C7; - text-align : center; - margin : 2px; - padding : 2px; +.tablist li.current a { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); }