[llvm] r317271 - Clean up comments in include/llvm-c/DebugInfo.h
Adrian Prantl via llvm-commits
llvm-commits at lists.llvm.org
Thu Nov 2 14:35:37 PDT 2017
Author: adrian
Date: Thu Nov 2 14:35:37 2017
New Revision: 317271
URL: http://llvm.org/viewvc/llvm-project?rev=317271&view=rev
Log:
Clean up comments in include/llvm-c/DebugInfo.h
Patch by Harlan Haskins!
Differential Revision: https://reviews.llvm.org/D39568
Modified:
llvm/trunk/include/llvm-c/DebugInfo.h
Modified: llvm/trunk/include/llvm-c/DebugInfo.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm-c/DebugInfo.h?rev=317271&r1=317270&r2=317271&view=diff
==============================================================================
--- llvm/trunk/include/llvm-c/DebugInfo.h (original)
+++ llvm/trunk/include/llvm-c/DebugInfo.h Thu Nov 2 14:35:37 2017
@@ -23,7 +23,9 @@
extern "C" {
#endif
-/// Debug info flags.
+/**
+ * Debug info flags.
+ */
typedef enum {
LLVMDIFlagZero = 0,
LLVMDIFlagPrivate = 1,
@@ -58,7 +60,9 @@ typedef enum {
LLVMDIFlagVirtualInheritance
} LLVMDIFlags;
-/// Source languages known by DWARF.
+/**
+ * Source languages known by DWARF.
+ */
typedef enum {
LLVMDWARFSourceLanguageC89,
LLVMDWARFSourceLanguageC,
@@ -106,68 +110,85 @@ typedef enum {
LLVMDWARFSourceLanguageBORLAND_Delphi
} LLVMDWARFSourceLanguage;
-/// The amount of debug information to emit.
+/**
+ * The amount of debug information to emit.
+ */
typedef enum {
LLVMDWARFEmissionNone = 0,
LLVMDWARFEmissionFull,
LLVMDWARFEmissionLineTablesOnly
} LLVMDWARFEmissionKind;
-/// The current debug metadata version number.
+/**
+ * The current debug metadata version number.
+ */
unsigned LLVMDebugMetadataVersion(void);
-/// The version of debug metadata that's present in the provided \c Module.
+/**
+ * The version of debug metadata that's present in the provided \c Module.
+ */
unsigned LLVMGetModuleDebugMetadataVersion(LLVMModuleRef Module);
-/// Strip debug info in the module if it exists.
-///
-/// To do this, we remove all calls to the debugger intrinsics and any named
-/// metadata for debugging. We also remove debug locations for instructions.
-/// Return true if module is modified.
+/**
+ * Strip debug info in the module if it exists.
+ * To do this, we remove all calls to the debugger intrinsics and any named
+ * metadata for debugging. We also remove debug locations for instructions.
+ * Return true if module is modified.
+ */
LLVMBool LLVMStripModuleDebugInfo(LLVMModuleRef Module);
-/// Construct a builder for a module, and do not allow for unresolved nodes
-/// attached to the module.
+/**
+ * Construct a builder for a module, and do not allow for unresolved nodes
+ * attached to the module.
+ */
LLVMDIBuilderRef LLVMCreateDIBuilderDisallowUnresolved(LLVMModuleRef M);
-/// Construct a builder for a module and collect unresolved nodes attached
-/// to the module in order to resolve cycles during a call to
-/// \c LLVMDIBuilderFinalize.
+/**
+ * Construct a builder for a module and collect unresolved nodes attached
+ * to the module in order to resolve cycles during a call to
+ * \c LLVMDIBuilderFinalize.
+ */
LLVMDIBuilderRef LLVMCreateDIBuilder(LLVMModuleRef M);
-/// Deallocates the DIBuilder and everything it owns.
-/// @note You must call \c LLVMDIBuilderFinalize before this
+/**
+ * Deallocates the DIBuilder and everything it owns.
+ * @note You must call \c LLVMDIBuilderFinalize before this
+ */
void LLVMDisposeDIBuilder(LLVMDIBuilderRef Builder);
-/// Construct any deferred debug info descriptors.
+/**
+ * Construct any deferred debug info descriptors.
+ */
void LLVMDIBuilderFinalize(LLVMDIBuilderRef Builder);
-/// A CompileUnit provides an anchor for all debugging
-/// information generated during this instance of compilation.
-/// \param Lang Source programming language, eg.
-/// \c LLVMDWARFSourceLanguageC99
-/// \param FileRef File info.
-/// \param Producer Identify the producer of debugging information
-/// and code. Usually this is a compiler
-/// version string.
-/// \param ProducerLen The length of the C string passed to \c Producer.
-/// \param isOptimized A boolean flag which indicates whether optimization
-/// is enabled or not.
-/// \param Flags This string lists command line options. This
-/// string is directly embedded in debug info
-/// output which may be used by a tool
-/// analyzing generated debugging information.
-/// \param FlagsLen The length of the C string passed to \c Flags.
-/// \param RuntimeVer This indicates runtime version for languages like
-/// Objective-C.
-/// \param SplitName The name of the file that we'll split debug info
-/// out into.
-/// \param SplitNameLen The length of the C string passed to \c SplitName.
-/// \param Kind The kind of debug information to generate.
-/// \param DWOId The DWOId if this is a split skeleton compile unit.
-/// \param SplitDebugInlining Whether to emit inline debug info.
-/// \param DebugInfoForProfiling Whether to emit extra debug info for
-/// profile collection.
+/**
+ * A CompileUnit provides an anchor for all debugging
+ * information generated during this instance of compilation.
+ * \param Lang Source programming language, eg.
+ * \c LLVMDWARFSourceLanguageC99
+ * \param FileRef File info.
+ * \param Producer Identify the producer of debugging information
+ * and code. Usually this is a compiler
+ * version string.
+ * \param ProducerLen The length of the C string passed to \c Producer.
+ * \param isOptimized A boolean flag which indicates whether optimization
+ * is enabled or not.
+ * \param Flags This string lists command line options. This
+ * string is directly embedded in debug info
+ * output which may be used by a tool
+ * analyzing generated debugging information.
+ * \param FlagsLen The length of the C string passed to \c Flags.
+ * \param RuntimeVer This indicates runtime version for languages like
+ * Objective-C.
+ * \param SplitName The name of the file that we'll split debug info
+ * out into.
+ * \param SplitNameLen The length of the C string passed to \c SplitName.
+ * \param Kind The kind of debug information to generate.
+ * \param DWOId The DWOId if this is a split skeleton compile unit.
+ * \param SplitDebugInlining Whether to emit inline debug info.
+ * \param DebugInfoForProfiling Whether to emit extra debug info for
+ * profile collection.
+ */
LLVMMetadataRef LLVMDIBuilderCreateCompileUnit(
LLVMDIBuilderRef Builder, LLVMDWARFSourceLanguage Lang,
LLVMMetadataRef FileRef, const char *Producer, size_t ProducerLen,
@@ -176,32 +197,36 @@ LLVMMetadataRef LLVMDIBuilderCreateCompi
LLVMDWARFEmissionKind Kind, unsigned DWOId, LLVMBool SplitDebugInlining,
LLVMBool DebugInfoForProfiling);
-/// Create a file descriptor to hold debugging information for a file.
-/// \param Builder The DIBuilder.
-/// \param Filename File name.
-/// \param FilenameLen The length of the C string passed to \c Filename.
-/// \param Directory Directory.
-/// \param DirectoryLen The length of the C string passed to \c Directory.
+/**
+ * Create a file descriptor to hold debugging information for a file.
+ * \param Builder The DIBuilder.
+ * \param Filename File name.
+ * \param FilenameLen The length of the C string passed to \c Filename.
+ * \param Directory Directory.
+ * \param DirectoryLen The length of the C string passed to \c Directory.
+ */
LLVMMetadataRef
LLVMDIBuilderCreateFile(LLVMDIBuilderRef Builder, const char *Filename,
size_t FilenameLen, const char *Directory,
size_t DirectoryLen);
-/// Creates a new DebugLocation that describes a source location.
-/// \param Line The line in the source file.
-/// \param Column The column in the source file.
-/// \param Scope The scope in which the location resides.
-/// \param InlinedAt The scope where this location was inlined, if at all.
-/// (optional).
-/// \note If the item to which this location is attached cannot be
-/// attributed to a source line, pass 0 for the line and column.
+/**
+ * Creates a new DebugLocation that describes a source location.
+ * \param Line The line in the source file.
+ * \param Column The column in the source file.
+ * \param Scope The scope in which the location resides.
+ * \param InlinedAt The scope where this location was inlined, if at all.
+ * (optional).
+ * \note If the item to which this location is attached cannot be
+ * attributed to a source line, pass 0 for the line and column.
+ */
LLVMMetadataRef
LLVMDIBuilderCreateDebugLocation(LLVMContextRef Ctx, unsigned Line,
unsigned Column, LLVMMetadataRef Scope,
LLVMMetadataRef InlinedAt);
#ifdef __cplusplus
-} // end extern "C"
+} /* end extern "C" */
#endif
#endif
More information about the llvm-commits
mailing list