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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
//==--- DiagnosticCommentKinds.td - diagnostics related to comments -------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
let Component = "Comment" in {
let CategoryName = "Documentation Issue" in {
// HTML parsing errors. These are under -Wdocumentation to make sure the user
// knows that we didn't parse something as he might expect.
def warn_doc_html_start_tag_expected_quoted_string : Warning<
"expected quoted string after equals sign">,
InGroup<Documentation>, DefaultIgnore;
def warn_doc_html_start_tag_expected_ident_or_greater : Warning<
"HTML start tag prematurely ended, expected attribute name or '>'">,
InGroup<Documentation>, DefaultIgnore;
def note_doc_html_tag_started_here : Note<
"HTML tag started here">;
// HTML semantic errors
def warn_doc_html_end_forbidden : Warning<
"HTML end tag '%0' is forbidden">,
InGroup<DocumentationHTML>, DefaultIgnore;
def warn_doc_html_end_unbalanced : Warning<
"HTML end tag does not match any start tag">,
InGroup<DocumentationHTML>, DefaultIgnore;
def warn_doc_html_start_end_mismatch : Warning<
"HTML start tag '%0' closed by '%1'">,
InGroup<DocumentationHTML>, DefaultIgnore;
def note_doc_html_end_tag : Note<
"end tag">;
// Commands
def warn_doc_block_command_empty_paragraph : Warning<
"empty paragraph passed to '\\%0' command">,
InGroup<Documentation>, DefaultIgnore;
def warn_doc_block_command_duplicate : Warning<
"duplicated command '\\%0'">,
InGroup<Documentation>, DefaultIgnore;
def note_doc_block_command_previous : Note<
"previous command '\\%0' here">;
def note_doc_block_command_previous_alias : Note<
"previous command '\\%0' (an alias of '\\%1') here">;
// \param command
def warn_doc_param_invalid_direction : Warning<
"unrecognized parameter passing direction, "
"valid directions are '[in]', '[out]' and '[in,out]'">,
InGroup<Documentation>, DefaultIgnore;
def warn_doc_param_spaces_in_direction : Warning<
"whitespace is not allowed in parameter passing direction">,
InGroup<DocumentationPedantic>, DefaultIgnore;
def warn_doc_param_not_attached_to_a_function_decl : Warning<
"'\\param' command used in a comment that is not attached to "
"a function declaration">,
InGroup<Documentation>, DefaultIgnore;
def warn_doc_param_duplicate : Warning<
"parameter '%0' is already documented">,
InGroup<Documentation>, DefaultIgnore;
def note_doc_param_previous : Note<
"previous documentation">;
def warn_doc_param_not_found : Warning<
"parameter '%0' not found in the function declaration">,
InGroup<Documentation>, DefaultIgnore;
def note_doc_param_name_suggestion : Note<
"did you mean '%0'?">;
// \tparam command
def warn_doc_tparam_not_attached_to_a_template_decl : Warning<
"'\\tparam' command used in a comment that is not attached to "
"a template declaration">,
InGroup<Documentation>, DefaultIgnore;
def warn_doc_tparam_duplicate : Warning<
"template parameter '%0' is already documented">,
InGroup<Documentation>, DefaultIgnore;
def note_doc_tparam_previous : Note<
"previous documentation">;
def warn_doc_tparam_not_found : Warning<
"template parameter '%0' not found in the template declaration">,
InGroup<Documentation>, DefaultIgnore;
def note_doc_tparam_name_suggestion : Note<
"did you mean '%0'?">;
// \returns command
def warn_doc_returns_not_attached_to_a_function_decl : Warning<
"'\\%0' command used in a comment that is not attached to "
"a function or method declaration">,
InGroup<Documentation>, DefaultIgnore;
def warn_doc_returns_attached_to_a_void_function : Warning<
"'\\%0' command used in a comment that is attached to a "
"%select{function returning void|constructor|destructor|"
"method returning void}1">,
InGroup<Documentation>, DefaultIgnore;
} // end of documentation issue category
} // end of AST component
|
