Mercurial > archived > louis > epitech > zia-api
changeset 46:dad671a5f028
Corrections de typos, d'orthograffe et de formulations.
| author | David Pineau <dav.pineau@gmail.com> |
|---|---|
| date | Mon, 22 Mar 2010 17:39:10 +0100 |
| parents | 1254fa6755a3 |
| children | 4ddbd44f8ac5 |
| files | include/IConfig.hpp include/IModule.hpp include/handler/IBodyHandler.hpp include/handler/IHandler.hpp include/handler/IHeaderHandler.hpp include/handler/INetworkHandler.hpp include/http/IHeader.hpp include/http/IRequest.hpp include/http/IResponse.hpp include/http/ITransaction.hpp |
| diffstat | 10 files changed, 34 insertions(+), 35 deletions(-) [+] |
line wrap: on
line diff
--- a/include/IConfig.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/IConfig.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -9,8 +9,8 @@ namespace api { /** - * @brief Represent the interface that the configuration handler has to - * respect to interact with module. + * @brief Represents the interface that the configuration handler must + * respect to interact with a module. */ class IConfig {
--- a/include/IModule.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/IModule.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -13,7 +13,7 @@ * * @section sec_about About * - * This API is maintened by the StreamIt Tream: more info at www.ziastream.it. + * This API is maintained by the StreamIt Team: more info at www.ziastream.it. * * From here you can browse the full reference on our API. */ @@ -23,8 +23,7 @@ namespace api { /** - * @brief It provides basic method to identify the module and load a - * module. + * @brief It provides basic methods to identify the module and load it. */ class IModule { @@ -46,7 +45,7 @@ virtual const std::string & getVersion(void) const = 0; /** - * @brief Get the list of module's hook. + * @brief Get the module's list of hooks. * * @return A vector of IHandler. * @@ -57,7 +56,7 @@ /** * @brief Update module configuration. * - * @param [in] conf The pointer on IConfig which hold the + * @param [in] conf The pointer on IConfig which holds the * configuration. * * @return True if the configuration was successfully loaded. False @@ -71,7 +70,7 @@ extern "C" { /** - * @brief Entry point of module. + * @brief Entry point of the module. * * @return The module instance. *
--- a/include/handler/IBodyHandler.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/handler/IBodyHandler.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -14,8 +14,7 @@ { /** * @brief Interface for handlers which will interact with the - * client by reading the client's socket or writing in client - * socket. + * client by reading or writing to its socket. */ class IBodyHandler : public IHandler {
--- a/include/handler/IHandler.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/handler/IHandler.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -14,7 +14,7 @@ */ enum EHook { - NetwordModifier, /**< Hook to replace read/write/accept function. (INetworkHandler) */ + NetworkModifier, /**< Hook to replace read/write/accept function. (INetworkHandler) */ RequestHeaderModifier, /**< Hook to modify the request's header. (IHeaderHandler) */ RequestBodyModifier, /**< Hook to modify the request's body. (IBodyHandler) */ ResponseProcessor, /**< Hook for content generation. (IBodyHandler) */ @@ -34,7 +34,7 @@ }; /** - * @brief Interface which all handler have to respect. + * @brief Interface which all handlers have to respect. */ class IHandler { @@ -44,8 +44,8 @@ /** * @brief Get where the hook has to be called. * - * @return EHook which represent the location of where the hook - * should be added. + * @return EHook which represents the location of the hook + * where the handler should be added. */ virtual EHook getHook(void) const = 0; };
--- a/include/handler/IHeaderHandler.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/handler/IHeaderHandler.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -24,7 +24,7 @@ /** * @brief Called by the server. * - * @param [in] transac The transation associated with streams. + * @param [in] transac The transaction associated with the streams. * * @return an ECode. *
--- a/include/handler/INetworkHandler.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/handler/INetworkHandler.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -25,14 +25,14 @@ /** * @brief Agregate functions pointers that can be "overloaded". * - * If an handler doesn't want to overload one of this function + * If a handler doesn't want to overload one of these functions * it should set the pointer to @c NULL. */ struct sPtrFunc { /** - * @brief Accept redefinition, called when we want accept a - * new connection sock_accept return a pointer on + * @brief Accept redefinition, called when we want to + * accept a new connection sock_accept return a pointer on * IEndPoint. * * @param [in] server Holds the accept socket.
--- a/include/http/IHeader.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/http/IHeader.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -11,7 +11,7 @@ namespace http { /** - * @brief erovides a convenient way to interact with HTTP headers. + * @brief provides a convenient way to interact with HTTP headers. */ class IHeader { @@ -27,7 +27,7 @@ * @param [in] k The key. * @param [in,out] value Where the value will be copied. * - * @return If the key does not exists return false otherwise + * @return If the key does not exist return false otherwise * return true. */ virtual bool getValue(const Key & k, Value & value) const = 0;
--- a/include/http/IRequest.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/http/IRequest.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -27,7 +27,7 @@ /** * @brief Get method used. * - * @return The name of method. + * @return The name of the method. */ virtual const std::string & getMethod(void) const = 0; virtual void setMethod(const std::string &) = 0; @@ -56,24 +56,24 @@ /** * @brief Set the HTTP version. * - * @param [in] v The HTTP version to set it has to be like: + * @param [in] v The HTTP version to set. It has to be like: * 'X.X' where X is a digit. */ virtual void setVersion(const std::string & v) = 0; /** - * @brief Get HTTP header. + * @brief Get HTTP headers. * - * @return The http header. + * @return The http headers. * * @see IHeader */ virtual const IHeader & getHeaders(void) const = 0; /** - * @brief Get HTTP header. + * @brief Get HTTP headers. * - * @return the http header. + * @return the http headers. * * @see IHeader */
--- a/include/http/IResponse.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/http/IResponse.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -28,7 +28,7 @@ * * @return The status code, 0 if it is unset. * - * 'HTTP/1.1 200 OK' -> the '200' in string. + * 'HTTP/1.1 200 OK' -> the '200' in this string. */ virtual StatusCode getStatusCode(void) const = 0; @@ -37,7 +37,7 @@ * * @return The status message. * - * 'HTTP/1.1 200 OK' -> the 'OK' in string. + * 'HTTP/1.1 200 OK' -> the 'OK' in this string. */ virtual const std::string & getStatusMessage(void) const = 0; @@ -46,7 +46,7 @@ * * @return The HTTP version. * - * 'HTTP/1.1 200 OK' -> the '1.1' in string. + * 'HTTP/1.1 200 OK' -> the '1.1' in this string. */ virtual const std::string & getVersion(void) const = 0; @@ -78,7 +78,7 @@ virtual void setVersion(const std::string & v) = 0; /** - * @brief Get HTTP header associated with the response. + * @brief Get HTTP headers associated with the response. * * @return The http headers. *
--- a/include/http/ITransaction.hpp Mon Mar 22 13:46:08 2010 +0100 +++ b/include/http/ITransaction.hpp Mon Mar 22 17:39:10 2010 +0100 @@ -12,14 +12,15 @@ namespace http { /** - * @brief Provide a way to get all informations related to the + * @brief Provides a way to get all informations related to the * request and the response. * - * Even if response is always available, it should not be modify in - * RequestModifier * handler. + * Even if response is always available, it should not be modified + * in RequestModifier handler. * - * @note We don't provide differents interfaces for the request and - * the response, to avoid code duplication. + * @note We do not provide different interfaces for the request and + * the response handlers, to avoid code duplication. It is up to + * the module not to modify carelessly the request or the response. */ class ITransaction {