mirror of
https://github.com/llvm/llvm-project.git
synced 2025-05-02 00:06:05 +00:00

This is similar to the LLVM change https://reviews.llvm.org/D46290. We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all. Patch produced by for i in $(git grep -l '\@brief'); do perl -pi -e 's/\@brief //g' $i & done for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done Differential Revision: https://reviews.llvm.org/D46320 llvm-svn: 331834
65 lines
1.9 KiB
C
65 lines
1.9 KiB
C
/*===-- clang-c/CXErrorCode.h - C Index Error Codes --------------*- C -*-===*\
|
|
|* *|
|
|
|* The LLVM Compiler Infrastructure *|
|
|
|* *|
|
|
|* This file is distributed under the University of Illinois Open Source *|
|
|
|* License. See LICENSE.TXT for details. *|
|
|
|* *|
|
|
|*===----------------------------------------------------------------------===*|
|
|
|* *|
|
|
|* This header provides the CXErrorCode enumerators. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_CLANG_C_CXERRORCODE_H
|
|
#define LLVM_CLANG_C_CXERRORCODE_H
|
|
|
|
#include "clang-c/Platform.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Error codes returned by libclang routines.
|
|
*
|
|
* Zero (\c CXError_Success) is the only error code indicating success. Other
|
|
* error codes, including not yet assigned non-zero values, indicate errors.
|
|
*/
|
|
enum CXErrorCode {
|
|
/**
|
|
* No error.
|
|
*/
|
|
CXError_Success = 0,
|
|
|
|
/**
|
|
* A generic error code, no further details are available.
|
|
*
|
|
* Errors of this kind can get their own specific error codes in future
|
|
* libclang versions.
|
|
*/
|
|
CXError_Failure = 1,
|
|
|
|
/**
|
|
* libclang crashed while performing the requested operation.
|
|
*/
|
|
CXError_Crashed = 2,
|
|
|
|
/**
|
|
* The function detected that the arguments violate the function
|
|
* contract.
|
|
*/
|
|
CXError_InvalidArguments = 3,
|
|
|
|
/**
|
|
* An AST deserialization error has occurred.
|
|
*/
|
|
CXError_ASTReadError = 4
|
|
};
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|
|
|