Edit

kc3-lang/libevent/include/event2/rpc_compat.h

Branch :

  • Show log

    Commit

  • Author : yuangongji
    Date : 2019-08-29 19:40:10
    Hash : 620a3fa1
    Message : Doxygen documentation improvements - Documentation for `bufferevent_compat.h` and `rpc.h` is not generated since the `@file` command is missing. It can be fixed by adding `@file` in file comment block. - The briefs of buffer.h,bufferevent.h and some other files are missing. Adding `@brief` command can fix it. - The parameters in the function declaration are different from the parameters following the `@param` command.We should change them to the same. - Documentation of `watch.h` is not generated since `watch.h` has not been added to the Doxyfile `INPUT` tag. - Add link to the watch.h in event.h

  • include/event2/rpc_compat.h
  • /*
     * Copyright (c) 2006-2007 Niels Provos <provos@citi.umich.edu>
     * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
     *
     * Redistribution and use in source and binary forms, with or without
     * modification, are permitted provided that the following conditions
     * are met:
     * 1. Redistributions of source code must retain the above copyright
     *    notice, this list of conditions and the following disclaimer.
     * 2. Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in the
     *    documentation and/or other materials provided with the distribution.
     * 3. The name of the author may not be used to endorse or promote products
     *    derived from this software without specific prior written permission.
     *
     * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     */
    #ifndef EVENT2_RPC_COMPAT_H_INCLUDED_
    #define EVENT2_RPC_COMPAT_H_INCLUDED_
    
    /** @file event2/rpc_compat.h
    
      @brief Deprecated versions of the functions in rpc.h: provided only for
      backwards compatibility.
    
     */
    
    #ifdef __cplusplus
    extern "C" {
    #endif
    
    /** backwards compatible accessors that work only with gcc */
    #if defined(__GNUC__) && !defined(__STRICT_ANSI__)
    
    #undef EVTAG_ASSIGN
    #undef EVTAG_GET
    #undef EVTAG_ADD
    
    #define EVTAG_ASSIGN(msg, member, args...) \
    	(*(msg)->base->member##_assign)(msg, ## args)
    #define EVTAG_GET(msg, member, args...) \
    	(*(msg)->base->member##_get)(msg, ## args)
    #define EVTAG_ADD(msg, member, args...) \
    	(*(msg)->base->member##_add)(msg, ## args)
    #endif
    #define EVTAG_LEN(msg, member) ((msg)->member##_length)
    
    #ifdef __cplusplus
    }
    #endif
    
    #endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */