summaryrefslogtreecommitdiff
path: root/valadoc/tests/girwriter/girtest.vala
blob: a294b6d8233f54dc4c0d5390846adbb9f739f718 (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
[CCode (gir_namespace = "GirTest", gir_version = "1.0")]
namespace GirTest {
	/**
	 * An example comment for an example constant.
	 */
	public const int CONSTANT = 42;

	/**
	 * An example comment for an example function.
	 */
	public static void function () {
	}

	/**
	 * An example comment for an example struct.
	 */
	public struct StructTest {
		/**
		 * An example comment for an example field.
		 */
		public int field;
		/**
		 * An example comment for an example struct constructor.
		 *
		 * @param param An example comment for an example parameter.
		 */
		public StructTest (int param) {
		}
		/**
		 * An example comment for an example struct method.
		 *
		 * @param param An example comment for an example parameter.
		 * @return An example comment for an example return value.
		 */
		public bool method (int param) {
			return true;
		}
	}

	/**
	 * An example comment for an example enum.
	 */
	public enum EnumTest {
		VALUE1
	}

	/**
	 * An example comment for an example errordomain.
	 */
	public errordomain ErrorTest {
		VALUE1
	}

	/**
	 * An example comment for an example delegate.
	 *
	 * @param param An example comment for an example parameter.
	 * @return An example comment for an example return value.
	 */
	public delegate bool DelegateTest (int param);

	/**
	 * An example comment for an example interface.
	 */
	public interface InterfaceTest : Object {
		/**
		 * An example comment for an example interface method.
		 *
		 * @param param An example comment for an example parameter.
		 * @return An example comment for an example return value.
		 */
		public abstract bool method (int param);
	}

	/**
	 * An example comment for an example class.
	 */
	public class ObjectTest : Object {
		/**
		 * An example comment for an example property.
		 */
		public int property { get; construct set; }
		/**
		 * An example comment for an example signal.
		 *
		 * @param param An example comment for an example parameter.
		 */
		public signal void some_signal (int param);
		/**
		 * An example comment for an example class constructor.
		 *
		 * @param param An example comment for an example parameter.
		 */
		public ObjectTest (int param) {
		}
		/**
		 * An example comment for an example class method.
		 *
		 * @param param An example comment for an example parameter.
		 * @return An example comment for an example return value.
		 */
		public bool method (int param) {
			return true;
		}
	}
}