Changeset 1470:4d54b7fbb067


Ignore:
Timestamp:
08/22/10 12:35:08 (18 months ago)
Author:
niam
Branch:
default
Message:

fixed docstrings

Location:
sources/include/libdodo
Files:
10 edited

Legend:

Unmodified
Added
Removed

  • sources/include/libdodo/cgiFastExchange.h

    r1439 r1470  
    9696                 * @return amount in bytes of successfully read data 
    9797                 * @param data defines buffer that will be filled 
    98                  * @note not more then bs(including null) 
     98                 * @note not more than io::channel::bs(including null) 
    9999                 */ 
    100100                virtual unsigned long _read(char * const data) const; 
    … …  
    104104                 * @return amount in bytes of successfully read data 
    105105                 * @param data defines buffer that will be filled 
    106                  * @note not more then bs(including null) 
     106                 * @note not more than io::channel::bs(including null) 
    107107                 */ 
    108108                virtual unsigned long _readString(char * const data) const; 

  • sources/include/libdodo/ioBlockChannel.h

    r1439 r1470  
    5959                /** 
    6060                 * @return read data 
    61                  * @note not more then bs 
     61                 * @note not more than io::channel::bs 
    6262                 */ 
    6363                virtual dodo::string read() const; 
    … …  
    6666                 * @return amount in bytes of successfully written data 
    6767                 * @param data defines data that will be written 
    68                  * @note not more then bs 
     68                 * @note not more than io::channel::bs 
    6969                 */ 
    7070                virtual unsigned long write(const dodo::string &data) const; 
    … …  
    7373                 * read null- or newline- terminated string 
    7474                 * @return read data 
    75                  * @note not more then bs 
     75                 * @note not more than io::channel::bs 
    7676                 */ 
    7777                virtual dodo::string readString() const; 
    … …  
    8181                 * @return amount in bytes of successfully written data 
    8282                 * @param data defines data that will be written 
    83                  * @note not more then bs 
     83                 * @note not more than io::channel::bs 
    8484                 */ 
    8585                virtual unsigned long writeString(const dodo::string &data) const; 

  • sources/include/libdodo/ioChannel.h

    r1439 r1470  
    123123            /** 
    124124             * @return read data 
    125              * @note not more then bs 
     125             * @note not more than io::channel::bs 
    126126             */ 
    127127            virtual dodo::string read() const = 0; 
    … …  
    130130             * @return amount in bytes of successfully written data 
    131131             * @param data defines data that will be written 
    132              * @note not more then bs 
     132             * @note not more than io::channel::bs 
    133133             */ 
    134134            virtual unsigned long write(const dodo::string &data) const = 0; 
    … …  
    137137             * read null- or newline- terminated string 
    138138             * @return read data 
    139              * @note not more then bs 
     139             * @note not more than io::channel::bs 
    140140             */ 
    141141            virtual dodo::string readString() const = 0; 
    … …  
    145145             * @return amount in bytes of successfully written data 
    146146             * @param data defines data that will be written 
    147              * @note not more then bs 
     147             * @note not more than io::channel::bs 
    148148             */ 
    149149            virtual unsigned long writeString(const dodo::string &data) const = 0; 
    … …  
    161161             * @return amount in bytes of successfully read data 
    162162             * @param data defines buffer that will be filled 
    163              * @note not more then bs(including null) 
     163             * @note not more than io::channel::bs(including null) 
    164164             */ 
    165165            virtual unsigned long _read(char * const data) const = 0; 
    … …  
    169169             * @return amount in bytes of successfully read data 
    170170             * @param data defines buffer that will be filled 
    171              * @note not more then bs(including null) 
     171             * @note not more than io::channel::bs(including null) 
    172172             */ 
    173173            virtual unsigned long _readString(char * const data) const = 0; 
    … …  
    176176             * @return amount in bytes of successfully written data 
    177177             * @param data defines data that will be written 
    178              * @note not more then bs(including null) 
     178             * @note not more than io::channel::bs(including null) 
    179179             */ 
    180180            virtual unsigned long _write(const char * const data) const = 0; 
    … …  
    184184             * @return amount in bytes of successfully written data 
    185185             * @param data defines data that will be written 
    186              * @note not more then bs(including null) 
     186             * @note not more than io::channel::bs(including null) 
    187187             */ 
    188188            virtual unsigned long _writeString(const char * const data) const = 0; 

  • sources/include/libdodo/ioFileFifo.h

    r1439 r1470  
    146146                 * @return amount in bytes of successfully read data 
    147147                 * @param data defines buffer that will be filled 
    148                  * @note not more then bs(including null) 
     148                 * @note not more than io::channel::bs(including null) 
    149149                 */ 
    150150                virtual unsigned long _read(char * const data) const; 
    … …  
    154154                 * @return amount in bytes of successfully read data 
    155155                 * @param data defines buffer that will be filled 
    156                  * @note not more then bs(including null) 
     156                 * @note not more than io::channel::bs(including null) 
    157157                 */ 
    158158                virtual unsigned long _readString(char * const data) const; 

  • sources/include/libdodo/ioFileRegular.h

    r1439 r1470  
    144144                 * @return amount in bytes of successfully read data 
    145145                 * @param data defines buffer that will be filled 
    146                  * @note not more then bs(including null) 
     146                 * @note not more than io::channel::bs(including null) 
    147147                 */ 
    148148                virtual unsigned long _read(char * const data) const; 
    … …  
    152152                 * @return amount in bytes of successfully read data 
    153153                 * @param data defines buffer that will be filled 
    154                  * @note not more then bs(including null) 
     154                 * @note not more than io::channel::bs(including null) 
    155155                 */ 
    156156                virtual unsigned long _readString(char * const data) const; 

  • sources/include/libdodo/ioMemory.h

    r1439 r1470  
    134134             * @return amount in bytes of successfully read data 
    135135             * @param data defines buffer that will be filled 
    136              * @note not more then bs(including null) 
     136             * @note not more than io::channel::bs(including null) 
    137137             */ 
    138138            virtual unsigned long _read(char * const data) const; 
    … …  
    142142             * @return amount in bytes of successfully read data 
    143143             * @param data defines buffer that will be filled 
    144              * @note not more then bs(including null) 
     144             * @note not more than io::channel::bs(including null) 
    145145             */ 
    146146            virtual unsigned long _readString(char * const data) const; 

  • sources/include/libdodo/ioNetworkExchange.h

    r1439 r1470  
    169169                 * @return amount in bytes of successfully read data 
    170170                 * @param data defines buffer that will be filled 
    171                  * @note not more then bs(including null) 
     171                 * @note not more than io::channel::bs(including null) 
    172172                 */ 
    173173                virtual unsigned long _read(char * const data) const; 
    … …  
    177177                 * @return amount in bytes of successfully read data 
    178178                 * @param data defines buffer that will be filled 
    179                  * @note not more then bs(including null) 
     179                 * @note not more than io::channel::bs(including null) 
    180180                 */ 
    181181                virtual unsigned long _readString(char * const data) const; 

  • sources/include/libdodo/ioNetworkSslExchange.h

    r1439 r1470  
    155155                     * @return amount in bytes of successfully read data 
    156156                     * @param data defines buffer that will be filled 
    157                      * @note not more then bs(including null) 
     157                     * @note not more than io::channel::bs(including null) 
    158158                     */ 
    159159                    virtual unsigned long _read(char * const data) const; 
    … …  
    163163                     * @return amount in bytes of successfully read data 
    164164                     * @param data defines buffer that will be filled 
    165                      * @note not more then bs(including null) 
     165                     * @note not more than io::channel::bs(including null) 
    166166                     */ 
    167167                    virtual unsigned long _readString(char * const data) const; 

  • sources/include/libdodo/ioPipe.h

    r1439 r1470  
    130130             * @return amount in bytes of successfully read data 
    131131             * @param data defines buffer that will be filled 
    132              * @note not more then bs(including null) 
     132             * @note not more than io::channel::bs(including null) 
    133133             */ 
    134134            virtual unsigned long _read(char * const data) const; 
    … …  
    138138             * @return amount in bytes of successfully read data 
    139139             * @param data defines buffer that will be filled 
    140              * @note not more then bs(including null) 
     140             * @note not more than io::channel::bs(including null) 
    141141             */ 
    142142            virtual unsigned long _readString(char * const data) const; 

  • sources/include/libdodo/ioStreamChannel.h

    r1439 r1470  
    5959                /** 
    6060                 * @return read data 
    61                  * @note not more then bs 
     61                 * @note not more than io::channel::bs 
    6262                 */ 
    6363                virtual dodo::string read() const; 
    … …  
    6666                 * @return amount in bytes of successfully written data 
    6767                 * @param data defines data that will be written 
    68                  * @note not more then bs 
     68                 * @note not more than io::channel::bs 
    6969                 */ 
    7070                virtual unsigned long write(const dodo::string &data) const; 
    … …  
    7373                 * read null- or newline- terminated string 
    7474                 * @return read data 
    75                  * @note not more then bs 
     75                 * @note not more than io::channel::bs 
    7676                 */ 
    7777                virtual dodo::string readString() const; 
    … …  
    8181                 * @return amount in bytes of successfully written data 
    8282                 * @param data defines data that will be written 
    83                  * @note not more then bs 
     83                 * @note not more than io::channel::bs 
    8484                 */ 
    8585                virtual unsigned long writeString(const dodo::string &data) const; 
Note: See TracChangeset for help on using the changeset viewer.