diff --git a/src/Mod/Fem/femguiobjects/FemSelectionWidgets.py b/src/Mod/Fem/femguiobjects/FemSelectionWidgets.py index f36e5033ee..5648f210f9 100644 --- a/src/Mod/Fem/femguiobjects/FemSelectionWidgets.py +++ b/src/Mod/Fem/femguiobjects/FemSelectionWidgets.py @@ -1,7 +1,7 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * -# * Copyright (c) 2018 - Bernd Hahnebach * +# * Copyright (c) 2017 Markus Hovorka * +# * Copyright (c) 2018 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -21,11 +21,13 @@ # * * # *************************************************************************** - -__title__ = "FemSelectWidget" +__title__ = "FreeCAD FEM select widget" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## @package FemSelectWidget +# \ingroup FEM +# \brief FreeCAD FEM FemSelectWidget import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/ViewProviderFemConstraint.py b/src/Mod/Fem/femguiobjects/ViewProviderFemConstraint.py index 28aff7b7f6..3859d705fe 100644 --- a/src/Mod/Fem/femguiobjects/ViewProviderFemConstraint.py +++ b/src/Mod/Fem/femguiobjects/ViewProviderFemConstraint.py @@ -1,7 +1,7 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * -# * Copyright (c) 2018 - Bernd Hahnebach * +# * Copyright (c) 2017 Markus Hovorka * +# * Copyright (c) 2018 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -21,11 +21,13 @@ # * * # *************************************************************************** - -__title__ = "_Base ViewProvider" +__title__ = "FreeCAD FEM base constraint ViewProvider" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## @package _BaseViewProvider +# \ingroup FEM +# \brief FreeCAD _Base ViewProvider for FEM workbench import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_TaskPanelFemSolverControl.py b/src/Mod/Fem/femguiobjects/_TaskPanelFemSolverControl.py index 7d8e6b446a..c64d821a89 100644 --- a/src/Mod/Fem/femguiobjects/_TaskPanelFemSolverControl.py +++ b/src/Mod/Fem/femguiobjects/_TaskPanelFemSolverControl.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,12 @@ # * * # *************************************************************************** - -__title__ = "Solver Job Control Task Panel" +__title__ = "FreeCAD FEM solver job control task panel" __author__ = "Markus Hovorka" __url__ = "http://www.freecadweb.org" +## \addtogroup FEM +# @{ from PySide import QtCore from PySide import QtGui @@ -334,3 +335,5 @@ class ControlWidget(QtGui.QWidget): self._editBtt.setDisabled( not machine.solver.Proxy.editSupported() or machine.state < femsolver.run.PREPARE) + +## @} diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintBodyHeatSource.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintBodyHeatSource.py index 93e0fb6724..81d520888a 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintBodyHeatSource.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintBodyHeatSource.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,12 @@ # * * # *************************************************************************** - -__title__ = "view provider for constraint body heat source object" +__title__ = "FreeCAD FEM constraint body heat source ViewProvider for the document object" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## \addtogroup FEM +# @{ from . import ViewProviderFemConstraint @@ -33,3 +34,5 @@ class ViewProxy(ViewProviderFemConstraint.ViewProxy): def getIcon(self): return ":/icons/fem-constraint-heatflux.svg" + +## @} diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintElectrostaticPotential.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintElectrostaticPotential.py index da3e58670a..3b88d48121 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintElectrostaticPotential.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintElectrostaticPotential.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,13 @@ # * * # *************************************************************************** - -__title__ = "view provider for constraint electrostatic potential object" +__title__ = "FreeCAD FEM constraint electrostatic potential ViewProvider for the document object" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## @package ViewProviderFemConstraintElctrostaticPotential +# \ingroup FEM +# \brief FreeCAD FEM view provider for constraint electrostatic potential object import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintFlowVelocity.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintFlowVelocity.py index 45ac4f6bc3..09c9be5186 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintFlowVelocity.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintFlowVelocity.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,13 @@ # * * # *************************************************************************** - -__title__ = "view provider for constraint flow velocity object" +__title__ = "FreeCAD FEM constraint flow velocity ViewProvider for the document object" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## @package ViewProviderFemConstraintFlowVelocity +# \ingroup FEM +# \brief FreeCAD FEM view provider for constraint flow velocity object import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintInitialFlowVelocity.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintInitialFlowVelocity.py index c60af2fe67..56fee11e92 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintInitialFlowVelocity.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintInitialFlowVelocity.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,13 @@ # * * # *************************************************************************** - -__title__ = "view provider for constraint initial flow velocity object" +__title__ = "FreeCAD FEM constraint initial flow velocity ViewProvider for the document object" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## @package ViewProviderFemConstraintInitialFlowVelocity +# \ingroup FEM +# \brief FreeCAD FEM view provider for constraint initial flow velocity object import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintSelfWeight.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintSelfWeight.py index caf9e8fdfe..b68cc5c02a 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintSelfWeight.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemConstraintSelfWeight.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemConstraintSelfWeight" +__title__ = "FreeCAD FEM constraint self weight ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemConstraintSelfWeight # \ingroup FEM +# \brief FreeCAD FEM Constraint SelfWeight ViewProvider import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemElementFluid1D.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemElementFluid1D.py index e54f0a3dd4..ec1c2d1f51 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemElementFluid1D.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemElementFluid1D.py @@ -1,8 +1,8 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Ofentse Kgoa * +# * Copyright (c) 2016 Ofentse Kgoa * +# * Copyright (c) 2018 Bernd Hahnebach * # * Based on the FemElementGeometry1D by Bernd Hahnebach * -# * Copyright (c) 2018 - Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -22,12 +22,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemElementFluid1D" +__title__ = "FreeCAD FEM element fluid 1D ViewProvider for the document object" __author__ = "Ofentse Kgoa, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemElementFluid1D # \ingroup FEM +# \brief FreeCAD ViewProviderFemElementFluid1D import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemElementGeometry1D.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemElementGeometry1D.py index 69d97e361f..994fe1235a 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemElementGeometry1D.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemElementGeometry1D.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2015 - Bernd Hahnebach * +# * Copyright (c) 2015 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemElementGeometry1D" +__title__ = "FreeCAD FEM element geometry 1D ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemElementGeometry1D # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemElementGeometry1D import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemElementGeometry2D.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemElementGeometry2D.py index 515084086f..af9948ed28 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemElementGeometry2D.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemElementGeometry2D.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2015 - Bernd Hahnebach * +# * Copyright (c) 2015 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemElementGeometry2D" +__title__ = "FreeCAD FEM element geometry 2D ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemElementGeometry2D # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemElementGeometry2D import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemElementRotation1D.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemElementRotation1D.py index dbe1771303..0507e0d095 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemElementRotation1D.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemElementRotation1D.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Bernd Hahnebach * +# * Copyright (c) 2017 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemElementRotation1D" +__title__ = "FreeCAD FEM element rotation 1D ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemElementRotation1D # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemElementRotation1D import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemMaterial.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemMaterial.py index ea7c9e4552..43b36f88e8 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemMaterial.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemMaterial.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2013 - Juergen Riegel * +# * Copyright (c) 2013 Jürgen Riegel * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemMaterial" +__title__ = "FreeCAD FEM material ViewProvider for the document object" __author__ = "Juergen Riegel, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package _ViewProviderFemMaterial # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemMaterial import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemMaterialMechanicalNonlinear.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemMaterialMechanicalNonlinear.py index d84cb2e929..708e9f76f1 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemMaterialMechanicalNonlinear.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemMaterialMechanicalNonlinear.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemMaterialMechanicalNonlinear" +__title__ = "FreeCAD FEM material mechanical nonlinear ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemMaterialMechanicalNonLinear # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemMaterialMechanicalNonlinear import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshBoundaryLayer.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshBoundaryLayer.py index 9b86588936..33c79fb64e 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshBoundaryLayer.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshBoundaryLayer.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemMeshBoundaryLayer" +__title__ = "FreeCAD FEM mesh boundary layer ViewProvider for the document object" __author__ = "Bernd Hahnebach, Qingfeng Xia" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemMeshBoundaryLayer # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemMeshBoundaryLayer import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshGmsh.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshGmsh.py index e1e7c75212..215c771916 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshGmsh.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshGmsh.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemMeshGmsh" +__title__ = "FreeCAD FEM mesh gmsh ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemMeshGmsh # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemMeshGmsh import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshGroup.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshGroup.py index 5922583c00..871573ca2b 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshGroup.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshGroup.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemMeshGroup" +__title__ = "FreeCAD FEM mesh group ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemMeshGroup # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemMeshGroup import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshRegion.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshRegion.py index 5a6c2dd0f7..44c23c71b8 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshRegion.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshRegion.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemMeshRegion" +__title__ = "FreeCAD FEM mesh region ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemMeshRegion # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemMeshRegion import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshResult.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshResult.py index 26a1ac3684..e1c471948d 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshResult.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemMeshResult.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Bernd Hahnebach * +# * Copyright (c) 2017 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemMeshResult" +__title__ = "FreeCAD FEM mesh result ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemMeshResult # \ingroup FEM - +# \brief FreeCAD FEM _ViewProviderFemMeshResult class _ViewProviderFemMeshResult: "A View Provider for the FemMeshResult object" diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemResultMechanical.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemResultMechanical.py index ca5c00e8a9..30b2667717 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemResultMechanical.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemResultMechanical.py @@ -1,26 +1,26 @@ -#*************************************************************************** -#* * -#* Copyright (c) 2015 - Qingfeng Xia * -#* * -#* This program is free software; you can redistribute it and/or modify * -#* it under the terms of the GNU Lesser General Public License (LGPL) * -#* as published by the Free Software Foundation; either version 2 of * -#* the License, or (at your option) any later version. * -#* for detail see the LICENCE text file. * -#* * -#* This program is distributed in the hope that it will be useful, * -#* but WITHOUT ANY WARRANTY; without even the implied warranty of * -#* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * -#* GNU Library General Public License for more details. * -#* * -#* You should have received a copy of the GNU Library General Public * -#* License along with this program; if not, write to the Free Software * -#* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * -#* USA * -#* * -#*************************************************************************** +# *************************************************************************** +# * * +# * Copyright (c) 2015 Qingfeng Xia * +# * * +# * This program is free software; you can redistribute it and/or modify * +# * it under the terms of the GNU Lesser General Public License (LGPL) * +# * as published by the Free Software Foundation; either version 2 of * +# * the License, or (at your option) any later version. * +# * for detail see the LICENCE text file. * +# * * +# * This program is distributed in the hope that it will be useful, * +# * but WITHOUT ANY WARRANTY; without even the implied warranty of * +# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * +# * GNU Library General Public License for more details. * +# * * +# * You should have received a copy of the GNU Library General Public * +# * License along with this program; if not, write to the Free Software * +# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * +# * USA * +# * * +# *************************************************************************** -__title__ = "ViewProvider for FEM mechanical ResultObjectPython" +__title__ = "FreeCAD result mechanical ViewProvider for the document object" __author__ = "Qingfeng Xia, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" diff --git a/src/Mod/Fem/femguiobjects/_ViewProviderFemSolverCalculix.py b/src/Mod/Fem/femguiobjects/_ViewProviderFemSolverCalculix.py index 3fbd8cfea1..e1601f619d 100644 --- a/src/Mod/Fem/femguiobjects/_ViewProviderFemSolverCalculix.py +++ b/src/Mod/Fem/femguiobjects/_ViewProviderFemSolverCalculix.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2015 - Bernd Hahnebach * +# * Copyright (c) 2015 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_ViewProviderFemSolverCalculix" +__title__ = "FreeCAD FEM solver calculix ViewProvider for the document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package ViewProviderFemSolverCalculix # \ingroup FEM +# \brief FreeCAD FEM _ViewProviderFemSolverCalculix import FreeCAD import FreeCADGui diff --git a/src/Mod/Fem/femguiobjects/__init__.py b/src/Mod/Fem/femguiobjects/__init__.py index 3ef32302af..e69de29bb2 100644 --- a/src/Mod/Fem/femguiobjects/__init__.py +++ b/src/Mod/Fem/femguiobjects/__init__.py @@ -1,29 +0,0 @@ -# *************************************************************************** -# * * -# * Copyright (c) 2017 - Bernd Hahnebach * -# * * -# * This program is free software; you can redistribute it and/or modify * -# * it under the terms of the GNU Lesser General Public License (LGPL) * -# * as published by the Free Software Foundation; either version 2 of * -# * the License, or (at your option) any later version. * -# * for detail see the LICENCE text file. * -# * * -# * This program is distributed in the hope that it will be useful, * -# * but WITHOUT ANY WARRANTY; without even the implied warranty of * -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * -# * GNU Library General Public License for more details. * -# * * -# * You should have received a copy of the GNU Library General Public * -# * License along with this program; if not, write to the Free Software * -# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * -# * USA * -# * * -# *************************************************************************** - -__title__ = "Fem Gui modules" -__author__ = "Bernd Hahnebach" -__url__ = "http://www.freecadweb.org" - -## @package PyGui -# \ingroup Fem -# \brief Fem Gui module diff --git a/src/Mod/Fem/femobjects/FemConstraint.py b/src/Mod/Fem/femobjects/FemConstraint.py index 43ebe73b10..26d2918ebc 100644 --- a/src/Mod/Fem/femobjects/FemConstraint.py +++ b/src/Mod/Fem/femobjects/FemConstraint.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,12 @@ # * * # *************************************************************************** - -__title__ = "_Base" +__title__ = "FreeCAD FEM base constraint object" __author__ = "Markus Hovorka" __url__ = "http://www.freecadweb.org" +## \addtogroup FEM +# @{ class Proxy(object): @@ -32,3 +33,5 @@ class Proxy(object): def __init__(self, obj): obj.Proxy = self + +## @} diff --git a/src/Mod/Fem/femobjects/_FemConstraintBodyHeatSource.py b/src/Mod/Fem/femobjects/_FemConstraintBodyHeatSource.py index 8cadfa1905..e27820e196 100644 --- a/src/Mod/Fem/femobjects/_FemConstraintBodyHeatSource.py +++ b/src/Mod/Fem/femobjects/_FemConstraintBodyHeatSource.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,13 @@ # * * # *************************************************************************** - -__title__ = "the constraint body heat source object" +__title__ = "FreeCAD FEM constraint body heat source document object" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## @package FemConstraintBodyHeatSource +# \ingroup FEM +# \brief FreeCAD FEM constraint body heat source object from . import FemConstraint diff --git a/src/Mod/Fem/femobjects/_FemConstraintElectrostaticPotential.py b/src/Mod/Fem/femobjects/_FemConstraintElectrostaticPotential.py index 98bbe419ae..1c246d9af9 100644 --- a/src/Mod/Fem/femobjects/_FemConstraintElectrostaticPotential.py +++ b/src/Mod/Fem/femobjects/_FemConstraintElectrostaticPotential.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,13 @@ # * * # *************************************************************************** - -__title__ = "the constraint electrostatic potential object" +__title__ = "FreeCAD FEM constraint electrostatic potential document object" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## @package FemConstraintElectrostaticPotential +# \ingroup FEM +# \brief FreeCAD FEM constraint electrostatic potential object from . import FemConstraint diff --git a/src/Mod/Fem/femobjects/_FemConstraintFlowVelocity.py b/src/Mod/Fem/femobjects/_FemConstraintFlowVelocity.py index c483fb071e..3bd36edec7 100644 --- a/src/Mod/Fem/femobjects/_FemConstraintFlowVelocity.py +++ b/src/Mod/Fem/femobjects/_FemConstraintFlowVelocity.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,13 @@ # * * # *************************************************************************** - -__title__ = "the constraint flow velocity object" +__title__ = "FreeCAD FEM constraint flow velocity document object" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## @package FemConstraintFlowVelocity +# \ingroup FEM +# \brief FreeCAD FEM constraint flow velocity object from . import FemConstraint diff --git a/src/Mod/Fem/femobjects/_FemConstraintInitialFlowVelocity.py b/src/Mod/Fem/femobjects/_FemConstraintInitialFlowVelocity.py index d5e44ab10f..d3b9c63ba4 100644 --- a/src/Mod/Fem/femobjects/_FemConstraintInitialFlowVelocity.py +++ b/src/Mod/Fem/femobjects/_FemConstraintInitialFlowVelocity.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Markus Hovorka * +# * Copyright (c) 2017 Markus Hovorka * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,11 +20,14 @@ # * * # *************************************************************************** - -__title__ = "the constraint initial flow velocity object" +__title__ = "FreeCAD FEM constraint initial flow velocity document object" __author__ = "Markus Hovorka, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" +## @package FemConstraintInitialFlowVelocity +# \ingroup FEM +# \brief FreeCAD FEM constraint initial flow velocity object + from . import FemConstraint diff --git a/src/Mod/Fem/femobjects/_FemConstraintSelfWeight.py b/src/Mod/Fem/femobjects/_FemConstraintSelfWeight.py index 0006101c97..d31ddd9700 100644 --- a/src/Mod/Fem/femobjects/_FemConstraintSelfWeight.py +++ b/src/Mod/Fem/femobjects/_FemConstraintSelfWeight.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2015 - Bernd Hahnebach * +# * Copyright (c) 2015 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "the constraint self weight object" +__title__ = "FreeCAD FEM constraint self weight document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package FemConstraintSelfWeight # \ingroup FEM - +# \brief FreeCAD FEM constraint self weight object class _FemConstraintSelfWeight: "The FemConstraintSelfWeight object" diff --git a/src/Mod/Fem/femobjects/_FemElementFluid1D.py b/src/Mod/Fem/femobjects/_FemElementFluid1D.py index 242853503c..ad651e6620 100644 --- a/src/Mod/Fem/femobjects/_FemElementFluid1D.py +++ b/src/Mod/Fem/femobjects/_FemElementFluid1D.py @@ -1,7 +1,7 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Ofentse Kgoa * -# * Based on the FemElementGeometry1D by Bernd Hahnebach * +# * Copyright (c) 2016 Ofentse Kgoa * +# * Based on the FemElementGeometry1D by Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -21,13 +21,13 @@ # * * # *************************************************************************** -__title__ = "_FemElementFluid1D" +__title__ = "FreeCAD FEM _element fluid 1D document object" __author__ = "Ofentse Kgoa" __url__ = "http://www.freecadweb.org" ## @package FemElementFluid1D # \ingroup FEM - +# \brief FreeCAD FEM _FemElementFluid1D class _FemElementFluid1D: "The FemElementFluid1D object" diff --git a/src/Mod/Fem/femobjects/_FemElementGeometry1D.py b/src/Mod/Fem/femobjects/_FemElementGeometry1D.py index afb1adf55d..711cd28e8d 100644 --- a/src/Mod/Fem/femobjects/_FemElementGeometry1D.py +++ b/src/Mod/Fem/femobjects/_FemElementGeometry1D.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2015 - Bernd Hahnebach * +# * Copyright (c) 2015 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "FemElementGeometry1D" +__title__ = "FreeCAD FEM element geometry 1D document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package FemElementGeometry1D # \ingroup FEM - +# \brief FreeCAD FEM element geometry 1D object class _FemElementGeometry1D: "The FemElementGeometry1D object" diff --git a/src/Mod/Fem/femobjects/_FemElementGeometry2D.py b/src/Mod/Fem/femobjects/_FemElementGeometry2D.py index ff6d525b63..d68c2236d5 100644 --- a/src/Mod/Fem/femobjects/_FemElementGeometry2D.py +++ b/src/Mod/Fem/femobjects/_FemElementGeometry2D.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2015 - Bernd Hahnebach * +# * Copyright (c) 2015 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "_FemElementGeometry2D" +__title__ = "FreeCAD FEM element geometry 2D document object" __author__ = "Bernd Hahnebach" -__url__ = "http://www.freecadweb.org" +__url__ = "https://www.freecadweb.org" ## @package FemElementGeometry2D # \ingroup FEM - +# \brief FreeCAD FEM element geometry 2D object class _FemElementGeometry2D: "The FemElementGeometry2D object" diff --git a/src/Mod/Fem/femobjects/_FemElementRotation1D.py b/src/Mod/Fem/femobjects/_FemElementRotation1D.py index 34d88c84bf..6b84d53c65 100644 --- a/src/Mod/Fem/femobjects/_FemElementRotation1D.py +++ b/src/Mod/Fem/femobjects/_FemElementRotation1D.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Bernd Hahnebach * +# * Copyright (c) 2017 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "FemElementRotation1D" +__title__ = "FreeCAD FEM element rotation 1D document object" __author__ = "Bernd Hahnebach" -__url__ = "http://www.freecadweb.org" +__url__ = "https://www.freecadweb.org" ## @package FemElementRotation1D # \ingroup FEM - +# \brief FreeCAD FEM element rotation 1D object class _FemElementRotation1D: "The FemElementRotation1D object" diff --git a/src/Mod/Fem/femobjects/_FemMaterial.py b/src/Mod/Fem/femobjects/_FemMaterial.py index 9a3a952217..51dc9cc1c2 100644 --- a/src/Mod/Fem/femobjects/_FemMaterial.py +++ b/src/Mod/Fem/femobjects/_FemMaterial.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2013 - Juergen Riegel * +# * Copyright (c) 2013 Jürgen Riegel * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "FemMaterial" +__title__ = "FreeCAD FEM material document object" __author__ = "Juergen Riegel, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package FemMaterial # \ingroup FEM - +# \brief FEM material class _FemMaterial: "The FEM Material object" diff --git a/src/Mod/Fem/femobjects/_FemMaterialMechanicalNonlinear.py b/src/Mod/Fem/femobjects/_FemMaterialMechanicalNonlinear.py index bc0c9881c5..1c3061b3b8 100644 --- a/src/Mod/Fem/femobjects/_FemMaterialMechanicalNonlinear.py +++ b/src/Mod/Fem/femobjects/_FemMaterialMechanicalNonlinear.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "the fem nonlinear mechanical material object" +__title__ = "FreeCAD FEM material mechanical nonlinear document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package FemMaterialMechanicalNonLinear # \ingroup FEM - +# \brief FEM nonlinear mechanical material object class _FemMaterialMechanicalNonlinear: "The FemMaterialMechanicalNonlinear object" diff --git a/src/Mod/Fem/femobjects/_FemMeshBoundaryLayer.py b/src/Mod/Fem/femobjects/_FemMeshBoundaryLayer.py index 48fe799e6b..4ac91d3363 100644 --- a/src/Mod/Fem/femobjects/_FemMeshBoundaryLayer.py +++ b/src/Mod/Fem/femobjects/_FemMeshBoundaryLayer.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "_FemMeshBoundaryLayer" +__title__ = "FreeCAD FEM mesh boundary layer document object" __author__ = "Bernd Hahnebach, Qingfeng Xia" __url__ = "http://www.freecadweb.org" ## @package FemMeshBoundaryLayer # \ingroup FEM - +# \brief FEM mesh boundary layer object class _FemMeshBoundaryLayer: "The FemMeshBoundaryLayer object" diff --git a/src/Mod/Fem/femobjects/_FemMeshGmsh.py b/src/Mod/Fem/femobjects/_FemMeshGmsh.py index c35d923371..97339f6f9a 100644 --- a/src/Mod/Fem/femobjects/_FemMeshGmsh.py +++ b/src/Mod/Fem/femobjects/_FemMeshGmsh.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "_FemMeshGmsh" +__title__ = "FreeCAD FEM mesh gmsh document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package FemMeshGmsh # \ingroup FEM - +# \brief FreeCAD FEM _FemMeshGmsh class _FemMeshGmsh(): """A Fem::FemMeshObject python type, add Gmsh specific properties diff --git a/src/Mod/Fem/femobjects/_FemMeshGroup.py b/src/Mod/Fem/femobjects/_FemMeshGroup.py index 40afdf2b98..c9940fdb56 100644 --- a/src/Mod/Fem/femobjects/_FemMeshGroup.py +++ b/src/Mod/Fem/femobjects/_FemMeshGroup.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "_FemMeshGroup" +__title__ = "FreeCAD FEM mesh group document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package FemMeshGroup # \ingroup FEM - +# \brief FreeCAD FEM _FemMeshGroup class _FemMeshGroup: "The FemMeshGroup object" diff --git a/src/Mod/Fem/femobjects/_FemMeshRegion.py b/src/Mod/Fem/femobjects/_FemMeshRegion.py index b851302d31..eb5ee61658 100644 --- a/src/Mod/Fem/femobjects/_FemMeshRegion.py +++ b/src/Mod/Fem/femobjects/_FemMeshRegion.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2016 - Bernd Hahnebach * +# * Copyright (c) 2016 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "_FemMeshRegion" +__title__ = "FreeCAD FEM mesh region document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package FemMeshRegion # \ingroup FEM - +# \brief FreeCAD FEM _FemMeshRegion class _FemMeshRegion: "The FemMeshRegion object" diff --git a/src/Mod/Fem/femobjects/_FemMeshResult.py b/src/Mod/Fem/femobjects/_FemMeshResult.py index 1fd69cfc2c..0efcc59f82 100644 --- a/src/Mod/Fem/femobjects/_FemMeshResult.py +++ b/src/Mod/Fem/femobjects/_FemMeshResult.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2017 - Bernd Hahnebach * +# * Copyright (c) 2017 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,13 +20,13 @@ # * * # *************************************************************************** -__title__ = "_FemMeshResult" +__title__ = "FreeCAD FEM mesh result document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package FemMeshResult # \ingroup FEM - +# \brief FreeCAD FEM _FemMeshResult class _FemMeshResult(): """The Fem::FemMeshObject's Proxy python type, add Result specific object type diff --git a/src/Mod/Fem/femobjects/_FemResultMechanical.py b/src/Mod/Fem/femobjects/_FemResultMechanical.py index ebdcff3e6c..de933b9f75 100644 --- a/src/Mod/Fem/femobjects/_FemResultMechanical.py +++ b/src/Mod/Fem/femobjects/_FemResultMechanical.py @@ -1,26 +1,26 @@ -#*************************************************************************** -#* * -#* Copyright (c) 2016 - Qingfeng Xia * -#* * -#* This program is free software; you can redistribute it and/or modify * -#* it under the terms of the GNU Lesser General Public License (LGPL) * -#* as published by the Free Software Foundation; either version 2 of * -#* the License, or (at your option) any later version. * -#* for detail see the LICENCE text file. * -#* * -#* This program is distributed in the hope that it will be useful, * -#* but WITHOUT ANY WARRANTY; without even the implied warranty of * -#* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * -#* GNU Library General Public License for more details. * -#* * -#* You should have received a copy of the GNU Library General Public * -#* License along with this program; if not, write to the Free Software * -#* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * -#* USA * -#* * -#*************************************************************************** +# *************************************************************************** +# * * +# * Copyright (c) 2016 Qingfeng Xia * +# * * +# * This program is free software; you can redistribute it and/or modify * +# * it under the terms of the GNU Lesser General Public License (LGPL) * +# * as published by the Free Software Foundation; either version 2 of * +# * the License, or (at your option) any later version. * +# * for detail see the LICENCE text file. * +# * * +# * This program is distributed in the hope that it will be useful, * +# * but WITHOUT ANY WARRANTY; without even the implied warranty of * +# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * +# * GNU Library General Public License for more details. * +# * * +# * You should have received a copy of the GNU Library General Public * +# * License along with this program; if not, write to the Free Software * +# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * +# * USA * +# * * +# *************************************************************************** -__title__ = "DocumentOject Class to hold mechanical FEM results" +__title__ = "FreeCAD FEM result mechanical document object" __author__ = "Qingfeng Xia, Bernd Hahnebach" __url__ = "http://www.freecadweb.org" @@ -28,7 +28,6 @@ __url__ = "http://www.freecadweb.org" # \ingroup FEM # \brief FreeCAD DocumentObject class to hold mechanical results in FEM workbench - class _FemResultMechanical(): """The Fem::_FemResultMechanical's Proxy python type, add result specific properties """ diff --git a/src/Mod/Fem/femobjects/_FemSolverCalculix.py b/src/Mod/Fem/femobjects/_FemSolverCalculix.py index bb4ceee55f..3816c6d30c 100644 --- a/src/Mod/Fem/femobjects/_FemSolverCalculix.py +++ b/src/Mod/Fem/femobjects/_FemSolverCalculix.py @@ -1,6 +1,6 @@ # *************************************************************************** # * * -# * Copyright (c) 2015 - Bernd Hahnebach * +# * Copyright (c) 2015 Bernd Hahnebach * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * @@ -20,12 +20,13 @@ # * * # *************************************************************************** -__title__ = "_FemSolverCalculix" +__title__ = "FreeCAD FEM solver calculix document object" __author__ = "Bernd Hahnebach" __url__ = "http://www.freecadweb.org" ## @package FemSolverCalculix # \ingroup FEM +# \brief FreeCAD FEM _FemSolverCalculix import FreeCAD from femtools import ccxtools diff --git a/src/Mod/Fem/femobjects/__init__.py b/src/Mod/Fem/femobjects/__init__.py index 3ef32302af..e69de29bb2 100644 --- a/src/Mod/Fem/femobjects/__init__.py +++ b/src/Mod/Fem/femobjects/__init__.py @@ -1,29 +0,0 @@ -# *************************************************************************** -# * * -# * Copyright (c) 2017 - Bernd Hahnebach * -# * * -# * This program is free software; you can redistribute it and/or modify * -# * it under the terms of the GNU Lesser General Public License (LGPL) * -# * as published by the Free Software Foundation; either version 2 of * -# * the License, or (at your option) any later version. * -# * for detail see the LICENCE text file. * -# * * -# * This program is distributed in the hope that it will be useful, * -# * but WITHOUT ANY WARRANTY; without even the implied warranty of * -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * -# * GNU Library General Public License for more details. * -# * * -# * You should have received a copy of the GNU Library General Public * -# * License along with this program; if not, write to the Free Software * -# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * -# * USA * -# * * -# *************************************************************************** - -__title__ = "Fem Gui modules" -__author__ = "Bernd Hahnebach" -__url__ = "http://www.freecadweb.org" - -## @package PyGui -# \ingroup Fem -# \brief Fem Gui module