Added more doxygen documentation

[germs.git] / src / sortaction.h

diff --git a/src/sortaction.h b/src/sortaction.h
index c56d0ee42a304bdf26db992f36d4c61a5f374f7a..ec9a023710961ee0978651fe46f1520d6d18039d 100644 (file)
--- a/src/sortaction.h
+++ b/src/sortaction.h
@@ -26,6 +26,10 @@
 class GeneOrder;
 
 
+/**
+ * Abstraction for a sort action implementation, this is the base that other
+ * actions inherits from.
+ */
 class SortActionImpl{
        public:
 
@@ -48,7 +52,7 @@ class SortActionImpl{
 };
 
 /**
- * Abstraction of a sort action, all child actions has to be immutable.
+ * Abstraction of a sort action, all SortActionImpls has to be immutable.
  *
  * \author Michael Andreen
  */
@@ -101,6 +105,13 @@ class SortAction{
                std::string toString() const{
                        return _action->toString();
                }
+
+               /**
+                * Gives access to the implementation
+                */
+               const SortActionImpl& impl() const{
+                       return *_action;
+               }
        private:
                ActionPointer _action;