replica
/
hanchenye-llvm-project
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Index.h: Tweak comments, delete trailing whitespace, fix a few typos, etc. 

llvm-svn: 94351
This commit is contained in:
Daniel Dunbar 2010-01-24 02:54:26 +00:00
parent e0359b4fe7
commit 62ebf25f44
1 changed files with 144 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
clang/include/clang-c/Index.h
View File

@ -175,11 +175,15 @@ CINDEX_LINKAGE void clang_disposeString(CXString string);
CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
int displayDiagnostics);
CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
/**
* \brief Get the original translation unit source file name.
*/
CINDEX_LINKAGE CXString
clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
/**
* \brief Request that AST's be generated external for API calls which parse
* \brief Request that AST's be generated externally for API calls which parse
* source code on the fly, e.g. \see createTranslationUnitFromSourceFile.
*
* Note: This is for debugging purposes only, and may be removed at a later
@ -331,8 +335,8 @@ CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1,
CXSourceLocation loc2);
/**
* \brief Retrieves the source location associated with a given
* file/line/column in a particular translation unit.
* \brief Retrieves the source location associated with a given file/line/column
* in a particular translation unit.
*/
CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
CXFile file,
@ -347,20 +351,20 @@ CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin,
CXSourceLocation end);
/**
* \brief Retrieve the file, line, and column represented by the
* given source location.
* \brief Retrieve the file, line, and column represented by the given source
* location.
*
* \param location the location within a source file that will be
* decomposed into its parts.
* \param location the location within a source file that will be decomposed
* into its parts.
*
* \param file if non-NULL, will be set to the file to which the given
* \param file [out] if non-NULL, will be set to the file to which the given
* source location points.
*
* \param line if non-NULL, will be set to the line to which the given
* \param line [out] if non-NULL, will be set to the line to which the given
* source location points.
*
* \param column if non-NULL, will be set to the column to which the
* given source location points.
* \param column [out] if non-NULL, will be set to the column to which the given
* source location points.
*/
CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
CXFile *file,
@ -368,14 +372,14 @@ CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
unsigned *column);
/**
* \brief Retrieve a source location representing the first
* character within a source range.
* \brief Retrieve a source location representing the first character within a
* source range.
*/
CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range);
/**
* \brief Retrieve a source location representing the last
* character within a source range.
* \brief Retrieve a source location representing the last character within a
* source range.
*/
CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range);
@ -795,7 +799,7 @@ CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
* This function produces the cursor for the Objective-C class from the
* cursor for the superclass reference. If the input cursor is a declaration or
* definition, it returns that declaration or definition unchanged.
* Othewise, returns the NULL cursor.
* Otherwise, returns the NULL cursor.
*/
CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);