summaryrefslogtreecommitdiff
path: root/vala/valagircomment.vala
blob: 10c1a7649941c3a02b7ec4785f77e31c9c2e1c2e (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
/* valagircomment.vala
 *
 * Copyright (C) 2011  Florian Brosch
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
 *
 * Author:
 * 	Florian Brosch <flo.brosch@gmail.com>
 */

using GLib;


/**
 * A documentation comment used by valadoc
 */
public class Vala.GirComment : Comment {
	private HashMap<string, Comment> parameter_content = new HashMap<string, Comment> ();

	public MapIterator<string, Comment> parameter_iterator () {
		return this.parameter_content.map_iterator ();
	}

	public Comment? return_content { get; set; }

	public GirComment (string? comment, SourceReference _source_reference) {
		base (comment ?? "", _source_reference);
	}

	internal void add_content_for_parameter (string name, Comment comment) {
		parameter_content.set (name, comment);
	}

	public Comment? get_content_for_parameter (string name) {
		return parameter_content.get (name);
	}
}