Commit 9b47af60 authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 Doxygen: fix hyperelastic law warnings, and introduce generic comment for...

#9 Doxygen: fix hyperelastic law warnings, and introduce generic comment for repeated stuff such as self alias in classes.
parent 95cbd883
......@@ -6755,7 +6755,7 @@
BE9FE84418CE0A6900177F79 /* SeldonFunctions.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = SeldonFunctions.hxx; sourceTree = "<group>"; };
BE9FE9511D74931B00F4617F /* FluidmassEnum.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = FluidmassEnum.hpp; path = Sources/ModelInstances/UnderDevelopment/Poromechanics/HyperelasticLaw/FluidmassEnum.hpp; sourceTree = SOURCE_ROOT; };
BEA00BC81C7328090070EBED /* Model.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Model.hxx; sourceTree = "<group>"; };
BEA0480C1DA553550090D616 /* Operator.doxygen */ = {isa = PBXFileReference; explicitFileType = text.script.python; fileEncoding = 4; name = Operator.doxygen; path = Sources/Operators/Operator.doxygen; sourceTree = "<group>"; };
BEA0480C1DA553550090D616 /* Operator.doxygen */ = {isa = PBXFileReference; explicitFileType = sourcecode.cpp.h; fileEncoding = 4; name = Operator.doxygen; path = Sources/Operators/Operator.doxygen; sourceTree = "<group>"; };
BEA075551860549B00E83E71 /* HyperElasticityModel.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; lineEnding = 0; path = HyperElasticityModel.hpp; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.cpp; };
BEA075561860549B00E83E71 /* HyperElasticityModel.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; lineEnding = 0; path = HyperElasticityModel.hxx; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.cpp; };
BEA075571860549B00E83E71 /* InputParameterList.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = InputParameterList.hpp; sourceTree = "<group>"; };
......@@ -54,7 +54,7 @@ namespace HappyHeart
using parent = Crtp::Section<self, NoEnclosingSection>;
friend parent;
//! Alias to self intended to be used in classes enclosed in current class.
//! \copydoc doxygen_hide_alias_self intended to be used in classes enclosed in current class.
using enclosing_type = self;
......
......@@ -34,7 +34,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = GlobalDiagonalMatrix;
//! Alias to unique pointer.
......
......@@ -38,7 +38,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = ConstantTimeStep;
protected:
......
......@@ -59,7 +59,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = DofStorage;
//! Alias to unique pointer.
......
......@@ -66,7 +66,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = Local2GlobalStorage;
//! Alias to unique pointer.
......
......@@ -87,7 +87,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = DofProgramWiseIndexListPerVertexCoordIndex;
//! Alias to unique pointer.
......
......@@ -61,7 +61,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = MovemeshHelper;
//! Alias to unique pointer.
......
......@@ -52,7 +52,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = QuadratureRulePerTopology;
//! Alias to unique pointer.
......
......@@ -60,7 +60,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = TetrahedronP1Bubble;
......
......@@ -61,7 +61,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = TriangleP1Bubble;
......
......@@ -41,7 +41,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = HyperelasticLaw<DerivedT, HyperelasticLawT>;
//! Alias to hyperelastic law type.
......
......@@ -52,7 +52,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = DofSource;
......
......@@ -54,7 +54,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = None;
public:
......
......@@ -60,7 +60,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = InitialConditionInstance<TypeT, NaturePolicyT, Args...>;
//! Alias to base class.
......
......@@ -52,7 +52,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = InitialCondition<TypeT>;
//! Alias to unique pointer.
......
......@@ -39,7 +39,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = ThreeDimensionalInitialCondition;
//! Alias to base class.
......
......@@ -47,7 +47,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = Constant<TypeT>;
......
......@@ -53,7 +53,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = OpsFunction<TypeT, SpatialFunction>;
private:
......
......@@ -46,7 +46,7 @@ namespace HappyHeart
public:
//! Alias to self.
//! \copydoc doxygen_hide_alias_self
using self = CoordIndexes;
public:
......
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