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
|
// Copyright (C) 2015 ycmd contributors
//
// This file is part of ycmd.
//
// ycmd is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// ycmd 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with ycmd. If not, see <http://www.gnu.org/licenses/>.
#ifndef DOCUMENTATION_H_POYSHVX8
#define DOCUMENTATION_H_POYSHVX8
#include <clang-c/Index.h>
#include <string>
namespace YouCompleteMe {
/// This class holds information useful for generating a documentation response
/// for a given cursor
struct DocumentationData {
/// Construct an empty object
DocumentationData() = default;
/// Construct and extract information from the supplied cursor. The cursor
/// should be pointing to a canonical declaration, such as returned by
/// clang_getCanonicalCursor( clang_getCursorReferenced( cursor ) )
explicit DocumentationData( const CXCursor &cursor );
/// XML data as parsed by libclang. This provides full semantic parsing of
/// doxygen-syntax comments.
std::string comment_xml;
/// The raw text of the comment preceding the declaration
std::string raw_comment;
/// The brief comment (either first paragraph or \brief) as parsed by libclang
std::string brief_comment;
/// The canonical type of the referenced cursor
std::string canonical_type;
/// The display name of the referenced cursor
std::string display_name;
bool operator == ( const DocumentationData &other ) const {
return comment_xml == other.comment_xml &&
raw_comment == other.raw_comment &&
brief_comment == other.brief_comment &&
canonical_type == other.canonical_type &&
display_name == other.display_name;
}
};
} // namespace YouCompleteMe
#endif /* end of include guard: DOCUMENTATION_H_POYSHVX8 */
|
