From 308f11a17d04592cf9cd1f0c973d54f5d0c64c1c Mon Sep 17 00:00:00 2001 From: Lars Bilke <lars.bilke@ufz.de> Date: Wed, 17 Apr 2013 14:48:49 +0200 Subject: [PATCH] Better doxygen comments. This fixes #37. --- FileIO/RapidXmlIO/zLibDataCompressor.cpp | 3 --- FileIO/RapidXmlIO/zLibDataCompressor.h | 3 --- Gui/Vrpn/QSpaceNavigatorClient.cpp | 8 +++++--- Gui/Vrpn/QSpaceNavigatorClient.h | 8 +++++--- Gui/Vrpn/QVrpnArtTrackingClient.cpp | 8 +++++--- Gui/Vrpn/QVrpnArtTrackingClient.h | 8 +++++--- Gui/Vrpn/TrackingSettingsWidget.cpp | 8 +++++--- Gui/Vrpn/TrackingSettingsWidget.h | 8 +++++--- Gui/Vrpn/VrpnClient.cpp | 8 +++++--- Gui/Vrpn/VrpnClient.h | 8 +++++--- SimpleTests/MatrixTests/MatTestRemoveRowsCols.cpp | 11 +++++++++-- SimpleTests/MeshTests/MeshRead.cpp | 14 +++++++++++--- SimpleTests/SolverTests/GMResDiagPrecond.cpp | 12 ++++++++++-- 13 files changed, 70 insertions(+), 37 deletions(-) diff --git a/FileIO/RapidXmlIO/zLibDataCompressor.cpp b/FileIO/RapidXmlIO/zLibDataCompressor.cpp index 3a5b67bd6ed..98cac6bfcdb 100644 --- a/FileIO/RapidXmlIO/zLibDataCompressor.cpp +++ b/FileIO/RapidXmlIO/zLibDataCompressor.cpp @@ -10,9 +10,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file zLibDataCompressor.cpp - * - * Created on 2012-11-26 by Karsten Rink * Based on the vtkZLibDataCompressor-class in VTK 5.6 */ diff --git a/FileIO/RapidXmlIO/zLibDataCompressor.h b/FileIO/RapidXmlIO/zLibDataCompressor.h index 0c22c6c8fa0..33023fcc0ed 100644 --- a/FileIO/RapidXmlIO/zLibDataCompressor.h +++ b/FileIO/RapidXmlIO/zLibDataCompressor.h @@ -11,9 +11,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file zLibDataCompressor.h - * - * Created on 2012-11-26 by Karsten Rink * Based on the vtkZLibDataCompressor-class in VTK 5.6 */ diff --git a/Gui/Vrpn/QSpaceNavigatorClient.cpp b/Gui/Vrpn/QSpaceNavigatorClient.cpp index 0cd1c094252..1f77721e038 100644 --- a/Gui/Vrpn/QSpaceNavigatorClient.cpp +++ b/Gui/Vrpn/QSpaceNavigatorClient.cpp @@ -1,12 +1,14 @@ /** + * \file + * \author Lars Bilke + * \date 2010-08-31 + * + * \copyright * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file QSpaceNavigatorClient.cpp - * - * Created on 2010-08-31 by Lars Bilke */ // ** INCLUDES ** diff --git a/Gui/Vrpn/QSpaceNavigatorClient.h b/Gui/Vrpn/QSpaceNavigatorClient.h index ac84dd8c863..468bd6f8064 100644 --- a/Gui/Vrpn/QSpaceNavigatorClient.h +++ b/Gui/Vrpn/QSpaceNavigatorClient.h @@ -1,12 +1,14 @@ /** + * \file + * \author Lars Bilke + * \date 2010-08-31 + * + * \copyright * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file QSpaceNavigatorClient.h - * - * Created on 2010-08-31 by Lars Bilke */ #ifndef QSPACENAVIGATORCLIENT_H diff --git a/Gui/Vrpn/QVrpnArtTrackingClient.cpp b/Gui/Vrpn/QVrpnArtTrackingClient.cpp index 3825748b719..91c7cd2e71b 100644 --- a/Gui/Vrpn/QVrpnArtTrackingClient.cpp +++ b/Gui/Vrpn/QVrpnArtTrackingClient.cpp @@ -1,12 +1,14 @@ /** + * \file + * \author Lars Bilke + * \date 2010-08-31 + * + * \copyright * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file QVrpnArtTrackingClient.cpp - * - * Created on 2010-09-03 by Lars Bilke */ // ** INCLUDES ** diff --git a/Gui/Vrpn/QVrpnArtTrackingClient.h b/Gui/Vrpn/QVrpnArtTrackingClient.h index f2322067bbb..cef8921b893 100644 --- a/Gui/Vrpn/QVrpnArtTrackingClient.h +++ b/Gui/Vrpn/QVrpnArtTrackingClient.h @@ -1,12 +1,14 @@ /** + * \file + * \author Lars Bilke + * \date 2010-08-31 + * + * \copyright * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file QVrpnArtTrackingClient.h - * - * Created on 2010-09-03 by Lars Bilke */ #ifndef QVRPNARTTRACKINGCLIENT_H diff --git a/Gui/Vrpn/TrackingSettingsWidget.cpp b/Gui/Vrpn/TrackingSettingsWidget.cpp index cbaea1183af..b44477685ca 100644 --- a/Gui/Vrpn/TrackingSettingsWidget.cpp +++ b/Gui/Vrpn/TrackingSettingsWidget.cpp @@ -1,12 +1,14 @@ /** + * \file + * \author Lars Bilke + * \date 2010-08-31 + * + * \copyright * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file TrackingSettingsWidget.cpp - * - * Created on 2010-09-06 by Lars Bilke */ // ** INCLUDES ** diff --git a/Gui/Vrpn/TrackingSettingsWidget.h b/Gui/Vrpn/TrackingSettingsWidget.h index 9635d3fb52e..f7f553ccf6b 100644 --- a/Gui/Vrpn/TrackingSettingsWidget.h +++ b/Gui/Vrpn/TrackingSettingsWidget.h @@ -1,12 +1,14 @@ /** + * \file + * \author Lars Bilke + * \date 2010-08-31 + * + * \copyright * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file TrackingSettingsWidget.h - * - * Created on 2010-09-06 by Lars Bilke */ #ifndef TRACKINGSETTINGSWIDGET_H diff --git a/Gui/Vrpn/VrpnClient.cpp b/Gui/Vrpn/VrpnClient.cpp index 500dcb5ed9e..c4502682497 100644 --- a/Gui/Vrpn/VrpnClient.cpp +++ b/Gui/Vrpn/VrpnClient.cpp @@ -1,12 +1,14 @@ /** + * \file + * \author Lars Bilke + * \date 2010-08-31 + * + * \copyright * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file VrpnClient.cpp - * - * Created on 2010-08-30 by Lars Bilke */ // ** INCLUDES ** diff --git a/Gui/Vrpn/VrpnClient.h b/Gui/Vrpn/VrpnClient.h index 60b34375ab5..443df6a0587 100644 --- a/Gui/Vrpn/VrpnClient.h +++ b/Gui/Vrpn/VrpnClient.h @@ -1,12 +1,14 @@ /** + * \file + * \author Lars Bilke + * \date 2010-08-31 + * + * \copyright * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.net/LICENSE.txt * - * \file VrpnClient.h - * - * Created on 2010-08-30 by Lars Bilke */ #ifndef VRPNCLIENT_H diff --git a/SimpleTests/MatrixTests/MatTestRemoveRowsCols.cpp b/SimpleTests/MatrixTests/MatTestRemoveRowsCols.cpp index 8b3cc72dd65..7200b5649dc 100644 --- a/SimpleTests/MatrixTests/MatTestRemoveRowsCols.cpp +++ b/SimpleTests/MatrixTests/MatTestRemoveRowsCols.cpp @@ -1,7 +1,14 @@ /** - * MatTestRemoveRowsCols.cpp + * \file + * \author Thomas Fischer + * \date 2011-11-08 + * \brief Test for removing entries in matrices. * - * Created on 2011-11-08 by Thomas Fischer + * \copyright + * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.org/project/license */ #include <fstream> diff --git a/SimpleTests/MeshTests/MeshRead.cpp b/SimpleTests/MeshTests/MeshRead.cpp index 4a1c9dcb62c..836f3e301b2 100644 --- a/SimpleTests/MeshTests/MeshRead.cpp +++ b/SimpleTests/MeshTests/MeshRead.cpp @@ -1,7 +1,15 @@ -/* - * MeshRead.cpp +/** + * \file + * \author Karsten Rink + * \date 2012/05/09 + * \brief Test for reading meshes. + * + * \copyright + * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.org/project/license * - * Created on 2012/05/09 by Karsten Rink */ // BaseLib diff --git a/SimpleTests/SolverTests/GMResDiagPrecond.cpp b/SimpleTests/SolverTests/GMResDiagPrecond.cpp index cd4c963cb4f..3aecc50d400 100644 --- a/SimpleTests/SolverTests/GMResDiagPrecond.cpp +++ b/SimpleTests/SolverTests/GMResDiagPrecond.cpp @@ -1,7 +1,15 @@ /** - * GMResDiagPrecond.cpp + * \file + * \author Thomas Fischer + * \date 2011-10-05 + * \brief Test for GMRes preconditioner. + * + * \copyright + * Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.org/project/license * - * Created on 2011-10-05 by Thomas Fischer */ #include <iostream> -- GitLab