contrib/llvm/tools/clang/lib/Format/Comments.h

   1 //===--- Comments.cpp - Comment manipulation  -----------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 ///
  10 /// \file
  11 /// \brief Declares comment manipulation functionality.
  12 ///
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CLANG_LIB_FORMAT_COMMENTS_H
  16 #define LLVM_CLANG_LIB_FORMAT_COMMENTS_H
  17
  18 #include "clang/Basic/LLVM.h"
  19 #include "llvm/ADT/StringRef.h"
  20
  21 namespace clang {
  22 namespace format {
  23
  24 /// \brief Returns the comment prefix of the line comment \p Comment.
  25 ///
  26 /// The comment prefix consists of a leading known prefix, like "//" or "///",
  27 /// together with the following whitespace.
  28 StringRef getLineCommentIndentPrefix(StringRef Comment);
  29
  30 } // namespace format
  31 } // namespace clang
  32
  33 #endif