Skip to content
Snippets Groups Projects
Commit 130183f7 authored by Jakub Klinkovský's avatar Jakub Klinkovský
Browse files

Added brief descriptions of some namespaces

[ci skip]
parent 4c7c9658
No related branches found
No related tags found
1 merge request!24Documentation
...@@ -11,7 +11,10 @@ ...@@ -11,7 +11,10 @@
#pragma once #pragma once
namespace TNL { namespace TNL {
namespace Images { /**
* \brief Namespace for image processing.
*/
namespace Images {
template< typename Index = int > template< typename Index = int >
class Image class Image
......
...@@ -16,7 +16,10 @@ ...@@ -16,7 +16,10 @@
#include <TNL/Containers/VectorView.h> #include <TNL/Containers/VectorView.h>
namespace TNL { namespace TNL {
namespace Matrices { /**
* \brief Namespace for matrix formats.
*/
namespace Matrices {
template< typename Real = double, template< typename Real = double,
typename Device = Devices::Host, typename Device = Devices::Host,
......
...@@ -29,6 +29,9 @@ ...@@ -29,6 +29,9 @@
#include <TNL/Meshes/DistributedMeshes/DistributedMesh.h> #include <TNL/Meshes/DistributedMeshes/DistributedMesh.h>
namespace TNL { namespace TNL {
/**
* \brief Namespace for numerical meshes and related objects.
*/
namespace Meshes { namespace Meshes {
template< typename MeshConfig > class Initializer; template< typename MeshConfig > class Initializer;
......
...@@ -23,6 +23,9 @@ ...@@ -23,6 +23,9 @@
namespace TNL { namespace TNL {
namespace Solvers { namespace Solvers {
/**
* \brief Namespace for linear system solvers.
*/
namespace Linear { namespace Linear {
template< typename Matrix > template< typename Matrix >
......
...@@ -20,6 +20,9 @@ ...@@ -20,6 +20,9 @@
namespace TNL { namespace TNL {
namespace Solvers { namespace Solvers {
namespace Linear { namespace Linear {
/**
* \brief Namespace for preconditioners for linear system solvers.
*/
namespace Preconditioners { namespace Preconditioners {
template< typename Matrix > template< typename Matrix >
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment