Overview
Comment: | Work around broken -Wdocumentation in Clang 10 |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
d35b4e3a859cbf597407edc386de94d2 |
User & Date: | js on 2020-04-12 12:52:47 |
Other Links: | manifest | tags |
Context
2020-04-12
| ||
12:55 | ofarc: Fix wrong indentation check-in: b186e992ae user: js tags: trunk | |
12:52 | Work around broken -Wdocumentation in Clang 10 check-in: d35b4e3a85 user: js tags: trunk | |
11:43 | Fix all Doxygen warnings check-in: 240eccca97 user: js tags: trunk | |
Changes
Modified src/OFHTTPRequest.h from [c500866337] to [e39f7af9d0].
︙ | ︙ | |||
53 54 55 56 57 58 59 | /*! * @struct of_http_request_protocol_version_t \ * OFHTTPRequest.h ObjFW/OFHTTPRequest.h * * @brief The HTTP version of the HTTP request. */ | | > > | | 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 | /*! * @struct of_http_request_protocol_version_t \ * OFHTTPRequest.h ObjFW/OFHTTPRequest.h * * @brief The HTTP version of the HTTP request. */ struct OF_BOXABLE of_http_request_protocol_version_t { /*! The major of the HTTP version */ uint8_t major; /*! The minor of the HTTP version */ uint8_t minor; }; typedef struct of_http_request_protocol_version_t of_http_request_protocol_version_t; /*! * @class OFHTTPRequest OFHTTPRequest.h ObjFW/OFHTTPRequest.h * * @brief A class for storing HTTP requests. */ @interface OFHTTPRequest: OFObject <OFCopying> |
︙ | ︙ |
Modified src/OFMapTable.h from [39846c8467] to [18718d5a71].
︙ | ︙ | |||
23 24 25 26 27 28 29 | /*! @file */ /*! * @struct of_map_table_functions_t OFMapTable.h ObjFW/OFMapTable.h * * @brief A struct describing the functions to be used by the map table. */ | | > | | 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | /*! @file */ /*! * @struct of_map_table_functions_t OFMapTable.h ObjFW/OFMapTable.h * * @brief A struct describing the functions to be used by the map table. */ struct of_map_table_functions_t { /*! The function to retain keys / objects */ void *_Nullable (*_Nullable retain)(void *_Nullable object); /*! The function to release keys / objects */ void (*_Nullable release)(void *_Nullable object); /*! The function to hash keys */ uint32_t (*_Nullable hash)(void *_Nullable object); /*! The function to compare keys / objects */ bool (*_Nullable equal)(void *_Nullable object1, void *_Nullable object2); }; typedef struct of_map_table_functions_t of_map_table_functions_t; #ifdef OF_HAVE_BLOCKS /*! * @brief A block for enumerating an OFMapTable. * * @param key The current key * @param object The current object |
︙ | ︙ |
Modified src/OFObject.h from [27f5bcdbd5] to [4e03fe9cf9].
︙ | ︙ | |||
87 88 89 90 91 92 93 | } of_byte_order_t; /*! * @struct of_range_t OFObject.h ObjFW/OFObject.h * * @brief A range. */ | | > | | 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | } of_byte_order_t; /*! * @struct of_range_t OFObject.h ObjFW/OFObject.h * * @brief A range. */ struct OF_BOXABLE of_range_t { /*! The start of the range */ size_t location; /*! The length of the range */ size_t length; }; typedef struct of_range_t of_range_t; /*! * @brief Creates a new of_range_t. * * @param start The starting index of the range * @param length The length of the range * @return An of_range with the specified start and length |
︙ | ︙ | |||
138 139 140 141 142 143 144 | typedef double of_time_interval_t; /*! * @struct of_point_t OFObject.h ObjFW/OFObject.h * * @brief A point. */ | | > | | 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | typedef double of_time_interval_t; /*! * @struct of_point_t OFObject.h ObjFW/OFObject.h * * @brief A point. */ struct OF_BOXABLE of_point_t { /*! The x coordinate of the point */ float x; /*! The y coordinate of the point */ float y; }; typedef struct of_point_t of_point_t; /*! * @brief Creates a new of_point_t. * * @param x The x coordinate of the point * @param y The x coordinate of the point * @return An of_point_t with the specified coordinates |
︙ | ︙ | |||
184 185 186 187 188 189 190 | } /*! * @struct of_dimension_t OFObject.h ObjFW/OFObject.h * * @brief A dimension. */ | | > | | 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | } /*! * @struct of_dimension_t OFObject.h ObjFW/OFObject.h * * @brief A dimension. */ struct OF_BOXABLE of_dimension_t { /*! The width of the dimension */ float width; /*! The height of the dimension */ float height; }; typedef struct of_dimension_t of_dimension_t; /*! * @brief Creates a new of_dimension_t. * * @param width The width of the dimension * @param height The height of the dimension * @return An of_dimension_t with the specified width and height |
︙ | ︙ | |||
230 231 232 233 234 235 236 | } /*! * @struct of_rectangle_t OFObject.h ObjFW/OFObject.h * * @brief A rectangle. */ | | > | | 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | } /*! * @struct of_rectangle_t OFObject.h ObjFW/OFObject.h * * @brief A rectangle. */ struct OF_BOXABLE of_rectangle_t { /*! The point from where the rectangle originates */ of_point_t origin; /*! The size of the rectangle */ of_dimension_t size; }; typedef struct of_rectangle_t of_rectangle_t; /*! * @brief Creates a new of_rectangle_t. * * @param x The x coordinate of the top left corner of the rectangle * @param y The y coordinate of the top left corner of the rectangle * @param width The width of the rectangle |
︙ | ︙ |
Modified src/OFOptionsParser.h from [d86c6c9090] to [d206f16719].
︙ | ︙ | |||
23 24 25 26 27 28 29 | OF_ASSUME_NONNULL_BEGIN /*! * @struct of_options_parser_option_t OFOptionsParser.h ObjFW/OFOptionsParser.h * * @brief An option which can be parsed by an @ref OFOptionsParser. */ | | | 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | OF_ASSUME_NONNULL_BEGIN /*! * @struct of_options_parser_option_t OFOptionsParser.h ObjFW/OFOptionsParser.h * * @brief An option which can be parsed by an @ref OFOptionsParser. */ struct of_options_parser_option_t { /*! The short version (e.g. `-v`) of the option or `\0` for none. */ of_unichar_t shortOption; /*! * The long version (e.g. `--verbose`) of the option or `nil` for none. */ OFString *__unsafe_unretained _Nullable longOption; |
︙ | ︙ | |||
55 56 57 58 59 60 61 | bool *_Nullable isSpecifiedPtr; /*! * An optional pointer to an `OFString *` that is set to the * argument specified for the option or `nil` for no argument. */ OFString *__autoreleasing _Nullable *_Nullable argumentPtr; | > | | 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 | bool *_Nullable isSpecifiedPtr; /*! * An optional pointer to an `OFString *` that is set to the * argument specified for the option or `nil` for no argument. */ OFString *__autoreleasing _Nullable *_Nullable argumentPtr; }; typedef struct of_options_parser_option_t of_options_parser_option_t; /*! * @class OFOptionsParser OFOptionsParser.h ObjFW/OFOptionsParser.h * * @brief A class for parsing the program options specified on the command line. */ OF_SUBCLASSING_RESTRICTED |
︙ | ︙ |
Modified src/socket.h from [d2c0976e15] to [f8e3143cfa].
︙ | ︙ | |||
106 107 108 109 110 111 112 | #endif /*! * @struct of_socket_address_t socket.h ObjFW/socket.h * * @brief A struct which represents a host / port pair for a socket. */ | | > | | 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | #endif /*! * @struct of_socket_address_t socket.h ObjFW/socket.h * * @brief A struct which represents a host / port pair for a socket. */ struct OF_BOXABLE of_socket_address_t { /* * Even though struct sockaddr contains the family, we need to use our * own family, as we need to support storing an IPv6 address on systems * that don't support IPv6. These may not have AF_INET6 defined and we * can't just define it, as the value is system-dependent and might * clash with an existing value. */ of_socket_address_family_t family; union { struct sockaddr sockaddr; struct sockaddr_in in; struct sockaddr_in6 in6; } sockaddr; socklen_t length; }; typedef struct of_socket_address_t of_socket_address_t; #ifdef __cplusplus extern "C" { #endif /*! * @brief Parses the specified IP and port into an of_socket_address_t. * |
︙ | ︙ |