From 23fed472d1d29c8c73d7d0bcb2042cee1b162bde Mon Sep 17 00:00:00 2001
From: Yann Dirson <ydirson@altern.org>
Date: Sun, 16 Mar 2008 19:15:42 +0100
Subject: [PATCH] Add Doxygen documentation to C++ namespaces.

---
 src/common.cpp                  | 3 +++
 src/core/delegators/state.h     | 3 +++
 src/core/turnpolicy.h           | 3 +++
 src/imageeffects.h              | 3 +++
 src/luaapi/luavalue.h           | 3 +++
 src/variants/chess/state.h      | 3 +++
 src/variants/crazyhouse/state.h | 3 +++
 src/variants/minishogi/state.h  | 3 +++
 src/variants/shogi/state.h      | 3 +++
 9 files changed, 27 insertions(+)

diff --git a/src/common.cpp b/src/common.cpp
index 1b0333d..d00ac7e 100644
--- a/src/common.cpp
+++ b/src/common.cpp
@@ -11,6 +11,9 @@
 #include "common.h"
 #include <KDebug>
 
+/**
+  * @brief Namespace holding Boost stubs.
+  */
 namespace boost {
 // throw exception: used by boost
 void throw_exception(std::exception const &) {
diff --git a/src/core/delegators/state.h b/src/core/delegators/state.h
index a53f0ed..a2155ae 100644
--- a/src/core/delegators/state.h
+++ b/src/core/delegators/state.h
@@ -12,6 +12,9 @@
 
 #include "../state.h"
 
+/**
+  * @brief Namespace holding delegators to core Tagua components.
+  */
 namespace Delegators {
 
 class State : virtual public IState {
diff --git a/src/core/turnpolicy.h b/src/core/turnpolicy.h
index d110a09..893efb5 100644
--- a/src/core/turnpolicy.h
+++ b/src/core/turnpolicy.h
@@ -17,6 +17,9 @@
 
 class IColor;
 
+/**
+  * @brief XXX
+  */
 namespace TurnPolicy {
   
   /**
diff --git a/src/imageeffects.h b/src/imageeffects.h
index 552dd26..57cf648 100644
--- a/src/imageeffects.h
+++ b/src/imageeffects.h
@@ -15,6 +15,9 @@
 #include <QPoint>
 #include <vector>
 
+/**
+  * @brief Namespace holding image manipulation functions.
+  */
 namespace ImageEffects {
   void expBlur(QImage& img, int radius);
   QImage addShadow(const QImage& image, int radius, QColor color,
diff --git a/src/luaapi/luavalue.h b/src/luaapi/luavalue.h
index 39026c3..0390f75 100644
--- a/src/luaapi/luavalue.h
+++ b/src/luaapi/luavalue.h
@@ -19,6 +19,9 @@ class QPointF;
 class QRectF;
 class lua_State;
 
+/**
+  * @brief Namespace holding the Lua bindings used for theming.
+  */
 namespace LuaApi {
 
 typedef boost::variant<double, QPointF, QRectF> LuaValue;
diff --git a/src/variants/chess/state.h b/src/variants/chess/state.h
index 0918b72..4e591bc 100644
--- a/src/variants/chess/state.h
+++ b/src/variants/chess/state.h
@@ -17,6 +17,9 @@
 #include <core/piece.h>
 #include <core/taguaobject.h>
 
+/**
+  * @brief Namespace holding Chess components.
+  */
 namespace Chess {
 
 class ICastlingRules;
diff --git a/src/variants/crazyhouse/state.h b/src/variants/crazyhouse/state.h
index e100150..e0ebace 100644
--- a/src/variants/crazyhouse/state.h
+++ b/src/variants/crazyhouse/state.h
@@ -16,6 +16,9 @@
 
 class IPoolCollection;
 
+/**
+  * @brief Namespace holding Crazyhouse components.
+  */
 namespace Crazyhouse {
 
 class State : public Component, public Delegators::State {
diff --git a/src/variants/minishogi/state.h b/src/variants/minishogi/state.h
index 5128195..8a5ec52 100644
--- a/src/variants/minishogi/state.h
+++ b/src/variants/minishogi/state.h
@@ -5,6 +5,9 @@
 #include <core/component.h>
 #include <core/piece.h>
 
+/**
+  * @brief Namespace holding Minishogi components.
+  */
 namespace MiniShogi {
 
 class State : public Component, public Delegators::DefaultState {
diff --git a/src/variants/shogi/state.h b/src/variants/shogi/state.h
index 09b7245..2b046e6 100644
--- a/src/variants/shogi/state.h
+++ b/src/variants/shogi/state.h
@@ -17,6 +17,9 @@
 #include <core/piece.h>
 #include <core/taguaobject.h>
 
+/**
+  * @brief Namespace holding Shogi components.
+  */
 namespace Shogi {
 
 class State : public Component, public DefaultState {
-- 
2.11.4.GIT