ObjFW  Check-in [d65fefedc7]

Overview
Comment:runtime: Document all types
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: d65fefedc7ce2387b92e7e8c08cd2218543ac814528f22744a20df51a37b6ca0
User & Date: js on 2020-05-30 15:33:12
Other Links: manifest | tags
References
2020-05-30
15:35 • Ticket [e6e31ea81f] Add documentation for runtime functions status still Open with 5 other changes artifact: 83f08ba9c9 user: js
Context
2020-05-31
03:37
Don't use @deprecated check-in: c1d50ed305 user: js tags: trunk
2020-05-30
15:33
runtime: Document all types check-in: d65fefedc7 user: js tags: trunk
14:35
Remove unnecessary imports of socket.h check-in: 9e03377177 user: js tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Modified Doxyfile from [91048eb344] to [51b1f8245c]. 

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
FILE_PATTERNS = *.h *.m
HTML_OUTPUT = .
GENERATE_LATEX = NO
HIDE_UNDOC_CLASSES = YES
HIDE_UNDOC_MEMBERS = YES
PREDEFINED = DOXYGEN				\

	     OF_BOXABLE				\
	     OF_CONSUMED			\
	     OF_DESIGNATED_INITIALIZER		\
	     OF_GENERIC(...)=			\
	     OF_HAVE_BLOCKS			\
	     OF_HAVE_FILES			\
	     OF_HAVE_SANDBOX			\



|





|
>








1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

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
PREDEFINED = __OBJC__				\
	     DOXYGEN				\
	     OF_BOXABLE				\
	     OF_CONSUMED			\
	     OF_DESIGNATED_INITIALIZER		\
	     OF_GENERIC(...)=			\
	     OF_HAVE_BLOCKS			\
	     OF_HAVE_FILES			\
	     OF_HAVE_SANDBOX			\
︙︙

Modified src/runtime/ObjFWRT.h from [ce979e873f] to [1afc7b2b50].

︙︙
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
74







75






76






77
78



79



80



81
82
83
84
85
86
87

# endif
#endif

#if !__has_feature(objc_arc) && !defined(__unsafe_unretained)
# define __unsafe_unretained
#endif




#define Nil (Class _Null_unspecified)0




#define nil (id _Null_unspecified)0






#define YES true






#define NO  false






typedef struct objc_class *Class;




typedef struct objc_object *id;







typedef const struct objc_selector *SEL;






typedef const struct objc_method *Method;
#ifdef __OBJC__




@class Protocol;
#else
typedef const struct objc_protocol *Protocol;
#endif




typedef const struct objc_ivar *Ivar;




typedef const struct objc_property *objc_property_t;

#if !defined(__wii__) && !defined(__amigaos__)





typedef bool BOOL;
#endif







typedef id _Nullable (*IMP)(id _Nonnull, SEL _Nonnull, ...);






typedef void (*objc_uncaught_exception_handler_t)(id _Nullable);






typedef void (*objc_enumeration_mutation_handler_t)(id _Nonnull);




struct objc_super {



	id __unsafe_unretained _Nullable self;



#ifdef __cplusplus
	Class _Nonnull class_;
#else
	Class _Nonnull class;
#endif
};









>
>
>

>
>
>
>

>
>
>
>
>
>

>
>
>
>
>
>
|

>
>
>
>
>

>
>
>
>

>
>
>
>
>
>
>

>
>
>
>
>
>

|
>
>
>
>




>
>
>
>

>
>
>
>

>

>
>
>
>
>


>
>
>
>
>
>
>
|
>
>
>
>
>
>
|
>
>
>
>
>
>
|

>
>
>

>
>
>

>
>
>








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
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
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

# endif
#endif

#if !__has_feature(objc_arc) && !defined(__unsafe_unretained)
# define __unsafe_unretained
#endif

/*!
 * @brief A value representing no class.
 */
#define Nil (Class _Null_unspecified)0

/*!
 * @brief A value representing no object.
 */
#define nil (id _Null_unspecified)0

/*!
 * @brief An Objective-C boolean representing true.
 *
 * @deprecated Use the standard C99 bool and true instead!
 */
#define YES true

/*!
 * @brief An Objective-C boolean representing false.
 *
 * @deprecated Use the standard C99 bool and false instead!
 */
#define NO false

/*! @file */

/*!
 * @brief A pointer to a class.
 */
typedef struct objc_class *Class;

/*!
 * @brief A pointer to any object.
 */
typedef struct objc_object *id;

/*!
 * @brief A selector.
 *
 * A selector is the name of a method including the colons and an optional type
 * encoding.
 */
typedef const struct objc_selector *SEL;

/*!
 * @brief A method.
 *
 * A method consists of a selector with a type encoding and an implementation.
 */
typedef const struct objc_method *Method;

/*!
 * @brief A protocol.
 */
#if defined(__OBJC__) && !defined(DOXYGEN)
@class Protocol;
#else
typedef const struct objc_protocol *Protocol;
#endif

/*!
 * @brief An instance variable.
 */
typedef const struct objc_ivar *Ivar;

/*!
 * @brief A property.
 */
typedef const struct objc_property *objc_property_t;

#if !defined(__wii__) && !defined(__amigaos__)
/*!
 * @brief An Objective-C boolean. Either @ref YES or @ref NO.
 *
 * @deprecated Use the standard C99 bool instead!
 */
typedef bool BOOL;
#endif

/*!
 * @brief A method implemenation.
 *
 * @param object The messaged object
 * @param selector The selector sent
 */
typedef id _Nullable (*IMP)(id _Nonnull object, SEL _Nonnull selector, ...);

/*!
 * @brief A handler for uncaught exceptions.
 *
 * @param exception The exception which was not caught.
 */
typedef void (*objc_uncaught_exception_handler_t)(id _Nullable exception);

/*!
 * @brief A handler for mutation during enumeration.
 *
 * @param object The object that was mutated during enumeration
 */
typedef void (*objc_enumeration_mutation_handler_t)(id _Nonnull object);

/*!
 * @brief A struct representing a call to super.
 */
struct objc_super {
	/*!
	 * @brief The object on which to perform the super call.
	 */
	id __unsafe_unretained _Nullable self;
	/*!
	 * @brief The class from which to take the method.
	 */
#ifdef __cplusplus
	Class _Nonnull class_;
#else
	Class _Nonnull class;
#endif
};
︙︙