• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2019 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #include <vector>
18 
19 #include "AST.h"
20 #include "DocComment.h"
21 #include "Lint.h"
22 #include "LintRegistry.h"
23 
24 namespace android {
25 
unhandledComments(const AST & ast,std::vector<Lint> * errors)26 static void unhandledComments(const AST& ast, std::vector<Lint>* errors) {
27     for (const DocComment* docComment : ast.getUnhandledComments()) {
28         errors->push_back(
29                 Lint(WARNING, docComment->location())
30                 << "This comment cannot be processed since it is in an unrecognized "
31                 << "place in the file. Consider adding it as a multiline comment directly above an "
32                 << "interface, method, type declaration, enumerator, or field.\n");
33     }
34 }
35 
36 REGISTER_LINT(unhandledComments);
37 }  // namespace android
38