X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FConsole%2FLineEditor.hh;h=2a94a7e62f3d345dc36e9ce81e0961d6d354efbd;hb=b8ca4a544cce3e6023bb56b712a03d6362f2bb79;hp=39e13b65c3214b757cf774abcb76c2e3db29d3d7;hpb=0461eef93912cb9d454d726b4a7b4ccf50ed31bd;p=senf.git

diff --git a/Utils/Console/LineEditor.hh b/Utils/Console/LineEditor.hh
index 39e13b6..2a94a7e 100644
--- a/Utils/Console/LineEditor.hh
+++ b/Utils/Console/LineEditor.hh
@@ -39,6 +39,15 @@ namespace senf {
 namespace console {
 namespace detail {
 
+    /** \brief Internal: Client reader switching between LineEditorClientReader or DumbClientReader
+        
+        This ClientReader implementation will try to initialize a LineEditorClientReader. If the
+        setup fails, a DumbClientReader is initialized instead. LineEditor support may fail to be
+        initialized if
+        
+        \li The telnet client does not support necessary functionality
+        \li or the terminal type of the client is missing some functionality.
+     */
     class LineEditorSwitcher
         : public ClientReader
     {
@@ -55,6 +64,10 @@ namespace detail {
         boost::scoped_ptr<ClientReader> reader_;
     };
 
+    /** \brief Internal: ClientReader using senf::term::LineEditor for interactive input
+
+        This ClientReader implementation uses a senf::term::LineEditor for interactive input. 
+     */
     class LineEditorClientReader
         : public ClientReader, public term::TelnetTerminal
     {