/simpletypesystem/trunk

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/simpletypesystem/trunk

« back to all changes in this revision

Viewing changes to src/Box.h

  • Committer: Gustav Hartvigsson
  • Date: 2015-04-09 18:45:12 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20150409184512-fn8m3f26mzsqdy4n
* Started to structuce the dectumentation a little better.
* Added Callback.[c,h] which will contain the methods to add callbacks to SObjects.
  This is still a work it pregross.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/Box.h
4
4
#include "baseobject.h"
5
5
#include "Func.h"
6
6
 
 
7
BEGIN_DECLS
 
8
 
7
9
/** @file
 
10
 * @defgroup SBox SBox
 
11
 * @addtogroup SBox
 
12
 * @{
8
13
 * An SBox is a boxed type.
9
14
 */
10
15
 
11
 
BEGIN_DECLS
12
16
 
13
17
/** @brief
14
 
 * A reference counted box sitting on top of an SObject
 
18
 * A reference counted box sitting on top of an SObject.
15
19
 */
16
20
typedef struct SBox SBox;
17
21
 
46
50
 *
47
51
 * @param box The SBox to be freed.
48
52
 *
49
 
 * @warn Freeing an SBox will free the object that is held by it.
 
53
 * @warning Freeing an SBox will free the object that is held by it.
50
54
 */
51
55
void s_box_free (SBox * box);
52
56
 
70
74
 * @param box The SBox to get the type name from.
71
75
 * @return A String containing the name of the type.
72
76
 * 
73
 
 * @warn caller must free the string.
 
77
 * @note caller must free the string.
74
78
 */
75
79
char * s_box_get_object_type_name (SBox * box);
76
80
 
 
81
/** @} */
 
82
 
77
83
END_DECLS
78
84
 
79
85
#endif