Skip to content

GitLab

Commit 8ac12679 authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 Parameters: fix some Doxygen errors induced by recent changes.

parent 0bcb4397
Hide whitespace changes
Inline Side-by-side
HappyHeart.xcodeproj/project.pbxproj
View file @ 8ac12679
......@@ -5940,7 +5940,7 @@
BE8553A81BBD77BF00DB109E /* None.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = None.hxx; sourceTree = "<group>"; };
BE85941E1DAE558A00DC23D8 /* InitParameterFromInputData.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = InitParameterFromInputData.hpp; sourceTree = "<group>"; };
BE85941F1DAE558A00DC23D8 /* InitParameterFromInputData.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = InitParameterFromInputData.hxx; sourceTree = "<group>"; };
BE8594221DAE55A800DC23D8 /* InitParameterFromInputData.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = InitParameterFromInputData.hpp; sourceTree = "<group>"; };
BE8594221DAE55A800DC23D8 /* InitParameterFromInputData.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; lineEnding = 0; path = InitParameterFromInputData.hpp; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.cpp; };
BE8594231DAE55A800DC23D8 /* InitParameterFromInputData.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = InitParameterFromInputData.hxx; sourceTree = "<group>"; };
BE8594351DAE92EC00DC23D8 /* Dispatcher.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Dispatcher.hpp; sourceTree = "<group>"; };
BE8594361DAE92EC00DC23D8 /* Dispatcher.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Dispatcher.hxx; sourceTree = "<group>"; };
......@@ -6291,7 +6291,7 @@
BEB309721DAD49ED006C8A00 /* Constant.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Constant.hxx; sourceTree = "<group>"; };
BEB309741DAD49ED006C8A00 /* OpsFunction.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = OpsFunction.hpp; sourceTree = "<group>"; };
BEB309751DAD49ED006C8A00 /* OpsFunction.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = OpsFunction.hxx; sourceTree = "<group>"; };
BEB309771DAD49ED006C8A00 /* PiecewiseConstantByDomain.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = PiecewiseConstantByDomain.hpp; sourceTree = "<group>"; };
BEB309771DAD49ED006C8A00 /* PiecewiseConstantByDomain.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; lineEnding = 0; path = PiecewiseConstantByDomain.hpp; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.cpp; };
BEB309781DAD49ED006C8A00 /* PiecewiseConstantByDomain.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = PiecewiseConstantByDomain.hxx; sourceTree = "<group>"; };
BEB5009B18DC5BA900C7EFB6 /* TAGS */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; lineEnding = 0; path = TAGS; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = "<none>"; };
BEB6424C17CF7ACF001CEE44 /* InputParameterList.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = InputParameterList.cpp; sourceTree = "<group>"; };
......@@ -6603,7 +6603,7 @@
BEEA60101DAE2CE60029F329 /* InitStoredQuantity.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = InitStoredQuantity.hpp; sourceTree = "<group>"; };
BEEA60181DAE414F0029F329 /* ParameterType.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = ParameterType.hpp; sourceTree = "<group>"; };
BEEA60191DAE414F0029F329 /* ParameterType.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = ParameterType.hxx; sourceTree = "<group>"; };
BEEA601C1DAE41990029F329 /* Parameters.doxygen */ = {isa = PBXFileReference; explicitFileType = text.script.python; fileEncoding = 4; path = Parameters.doxygen; sourceTree = "<group>"; };
BEEA601C1DAE41990029F329 /* Parameters.doxygen */ = {isa = PBXFileReference; explicitFileType = text.script.python; fileEncoding = 4; lineEnding = 0; path = Parameters.doxygen; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.python; };
BEEABA4B1A49BC8700A875C6 /* Ensight6.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Ensight6.cpp; sourceTree = "<group>"; };
BEEABA4C1A49BC8700A875C6 /* Ensight6.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Ensight6.hpp; sourceTree = "<group>"; };
BEEABA4D1A49BC8700A875C6 /* Ensight6.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Ensight6.hxx; sourceTree = "<group>"; };
Sources/Parameters/InitParameterFromInputData/InitParameterFromInputData.hpp
View file @ 8ac12679
......@@ -49,7 +49,7 @@ namespace HappyHeart
*
* \param[in] name Name of the parameter, as it will appear in outputs.
* \copydoc doxygen_hide_input_parameter_data_arg
* \param[in] mesh Mesh upon which the \a Parameter is defined.
* \copydoc doxygen_hide_parameter_domain_arg
*
* \attention Please notice all \a Parameter can't be initialized from the input parameter file. For instance a
* parameter defined directly at quadrature points or at dofs must be built in hard in the code; current function
......@@ -79,7 +79,7 @@ namespace HappyHeart
*
* \param[in] name Name of the parameter, as it will appear in outputs.
* \copydoc doxygen_hide_input_parameter_data_arg
* \param[in] mesh Mesh upon which the \a Parameter is defined.
* \copydoc doxygen_hide_parameter_domain_arg
*
* \return Parameter considered.
*/
......
Sources/Parameters/InitParameterFromInputData/Internal/InitParameterFromInputData.hpp
View file @ 8ac12679
......@@ -66,7 +66,7 @@ namespace HappyHeart
*
* \copydoc doxygen_hide_input_parameter_data_arg
* \param[in] name Name of the parameter (for outputs only).
* \param[in] mesh Mesh upon which the \a Parameter is defined.
* \copydoc doxygen_hide_parameter_domain_arg
* \param[in] nature Nature of the scalar parameter as read in the input file ('constant', 'lua_function', etc..)
* Ops is supposed to check the given values are legit.
* \param[in] time_dependency TMP \todo #9 Complete!
......
Sources/Parameters/Parameter.hpp
View file @ 8ac12679
......@@ -124,7 +124,7 @@ namespace HappyHeart
* \brief Constructor.
*
* \param[in] name Name that will appear in outputs.
* \param[in] mesh Mesh upon which the parameter is built.
* \param[in] domain \a Domain upon which the parameter is built.
* \param[in] domain Domain upon which the \a Parameter is defined. This domain must be restricted to a
* \a GeometricMeshRegion.
*
......
Sources/Parameters/Parameters.doxygen
View file @ 8ac12679
......@@ -22,3 +22,10 @@
///@} // addtogroup
/*!
* \class doxygen_hide_parameter_domain_arg
*
* \param[in] domain \a Domain upon which the \a Parameter is defined.
*/
Sources/Parameters/Policy/AtDof/AtDof.hpp
View file @ 8ac12679
......@@ -168,7 +168,7 @@ namespace HappyHeart
/*!
* \class doxygen_hide_at_dof_impl_constructor_args
*
* \param[in] mesh Geometric mesh region considered. It is actually unused in this policy, but this is
* \param[in] domain \a Domain considered. It is actually unused in this policy, but this is
* a staple of policy usage and must be provided.
* \param[in] unknown A scalar or vectorial unknown that acts a bit as a strawman: dofs are defined only
* in relationship to an unknown, so you must create one if none fulfill your purposes (for instance
......
Sources/Parameters/Policy/AtQuadraturePoint/AtQuadraturePoint.hpp
View file @ 8ac12679
......@@ -92,7 +92,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] geometric_mesh_region Geometric mesh region upon which the parameter is defined.
* \copydoc doxygen_hide_parameter_domain_arg
* \param[in] quadrature_rule_per_topology Specify which quadrature rule to use for each topology that
* might be considered.
* \param[in] initial_value When the object is built the convention is to set this value at all of the
......
Sources/Parameters/Policy/PiecewiseConstantByDomain/PiecewiseConstantByDomain.hpp
View file @ 8ac12679
......@@ -74,7 +74,7 @@ namespace HappyHeart
/*!
* \brief Constructor for the paramter policy PiecewiseConstantByDomain.
*
* \param[in] mesh Mesh upon which the \a Parameter is defined.
* \copydoc doxygen_hide_parameter_domain_arg
* \param[in] key Unique ids of the domains on which the parameter is defined given by the input file.
* All the indices must be unique and the domain defined must not intersect.
* \param[in] value Value of the parameter in each domain. The number of indices and values must be the same.
......
Sources/Parameters/ScalarParameterFromFile.hpp
View file @ 8ac12679
......@@ -110,7 +110,7 @@ namespace HappyHeart
* \brief Constructor.
*
* \param[in] name Name that will appear in outputs.
* \param[in] geometric_mesh_region Mesh upon which the parameter is built.
* \copydoc doxygen_hide_parameter_domain_arg
* \param[in] file File to create the parameter.
* \param[in] time_manager \a TimeManager of the model.
*
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment