Doc: improve \class documentation

11 files changed, 53 insertions, 1 deletions

diff --git a/src/builtins/boolean_builtins.h b/src/builtins/boolean_builtins.h
index 0d3db1a..ac79c90 100644
--- a/src/builtins/boolean_builtins.h
+++ b/src/builtins/boolean_builtins.h
@@ -25,12 +25,20 @@
 
 #include "cppbash_builtin.h"
 
+///
+/// \class true_builtin
+/// \brief the true builtin for bash
+///
 struct true_builtin : public virtual cppbash_builtin
 {
   BUILTIN_CONSTRUCTOR(true)
   virtual int exec(const std::vector<std::string>& ) { return 0; }
 };
 
+///
+/// \class false_builtin
+/// \brief the false builtin for bash
+///
 struct false_builtin : public virtual cppbash_builtin
 {
   BUILTIN_CONSTRUCTOR(false)
diff --git a/src/builtins/break_builtin.h b/src/builtins/break_builtin.h
index fec1bc7..a7dec6f 100644
--- a/src/builtins/break_builtin.h
+++ b/src/builtins/break_builtin.h
@@ -25,6 +25,10 @@
 
 #include "cppbash_builtin.h"
 
+///
+/// \class break_builtin
+/// \brief the break builtin for bash
+///
 class break_builtin : public virtual cppbash_builtin
 {
 public:
diff --git a/src/builtins/builtin_exceptions.h b/src/builtins/builtin_exceptions.h
index 89a8cc8..9eb65c0 100644
--- a/src/builtins/builtin_exceptions.h
+++ b/src/builtins/builtin_exceptions.h
@@ -39,6 +39,10 @@ public:
     runtime_error("return exception"){}
 };
 
+///
+/// \class loop_control_exception
+/// \brief base class used by break and continue
+///
 class loop_control_exception
 {
   int count;
@@ -64,6 +68,10 @@ public:
   }
 };
 
+///
+/// \class continue_exception
+/// \brief thrown when executing the continue builtin
+///
 class continue_exception: public loop_control_exception
 {
 protected:
@@ -82,6 +90,10 @@ public:
   }
 };
 
+///
+/// \class break_exception
+/// \brief thrown when executing the break builtin
+///
 class break_exception: public loop_control_exception
 {
 protected:
diff --git a/src/builtins/continue_builtin.h b/src/builtins/continue_builtin.h
index cd5223b..e629d5b 100644
--- a/src/builtins/continue_builtin.h
+++ b/src/builtins/continue_builtin.h
@@ -25,6 +25,10 @@
 
 #include "cppbash_builtin.h"
 
+///
+/// \class continue_builtin
+/// \brief the continue builtin for bash
+///
 class continue_builtin : public virtual cppbash_builtin
 {
 public:
diff --git a/src/builtins/inherit_builtin.h b/src/builtins/inherit_builtin.h
index 0e7f6ef..49bb615 100644
--- a/src/builtins/inherit_builtin.h
+++ b/src/builtins/inherit_builtin.h
@@ -27,7 +27,7 @@
 #include "cppbash_builtin.h"
 
 ///
-/// \class inherit
+/// \class inherit_builtin
 /// \brief the inherit builtin for bash
 ///
 class inherit_builtin: public virtual cppbash_builtin
diff --git a/src/builtins/let_builtin.h b/src/builtins/let_builtin.h
index 9dba7d6..524a95c 100644
--- a/src/builtins/let_builtin.h
+++ b/src/builtins/let_builtin.h
@@ -25,6 +25,10 @@
 
 #include "cppbash_builtin.h"
 
+///
+/// \class let_builtin
+/// \brief the let builtin for bash
+///
 class let_builtin : public virtual cppbash_builtin
 {
 public:
diff --git a/src/builtins/printf_builtin.h b/src/builtins/printf_builtin.h
index ec3ba72..6a62a51 100644
--- a/src/builtins/printf_builtin.h
+++ b/src/builtins/printf_builtin.h
@@ -25,6 +25,10 @@
 
 #include "cppbash_builtin.h"
 
+///
+/// \class printf_builtin
+/// \brief the printf builtin for bash
+///
 class printf_builtin : public virtual cppbash_builtin
 {
 public:
diff --git a/src/builtins/return_builtin.h b/src/builtins/return_builtin.h
index 54663c2..647960c 100644
--- a/src/builtins/return_builtin.h
+++ b/src/builtins/return_builtin.h
@@ -25,6 +25,10 @@
 
 #include "cppbash_builtin.h"
 
+///
+/// \class return_builtin
+/// \brief the return builtin for bash
+///
 class return_builtin : public virtual cppbash_builtin
 {
 public:
diff --git a/src/builtins/shift_builtin.h b/src/builtins/shift_builtin.h
index c413380..ba1f080 100644
--- a/src/builtins/shift_builtin.h
+++ b/src/builtins/shift_builtin.h
@@ -25,6 +25,10 @@
 
 #include "cppbash_builtin.h"
 
+///
+/// \class shift_builtin
+/// \brief the shift builtin for bash
+///
 class shift_builtin : public virtual cppbash_builtin
 {
 public:
diff --git a/src/builtins/shopt_builtin.h b/src/builtins/shopt_builtin.h
index 2b1f766..5df8ca5 100644
--- a/src/builtins/shopt_builtin.h
+++ b/src/builtins/shopt_builtin.h
@@ -25,6 +25,10 @@
 
 #include "cppbash_builtin.h"
 
+///
+/// \class shopt_builtin
+/// \brief the shopt builtin for bash
+///
 class shopt_builtin : public virtual cppbash_builtin
 {
   void set_opt(const std::vector<std::string>& bash_args, bool value);
diff --git a/src/builtins/unset_builtin.h b/src/builtins/unset_builtin.h
index 202e78a..847cff2 100644
--- a/src/builtins/unset_builtin.h
+++ b/src/builtins/unset_builtin.h
@@ -25,6 +25,10 @@
 
 #include "cppbash_builtin.h"
 
+///
+/// \class unset_builtin
+/// \brief the unset builtin for bash
+///
 class unset_builtin : public virtual cppbash_builtin
 {
 public: