summaryrefslogtreecommitdiffstats
path: root/examples/manual.c
blob: fac6832773a839a33d9a0852393b317e6913e238 (plain)
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
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/**
 * \file manual.c
 */

typedef struct Object Object;   //!< Object type
typedef struct Vehicle Vehicle; //!< Vehicle type
typedef struct Car Car;         //!< Car type
typedef struct Truck Truck;     //!< Truck type

/*!
 * Base object class.
 */
struct Object
{
  int ref;    //!< \private Reference count.
};


/*!
 * Increments object reference count by one.
 * \public \memberof Object
 */
static Object * objRef(Object *obj);


/*!
 * Decrements object reference count by one.
 * \public \memberof Object
 */
static Object * objUnref(Object *obj);


/*!
 * Vehicle class.
 * \extends Object
 */
struct Vehicle
{
  Object base;    //!< \protected Base class.
};


/*!
 * Starts the vehicle.
 * \public \memberof Vehicle
 */
void vehicleStart(Vehicle *obj);


/*!
 * Stops the vehicle.
 * \public \memberof Vehicle
 */
void vehicleStop(Vehicle *obj);


/*!
 * Car class.
 * \extends Vehicle
 */
struct Car
{
  Vehicle base;    //!< \protected Base class.
};


/*!
 * Truck class.
 * \extends Vehicle
 */
struct Truck
{
  Vehicle base;    //!< \protected Base class.
};


/*!
 * Main function.
 *
 * Ref vehicleStart(), objRef(), objUnref().
 */
int main(void)
{
  Car c;
  vehicleStart((Vehicle*) &c);
}