Mercurial > archived > louis > epitech > zia-api

changeset 6:e39c4397764c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[rot13] Doc on main.cpp
author Zoltan K
date Sat, 20 Mar 2010 00:29:12 +0100
parents aa427c18ffe2
children 0c2a143b5076
files src/examples/rot13/main.cpp
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/examples/rot13/main.cpp	Sat Mar 20 00:06:08 2010 +0100
+++ b/src/examples/rot13/main.cpp	Sat Mar 20 00:29:12 2010 +0100
@@ -5,6 +5,12 @@
 #include "Rot13Handler.hpp"
 #include "Buffer.hpp"
 
+/**
+ ** @brief Function that "emulates" the behavior of a server by instanciating a IModule
+ ** and by calling one of its handlers.
+ ** @param [in] The stream to read from
+ ** @param [in] The stream to write to
+ */
 void            process_stream(std::istream & is, std::ostream & os)
 {
     ModRot13                                    module;
@@ -25,6 +31,10 @@
     }
 }
 
+/**
+ ** @brief This function print the content of a stream on the standard output
+ ** @param [in] the stream to dump
+ */
 void        dump_stream(std::istream & is)
 {
     char        c;