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
|
/* taglet.vala
*
* Copyright (C) 2008-2009 Didier Villevalois
* Copyright (C) 2008-2012 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:
* Didier 'Ptitjes Villevalois <ptitjes@free.fr>
*/
using Valadoc.Content;
public class Valadoc.Taglets.Return : BlockContent, Taglet, Block {
public Rule? get_parser_rule (Rule run_rule) {
return run_rule;
}
public override void check (Api.Tree api_root, Api.Node container, string file_path,
ErrorReporter reporter, Settings settings) {
Api.TypeReference? type_ref = null;
bool creation_method = false;
if (container is Api.Method) {
creation_method = ((Api.Method) container).is_constructor;
type_ref = ((Api.Method) container).return_type;
} else if (container is Api.Callable) {
type_ref = ((Api.Callable) container).return_type;
} else {
reporter.simple_warning ("%s: %s: @return".printf (file_path, container.get_full_name ()),
"@return used outside method/delegate/signal context");
}
if (type_ref != null && type_ref.data_type == null && !creation_method) {
reporter.simple_warning ("%s: %s: @return".printf (file_path, container.get_full_name ()),
"Return description declared for void function");
}
base.check (api_root, container, file_path, reporter, settings);
}
public override void accept (ContentVisitor visitor) {
visitor.visit_taglet (this);
}
public Vala.List<ContentElement>? get_inheritable_documentation () {
return content;
}
public bool inheritable (Taglet taglet) {
return taglet is Taglets.Return;
}
public override ContentElement copy (ContentElement? new_parent = null) {
Return ret = new Return ();
ret.parent = new_parent;
foreach (Block element in content) {
Block copy = element.copy (ret) as Block;
ret.content.add (copy);
}
return ret;
}
}
|
