Overview
| Comment: | Fix all Doxygen warnings
Mostly because Doxygen fails to find references to things that *do* |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA3-256: |
240eccca97624e77ac99671f6608826f |
| User & Date: | js on 2020-04-12 11:43:08 |
| Other Links: | manifest | tags |
Context
|
2020-04-12
| ||
| 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) | |
|
2020-04-11
| ||
| 23:10 | OFLocale: Support for translated plurals (check-in: 7fa757534a user: js tags: trunk) | |
Changes
Modified src/OFArray.h from [fea61523da] to [82b5ea76b0].
| ︙ | ︙ | |||
384 385 386 387 388 389 390 | withObject: (nullable id)object; /*! * @brief Returns a copy of the array sorted using the specified selector and * options. * * @param selector The selector to use to sort the array. It's signature | | | 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 | withObject: (nullable id)object; /*! * @brief Returns a copy of the array sorted using the specified selector and * options. * * @param selector The selector to use to sort the array. It's signature * should be the same as that of -[compare:]. * @param options The options to use when sorting the array.@n * Possible values are: * Value | Description * ---------------------------|------------------------- * `OF_ARRAY_SORT_DESCENDING` | Sort in descending order * @return A sorted copy of the array */ |
| ︙ | ︙ |
Modified src/OFDNSResponse.h from [156cc97081] to [12af35aca6].
| ︙ | ︙ | |||
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 |
* an array of @ref OFDNSResourceRecord.
*/
@property (readonly, nonatomic) of_dns_response_records_t additionalRecords;
/*!
* @brief Creates a new, autoreleased OFDNSResponse.
*
* @param answerRecords The answer records of the response
* @param authorityRecords The authority records of the response
* @param additionalRecords The additional records of the response
* @return A new, autoreleased OFDNSResponse
*/
+ (instancetype)
responseWithDomainName: (OFString *)domainName
answerRecords: (of_dns_response_records_t)answerRecords
authorityRecords: (of_dns_response_records_t)authorityRecords
additionalRecords: (of_dns_response_records_t)additionalRecords;
/*!
* @brief Initializes an already allocated OFDNSResponse.
*
* @param answerRecords The answer records of the response
* @param authorityRecords The authority records of the response
* @param additionalRecords The additional records of the response
* @return An initialized OFDNSResponse
*/
- (instancetype)
initWithDomainName: (OFString *)domainName
| > > | 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 |
* an array of @ref OFDNSResourceRecord.
*/
@property (readonly, nonatomic) of_dns_response_records_t additionalRecords;
/*!
* @brief Creates a new, autoreleased OFDNSResponse.
*
* @param domainName The domain name the response is for
* @param answerRecords The answer records of the response
* @param authorityRecords The authority records of the response
* @param additionalRecords The additional records of the response
* @return A new, autoreleased OFDNSResponse
*/
+ (instancetype)
responseWithDomainName: (OFString *)domainName
answerRecords: (of_dns_response_records_t)answerRecords
authorityRecords: (of_dns_response_records_t)authorityRecords
additionalRecords: (of_dns_response_records_t)additionalRecords;
/*!
* @brief Initializes an already allocated OFDNSResponse.
*
* @param domainName The domain name the response is for
* @param answerRecords The answer records of the response
* @param authorityRecords The authority records of the response
* @param additionalRecords The additional records of the response
* @return An initialized OFDNSResponse
*/
- (instancetype)
initWithDomainName: (OFString *)domainName
|
| ︙ | ︙ |
Modified src/OFFileManager.h from [3b9bb8eaec] to [832085a76a].
| ︙ | ︙ | |||
138 139 140 141 142 143 144 | * * For convenience, a category on @ref OFDictionary is provided to access this * via @ref OFDictionary#filePOSIXGID. */ extern const of_file_attribute_key_t of_file_attribute_key_posix_gid; /*! | | | | 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | * * For convenience, a category on @ref OFDictionary is provided to access this * via @ref OFDictionary#filePOSIXGID. */ extern const of_file_attribute_key_t of_file_attribute_key_posix_gid; /*! * @brief The owner of the file as an OFString. * * For convenience, a category on @ref OFDictionary is provided to access this * via @ref OFDictionary#fileOwner. */ extern const of_file_attribute_key_t of_file_attribute_key_owner; /*! * @brief The group of the file as an OFString. * * For convenience, a category on @ref OFDictionary is provided to access this * via @ref OFDictionary#fileGroup. */ extern const of_file_attribute_key_t of_file_attribute_key_group; /*! |
| ︙ | ︙ | |||
186 187 188 189 190 191 192 | * * For convenience, a category on @ref OFDictionary is provided to access this * via @ref OFDictionary#fileCreationDate. */ extern const of_file_attribute_key_t of_file_attribute_key_creation_date; /*! | | | 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
*
* For convenience, a category on @ref OFDictionary is provided to access this
* via @ref OFDictionary#fileCreationDate.
*/
extern const of_file_attribute_key_t of_file_attribute_key_creation_date;
/*!
* @brief The destination of a symbolic link as an OFString.
*
* For convenience, a category on @ref OFDictionary is provided to access this
* via @ref OFDictionary#fileSymbolicLinkDestination.
*/
extern const of_file_attribute_key_t
of_file_attribute_key_symbolic_link_destination;
|
| ︙ | ︙ |
Modified src/OFMutableArray.h from [9d4047891f] to [5d8e847393].
| ︙ | ︙ | |||
200 201 202 203 204 205 206 | */ - (void)sort; /*! * @brief Sorts the array using the specified selector and options. * * @param selector The selector to use to sort the array. It's signature | | | 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | */ - (void)sort; /*! * @brief Sorts the array using the specified selector and options. * * @param selector The selector to use to sort the array. It's signature * should be the same as that of -[compare:]. * @param options The options to use when sorting the array.@n * Possible values are: * Value | Description * ---------------------------|------------------------- * `OF_ARRAY_SORT_DESCENDING` | Sort in descending order */ - (void)sortUsingSelector: (SEL)selector |
| ︙ | ︙ |
Modified src/OFMutableDictionary.h from [50c90d0e94] to [ceac8e2f46].
| ︙ | ︙ | |||
64 65 66 67 68 69 70 | * @return An initialized OFMutableDictionary */ - (instancetype)initWithCapacity: (size_t)capacity; /*! * @brief Sets an object for a key. * | | | | 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 | * @return An initialized OFMutableDictionary */ - (instancetype)initWithCapacity: (size_t)capacity; /*! * @brief Sets an object for a key. * * A key can be any object that conforms to the OFCopying protocol. * * @param key The key to set * @param object The object to set the key to */ - (void)setObject: (ObjectType)object forKey: (KeyType)key; /*! * @brief Sets an object for a key. * * A key can be any object that conforms to the OFCopying protocol. * * This method is also used by the subscripting syntax. * * @param key The key to set * @param object The object to set the key to. If it is nil, this is equal to * calling @ref removeObjectForKey:. */ |
| ︙ | ︙ |
Modified src/OFOptionsParser.h from [0f3268b0df] to [d86c6c9090].
| ︙ | ︙ | |||
51 52 53 54 55 56 57 | /*! * An optional pointer to a bool that is set to whether the option has * been specified. */ bool *_Nullable isSpecifiedPtr; /*! | | | 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | /*! * An optional pointer to a bool that is set to whether the option has * been specified. */ 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; } of_options_parser_option_t; /*! * @class OFOptionsParser OFOptionsParser.h ObjFW/OFOptionsParser.h |
| ︙ | ︙ |
Modified src/OFSecureData.h from [994e2ce1cc] to [1f5cbd3690].
| ︙ | ︙ | |||
23 24 25 26 27 28 29 | * @class OFSecureData OFSecureData.h ObjFW/OFSecureData.h * * @brief A class for storing arbitrary data in secure (non-swappable) memory, * securely wiping it when it gets deallocated. * * @warning Non-swappable memory might be unavailable, in which case this falls * back to swappable memory, but still wipes the data when it gets | | | > | 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
* @class OFSecureData OFSecureData.h ObjFW/OFSecureData.h
*
* @brief A class for storing arbitrary data in secure (non-swappable) memory,
* securely wiping it when it gets deallocated.
*
* @warning Non-swappable memory might be unavailable, in which case this falls
* back to swappable memory, but still wipes the data when it gets
* deallocated. Check the @ref allowsSwappableMemory property to see
* whether a particular OFSecureData might be allocated in swappable
* memory.
*/
OF_SUBCLASSING_RESTRICTED
@interface OFSecureData: OFData
{
struct page *_page;
bool _allowsSwappableMemory;
}
|
| ︙ | ︙ |