Mercurial > archived > louis > epitech > zia-api
changeset 22:18ca9800e906
fixed doxygen warnings
author | Zoltan K |
---|---|
date | Sun, 21 Mar 2010 10:14:14 +0100 |
parents | e2c0396cfb29 |
children | 812d6c5ac125 |
files | src/examples/Buffer/Buffer.hpp src/examples/rot13/Rot13Handler.hpp src/examples/rot13/main.cpp src/include/handler/IHttpHandler.hpp src/include/http/IResponse.hpp |
diffstat | 5 files changed, 8 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/src/examples/Buffer/Buffer.hpp Sun Mar 21 10:00:26 2010 +0100 +++ b/src/examples/Buffer/Buffer.hpp Sun Mar 21 10:14:14 2010 +0100 @@ -112,7 +112,7 @@ /** ** @brief This method is called when there is a need to read data from the buffer - ** but there no more data available in it. This method doesn't move the @get pointer. + ** but there no more data available in it. This method doesn't move the @b get pointer. ** @return The new character available at the get pointer position, if any. Otherwise, @c EOF. */ virtual int underflow(void);
--- a/src/examples/rot13/Rot13Handler.hpp Sun Mar 21 10:00:26 2010 +0100 +++ b/src/examples/rot13/Rot13Handler.hpp Sun Mar 21 10:14:14 2010 +0100 @@ -8,7 +8,7 @@ /** ** @brief Function that convert a char to its rot13 value - ** @param [in] The char to encode + ** @param [in] c The char to encode ** @return The char encoded */ char Rot13Char(char c);
--- a/src/examples/rot13/main.cpp Sun Mar 21 10:00:26 2010 +0100 +++ b/src/examples/rot13/main.cpp Sun Mar 21 10:14:14 2010 +0100 @@ -8,8 +8,8 @@ /** ** @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 + ** @param [in] is The stream to read from + ** @param [in] os The stream to write to */ void process_stream(std::istream & is, std::ostream & os) { @@ -33,7 +33,7 @@ /** ** @brief This function print the content of a stream on the standard output - ** @param [in] the stream to dump + ** @param [in] is the stream to dump */ void dump_stream(std::istream & is) { @@ -49,8 +49,6 @@ int main(void) { - // Buffer buffer1; - // Buffer buffer2; std::stringbuf buffer1; std::stringbuf buffer2; std::ostream os(NULL);
--- a/src/include/handler/IHttpHandler.hpp Sun Mar 21 10:00:26 2010 +0100 +++ b/src/include/handler/IHttpHandler.hpp Sun Mar 21 10:14:14 2010 +0100 @@ -24,8 +24,8 @@ /** * @brief method called by the server. * @param [in] transac the transation associated with streams. - * @param [in] in the input stream - * @param [in] out the output stream + * @param [in] is the input stream + * @param [in] os the output stream * @return an integer TODO define an enum XXX * @see ITransaction */
--- a/src/include/http/IResponse.hpp Sun Mar 21 10:00:26 2010 +0100 +++ b/src/include/http/IResponse.hpp Sun Mar 21 10:14:14 2010 +0100 @@ -69,7 +69,7 @@ * @param [in] v the HTTP version to set * @see IResponse::getVersion */ - virtual void setVersion(const std::string &) = 0; + virtual void setVersion(const std::string & v) = 0; /** * @brief get HTTP header associated with the