ObjFW  Changes To API Review for 1.0

Changes to "API Review for 1.0" between 2022-04-19 16:53:20 and 2022-04-20 13:10:45

1
2
3
4
5
6
7

8
9
10
11
12



13
14
15
16


17
18

19
20

21
22
23
24
25
26
27
28
29







30
31
32
33
34
35
36
1
2
3
4
5
6

7
8
9



10
11
12
13
14


15
16
17

18
19

20
21
22







23
24
25
26
27
28
29
30
31
32
33
34
35
36






-
+


-
-
-
+
+
+


-
-
+
+

-
+

-
+


-
-
-
-
-
-
-
+
+
+
+
+
+
+







# API Review for 1.0

For the 1.0 release, all APIs should be reviewed, as starting with 1.0, they are supposed to be stable. All documented methods, functions, classes, types and structs that are part of the installed headers are considered part of the API.

Right now, we have fhe following installed headers:

*  `ObjFW/macros.h`
*  `ObjFW/macros.h`
* ✅ `ObjFW/objfw-defs.h`
* ✅ `ObjFW/ObjFW.h`
*  `ObjFW/OFAcceptFailedException.h`
*  `ObjFW/OFAllocFailedException.h`
*  `ObjFW/OFAlreadyConnectedException.h`
*  `ObjFW/OFAcceptFailedException.h`
*  `ObjFW/OFAllocFailedException.h`
*  `ObjFW/OFAlreadyConnectedException.h`
* ❌ `ObjFW/OFApplication.h`
* ❌ `ObjFW/OFArray.h`
*  `ObjFW/OFAtomic.h`
*  `ObjFW/OFBindFailedException.h`
*  `ObjFW/OFAtomic.h`
*  `ObjFW/OFBindFailedException.h`
* ✅ `ObjFW/OFBlock.h`
*  `ObjFW/OFChangeCurrentDirectoryPathFailedException.h`
*  `ObjFW/OFChangeCurrentDirectoryPathFailedException.h`
* ❌ `ObjFW/OFCharacterSet.h`
*  `ObjFW/OFChecksumMismatchException.h`
*  `ObjFW/OFChecksumMismatchException.h`
* ✅ `ObjFW/OFCollection.h`
* ✅ `ObjFW/OFColor.h`
*  `ObjFW/OFConditionBroadcastFailedException.h`
*  `ObjFW/OFCondition.h`
*  `ObjFW/OFConditionSignalFailedException.h`
*  `ObjFW/OFConditionStillWaitingException.h`
*  `ObjFW/OFConditionWaitFailedException.h`
*  `ObjFW/OFConnectionFailedException.h`
*  `ObjFW/OFConstantString.h`
*  `ObjFW/OFConditionBroadcastFailedException.h`
*  `ObjFW/OFCondition.h`
*  `ObjFW/OFConditionSignalFailedException.h`
*  `ObjFW/OFConditionStillWaitingException.h`
*  `ObjFW/OFConditionWaitFailedException.h`
*  `ObjFW/OFConnectionFailedException.h`
*  `ObjFW/OFConstantString.h`
* ❌ `ObjFW/OFCopyItemFailedException.h`
* ❌ `ObjFW/OFCountedSet.h`
* ❌ `ObjFW/OFCreateDirectoryFailedException.h`
* ❌ `ObjFW/OFCreateSymbolicLinkFailedException.h`
* ❌ `ObjFW/OFCryptographicHash.h`
* ❌ `ObjFW/OFData+CryptographicHashing.h`
* ❌ `ObjFW/OFDatagramSocket.h`
207
208
209
210
211
212
213
214
215


216
217
218
219



220
221
207
208
209
210
211
212
213


214
215
216



217
218
219
220
221







-
-
+
+

-
-
-
+
+
+


* ❌ `ObjFW/OFXMLElement.h`
* ❌ `ObjFW/OFXMLElement+Serialization.h`
* ✅ `ObjFW/OFXMLNode.h`
* ✅ `ObjFW/OFXMLParser.h`
* ❌ `ObjFW/OFXMLProcessingInstruction.h`
* ❌ `ObjFW/OFZIPArchiveEntry.h`
* ❌ `ObjFW/OFZIPArchive.h`
*  `ObjFW/platform/GCC4.7/OFAtomic.h`
*  `ObjFW/platform/GCC4/OFAtomic.h`
*  `ObjFW/platform/GCC4.7/OFAtomic.h`
*  `ObjFW/platform/GCC4/OFAtomic.h`
* ❌ `ObjFW/platform.h`
*  `ObjFW/platform/macOS/OFAtomic.h`
*  `ObjFW/platform/PowerPC/OFAtomic.h`
*  `ObjFW/platform/x86/OFAtomic.h`
*  `ObjFW/platform/macOS/OFAtomic.h`
*  `ObjFW/platform/PowerPC/OFAtomic.h`
*  `ObjFW/platform/x86/OFAtomic.h`
* ❌ `ObjFWRT/ObjFWRT.h`
* ❌ `ObjFWTLS/ObjFWTLS.h`