llvm/clang/tools/libclang/CXComment.cpp

//===- CXComment.cpp - libclang APIs for manipulating CXComments ----------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines all libclang APIs related to walking comment AST.
//
//===----------------------------------------------------------------------===//

#include "CXComment.h"
#include "CXCursor.h"
#include "CXString.h"
#include "clang-c/Documentation.h"
#include "clang-c/Index.h"
#include "clang/AST/Decl.h"
#include "clang/Index/CommentToXML.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/Support/ErrorHandling.h"
#include <climits>

usingnamespaceclang;
usingnamespaceclang::comments;
usingnamespaceclang::cxcomment;

CXComment clang_Cursor_getParsedComment(CXCursor C) { … }

enum CXCommentKind clang_Comment_getKind(CXComment CXC) { … }

unsigned clang_Comment_getNumChildren(CXComment CXC) { … }

CXComment clang_Comment_getChild(CXComment CXC, unsigned ChildIdx) { … }

unsigned clang_Comment_isWhitespace(CXComment CXC) { … }

unsigned clang_InlineContentComment_hasTrailingNewline(CXComment CXC) { … }

CXString clang_TextComment_getText(CXComment CXC) { … }

CXString clang_InlineCommandComment_getCommandName(CXComment CXC) { … }

enum CXCommentInlineCommandRenderKind
clang_InlineCommandComment_getRenderKind(CXComment CXC) { … }

unsigned clang_InlineCommandComment_getNumArgs(CXComment CXC) { … }

CXString clang_InlineCommandComment_getArgText(CXComment CXC,
                                               unsigned ArgIdx) { … }

CXString clang_HTMLTagComment_getTagName(CXComment CXC) { … }

unsigned clang_HTMLStartTagComment_isSelfClosing(CXComment CXC) { … }

unsigned clang_HTMLStartTag_getNumAttrs(CXComment CXC) { … }

CXString clang_HTMLStartTag_getAttrName(CXComment CXC, unsigned AttrIdx) { … }

CXString clang_HTMLStartTag_getAttrValue(CXComment CXC, unsigned AttrIdx) { … }

CXString clang_BlockCommandComment_getCommandName(CXComment CXC) { … }

unsigned clang_BlockCommandComment_getNumArgs(CXComment CXC) { … }

CXString clang_BlockCommandComment_getArgText(CXComment CXC,
                                              unsigned ArgIdx) { … }

CXComment clang_BlockCommandComment_getParagraph(CXComment CXC) { … }

CXString clang_ParamCommandComment_getParamName(CXComment CXC) { … }

unsigned clang_ParamCommandComment_isParamIndexValid(CXComment CXC) { … }

unsigned clang_ParamCommandComment_getParamIndex(CXComment CXC) { … }

unsigned clang_ParamCommandComment_isDirectionExplicit(CXComment CXC) { … }

enum CXCommentParamPassDirection clang_ParamCommandComment_getDirection(
                                                            CXComment CXC) { … }

CXString clang_TParamCommandComment_getParamName(CXComment CXC) { … }

unsigned clang_TParamCommandComment_isParamPositionValid(CXComment CXC) { … }

unsigned clang_TParamCommandComment_getDepth(CXComment CXC) { … }

unsigned clang_TParamCommandComment_getIndex(CXComment CXC, unsigned Depth) { … }

CXString clang_VerbatimBlockLineComment_getText(CXComment CXC) { … }

CXString clang_VerbatimLineComment_getText(CXComment CXC) { … }

//===----------------------------------------------------------------------===//
// Converting comments to XML.
//===----------------------------------------------------------------------===//

CXString clang_HTMLTagComment_getAsString(CXComment CXC) { … }

CXString clang_FullComment_getAsHTML(CXComment CXC) { … }

CXString clang_FullComment_getAsXML(CXComment CXC) { … }