Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
dune-common
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Core Modules
dune-common
Commits
ae124b2a
Commit
ae124b2a
authored
12 years ago
by
Christian Engwer
Browse files
Options
Downloads
Patches
Plain Diff
[doc]
fix \code blocks documentation.hh [[Imported from SVN: r7020]]
parent
28f18c12
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
dune/common/documentation.hh
+21
-19
21 additions, 19 deletions
dune/common/documentation.hh
with
21 additions
and
19 deletions
dune/common/documentation.hh
+
21
−
19
View file @
ae124b2a
...
...
@@ -10,38 +10,40 @@
namespace
Dune
{
//! Dummy struct used for documentation purposes
/**
* \brief Dummy struct used for documentation purposes
*
* This struct can be used for documenting interfaces. One example would
* be:
* \code
// Traits class that determines some property for some other type T
template<class T>
class SomeTraits {
dune_static_assert(AlwaysFalse<T>::value,
"Sorry, SomeTraits must be specialized for all types");
public:
// The type of some property of T
typedef ImplementationDefined type;
};
*#ifndef DOXYGEN
template<>
struct SomeTraits<int>
typedef ... type;
};
// ...
*#endif // DOXYGEN
*
// Traits class that determines some property for some other type T
*
template<class T>
*
class SomeTraits {
*
dune_static_assert(AlwaysFalse<T>::value,
*
"Sorry, SomeTraits must be specialized for all types");
*
public:
*
// The type of some property of T
*
typedef ImplementationDefined type;
*
};
*
#ifndef DOXYGEN
*
template<>
*
struct SomeTraits<int>
*
typedef ... type;
*
};
*
// ...
*
#endif // DOXYGEN
* \endcode
*
* \sa implementationDefined
*/
struct
ImplementationDefined
{};
//! Dummy integral value used for documentation purposes
/**
* \brief Dummy integral value used for documentation purposes
*
* \var Dune::implementationDefined
* \code
*#include <dune/common/documentation.hh>
*
#include <dune/common/documentation.hh>
* \endcode
*
* \sa ImplementationDefined
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment