Comment: | Clean up struct and enum typedefs
With TYPEDEF_HIDES_STRUCT set, Doxygen properly handles anonymous |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
2fcf5a3052f5e5cfb816d127e8e3835b |
User & Date: | js on 2021-04-29 23:24:22 |
Other Links: | manifest | tags |
2021-04-29
| ||
23:30 | Disable Clang's incorrect -Wdocumentation warning check-in: 026f74d7a7 user: js tags: trunk | |
23:24 | Clean up struct and enum typedefs check-in: 2fcf5a3052 user: js tags: trunk | |
22:56 | Fix Doxygen warnings check-in: 5e985aa805 user: js tags: trunk | |
Modified Doxyfile from [51b1f8245c] to [c1793ad29f].
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | + | PROJECT_NAME = "ObjFW" OUTPUT_DIRECTORY = docs/ INPUT = src src/exceptions src/runtime FILE_PATTERNS = *.h *.m HTML_OUTPUT = . GENERATE_LATEX = NO HIDE_UNDOC_CLASSES = YES HIDE_UNDOC_MEMBERS = YES TYPEDEF_HIDES_STRUCT = YES PREDEFINED = __OBJC__ \ DOXYGEN \ OF_BOXABLE \ OF_CONSUMED \ OF_DESIGNATED_INITIALIZER \ OF_GENERIC(...)= \ OF_HAVE_BLOCKS \ |
︙ |
Modified src/OFArray.h from [091ccdd3f4] to [0789a761b0].
︙ | |||
36 37 38 39 40 41 42 | 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | - + + + + + + - + + | @class OFString; /** * @brief Options for joining the objects of an array. * * This is a bit mask. */ |
︙ |
Modified src/OFDNSResolver.h from [9570988a05] to [d50442556a].
︙ | |||
36 37 38 39 40 41 42 | 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | - + | @class OFUDPSocket; /** * @enum OFDNSResolverErrorCode OFDNSResolver.h ObjFW/OFDNSResolver.h * * @brief An enum describing why resolving a host failed. */ |
︙ |
Modified src/OFDNSResourceRecord.h from [d9a4125a07] to [5d78beeb65].
︙ | |||
23 24 25 26 27 28 29 | 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 | - + - + | @class OFArray OF_GENERIC(ObjectType); @class OFData; /** * @brief The DNS class. */ |
︙ |
Modified src/OFData.h from [654367484b] to [adb3c41f53].
︙ | |||
25 26 27 28 29 30 31 | 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | - + | @class OFURL; /** * @brief Options for searching in data. * * This is a bit mask. */ |
︙ |
Modified src/OFFile.h from [7c5aab04f3] to [bac13481b9].
︙ | |||
17 18 19 20 21 22 23 | 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | - + | #import "OFKernelEventObserver.h" #ifndef OF_AMIGAOS # define OF_FILE_HANDLE_IS_FD typedef int OFFileHandle; static const OFFileHandle OFInvalidFileHandle = -1; #else |
︙ |
Modified src/OFFile.m from [cd41ef981c] to [e28a8564db].
︙ | |||
75 76 77 78 79 80 81 | 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | - - + + | #ifndef O_EXLOCK # define O_EXLOCK 0 #endif #ifndef OF_AMIGAOS # define closeHandle(h) close(h) #else |
︙ |
Modified src/OFGZIPStream.h from [dc70b7b057] to [498f0a4cf5].
︙ | |||
19 20 21 22 23 24 25 | 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | - + | @class OFInflateStream; OF_ASSUME_NONNULL_BEGIN /** * @brief The operating system on which compressed the data. */ |
︙ |
Modified src/OFHTTPRequest.h from [28493df649] to [e5c26eec6f].
︙ | |||
25 26 27 28 29 30 31 | 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | - + | @class OFString; /** @file */ /** * @brief The type of an HTTP request. */ |
︙ | |||
49 50 51 52 53 54 55 | 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | - + - - + | } OFHTTPRequestMethod; /** * @struct OFHTTPRequestProtocolVersion OFHTTPRequest.h ObjFW/OFHTTPRequest.h * * @brief The HTTP version of the HTTP request. */ |
︙ |
Modified src/OFHuffmanTree.h from [694631f046] to [fd05cd38a9].
︙ | |||
18 19 20 21 22 23 24 | 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | - - + + - + - + - + | #import "macros.h" #import "OFInvalidFormatException.h" OF_ASSUME_NONNULL_BEGIN |
︙ | |||
51 52 53 54 55 56 57 | 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | - + - - + + | *value = iter->value; return true; } #ifdef __cplusplus extern "C" { #endif |
Modified src/OFHuffmanTree.m from [e08b704a74] to [f7a4f8d9de].
︙ | |||
19 20 21 22 23 24 25 | 19 20 21 22 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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | - + - + - + - + - + | #include <stdlib.h> #import "OFHuffmanTree.h" #import "OFInvalidFormatException.h" #import "OFOutOfMemoryException.h" |
︙ | |||
104 105 106 107 108 109 110 | 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | - + - + - + | OFFreeMemory(lengthCount); OFFreeMemory(nextCode); } return tree; } |
Modified src/OFInflate64Stream.h from [ff42990035] to [a6bacf7fa9].
︙ | |||
47 48 49 50 51 52 53 | 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 | - - - - + + + + - - - + + + | uint8_t position; uint8_t length[4]; } uncompressedHeader; struct { uint16_t position, length; } uncompressed; struct { |
︙ |
Modified src/OFInflateStream.h from [6239bc3935] to [f8763882fa].
︙ | |||
47 48 49 50 51 52 53 | 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 | - - - - + + + + - - - + + + | uint8_t position; uint8_t length[4]; } uncompressedHeader; struct { uint16_t position, length; } uncompressed; struct { |
︙ |
Modified src/OFInflateStream.m from [94ff1319c4] to [ddc6f9f77f].
︙ | |||
95 96 97 98 99 100 101 | 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | - + | 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9, 10, 10, 11, 11, 12, 12, 13, 13, 14, 14 }; #endif static const uint8_t codeLengthsOrder[19] = { 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 }; |
︙ |
Modified src/OFJSONRepresentation.h from [a068535d8e] to [02ee58f172].
︙ | |||
18 19 20 21 22 23 24 | 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | - + | @class OFString; OF_ASSUME_NONNULL_BEGIN /** * @brief Options to change the behavior when creating a JSON representation. */ |
︙ |
Modified src/OFLHADecompressingStream.h from [4239b91057] to [50abfd9a4a].
︙ | |||
31 32 33 34 35 36 37 | 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | - - + + + + | uint8_t _byte; uint8_t _bitIndex, _savedBitsLength; uint16_t _savedBits; unsigned char *_slidingWindow; uint32_t _slidingWindowIndex, _slidingWindowMask; int _state; uint16_t _symbolsLeft; |
︙ |
Modified src/OFList.h from [17d81c5b14] to [d971682e08].
︙ | |||
19 20 21 22 23 24 25 | 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | - + - + | #import "OFSerialization.h" OF_ASSUME_NONNULL_BEGIN /** @file */ /** |
︙ |
Modified src/OFList.m from [71b5abf54f] to [75ee6d9e19].
︙ | |||
22 23 24 25 26 27 28 | 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | - - + + | #import "OFString.h" #import "OFXMLElement.h" #import "OFArray.h" #import "OFEnumerationMutationException.h" #import "OFInvalidArgumentException.h" |
︙ |
Modified src/OFMapTable.h from [0dfbcfb542] to [67af88b431].
︙ | |||
21 22 23 24 25 26 27 | 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | - + - - + | /** @file */ /** * @struct OFMapTableFunctions OFMapTable.h ObjFW/OFMapTable.h * * @brief A struct describing the functions to be used by the map table. */ |
︙ |
Modified src/OFObject.h from [d972931bb6] to [f1db17a081].
︙ | |||
50 51 52 53 54 55 56 | 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 | - + - + - + - + - - + | OF_ASSUME_NONNULL_BEGIN /** @file */ /** * @brief A result of a comparison. */ |
︙ | |||
143 144 145 146 147 148 149 | 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | - + - - + | typedef double OFTimeInterval; /** * @struct OFPoint OFObject.h ObjFW/OFObject.h * * @brief A point. */ |
︙ | |||
190 191 192 193 194 195 196 | 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | - + - - + | } /** * @struct OFSize OFObject.h ObjFW/OFObject.h * * @brief A size. */ |
︙ | |||
237 238 239 240 241 242 243 | 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | - + - - + | } /** * @struct OFRect OFObject.h ObjFW/OFObject.h * * @brief A rectangle. */ |
︙ |
Modified src/OFOptionsParser.h from [84a06358b9] to [aa712b561c].
︙ | |||
21 22 23 24 25 26 27 | 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | - + | OF_ASSUME_NONNULL_BEGIN /** * @struct OFOptionsParserOption OFOptionsParser.h ObjFW/OFOptionsParser.h * * @brief An option which can be parsed by an @ref OFOptionsParser. */ |
︙ | |||
53 54 55 56 57 58 59 | 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | - - + | 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; |
︙ |
Modified src/OFPBKDF2.h from [bc04db6a17] to [31c9840de8].
︙ | |||
27 28 29 30 31 32 33 | 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | - + | /** @file */ @class OFHMAC; /** * @brief The parameters for @ref OFPBKDF2. */ |
︙ |
Modified src/OFPlainThread.h from [9dd4ef3d72] to [8049a183fa].
︙ | |||
40 41 42 43 44 45 46 | 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | - + | struct SignalSemaphore semaphore; struct Task *joinTask; unsigned char joinSigBit; bool detached, done; } *OFPlainThread; #endif |
︙ |
Modified src/OFPlugin.h from [0127a43dd2] to [c9f7beee37].
︙ | |||
17 18 19 20 21 22 23 | 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | - + - + | @class OFString; #ifndef OF_WINDOWS # include <dlfcn.h> typedef void *OFPluginHandle; |
︙ |
Modified src/OFScrypt.h from [92dd465a18] to [77947b171a].
︙ | |||
27 28 29 30 31 32 33 | 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | - + | /** @file */ @class OFHMAC; /** * @brief The parameters for @ref OFScrypt. */ |
︙ |
Modified src/OFSocket.h from [f49763d210] to [2b4aae9d25].
︙ | |||
126 127 128 129 130 131 132 | 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | - + - - + | #endif /** * @struct OFSocketAddress OFSocket.h ObjFW/OFSocket.h * * @brief A struct which represents a host / port pair for a socket. */ |
︙ |
Modified src/OFString.h from [b4ac5f8ea5] to [e4caed5e17].
︙ | |||
61 62 63 64 65 66 67 | 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 | - + | typedef uint_least32_t OFChar32; #endif typedef OFChar32 OFUnichar; /** * @brief The encoding of a string. */ |
︙ | |||
103 104 105 106 107 108 109 | 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | - + - + | } OFStringEncoding; /** * @brief Options for searching in strings. * * This is a bit mask. */ |
︙ |
Modified src/OFTLSKey.h from [7ddd0f3e02] to [befb515045].
︙ | |||
32 33 34 35 36 37 38 | 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | - + - + | #elif defined(OF_WINDOWS) # include <windows.h> typedef DWORD OFTLSKey; #elif defined(OF_MORPHOS) # include <proto/exec.h> typedef ULONG OFTLSKey; #elif defined(OF_AMIGAOS) |
︙ |
Modified src/OFTarArchiveEntry.h from [5715325220] to [933ac56d6f].
︙ | |||
20 21 22 23 24 25 26 | 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | - + | /** @file */ @class OFDate; /** * @brief The type of the archive entry. */ |
︙ |
Modified src/OFZIPArchiveEntry.h from [79b0008ba2] to [e18b985df3].
︙ | |||
15 16 17 18 19 20 21 | 15 16 17 18 19 20 21 22 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 | - + - + | #import "OFObject.h" OF_ASSUME_NONNULL_BEGIN /** @file */ |
︙ | |||
80 81 82 83 84 85 86 | 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | - + | /** OS X (Darwin) */ OFZIPArchiveEntryAttributeCompatibilityOSX = 19 } OFZIPArchiveEntryAttributeCompatibility; /** * @brief Tags for the extra field. */ |
︙ |
Modified src/exceptions/OFException.m from [d414760729] to [5ced4219b2].
︙ | |||
45 46 47 48 49 50 51 | 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | - + | # define HAVE_ARM_EHABI_EXCEPTIONS #endif struct _Unwind_Context; typedef enum { _URC_OK = 0, _URC_END_OF_STACK = 5 |
︙ |