commentkind.go

package clang

// #include <stdlib.h>
// #include "go-clang.h"
//
import "C"

/**
 * \brief Describes the type of the comment AST node (\c CXComment).  A comment
 * node can be considered block content (e. g., paragraph), inline content
 * (plain text) or neither (the root AST node).
 */
type CommentKind int

const (
	/**
	 * \brief Null comment.  No AST node is constructed at the requested location
	 * because there is no text or a syntax error.
	 */
	Comment_Null CommentKind = C.CXComment_Null

	/**
	 * \brief Plain text.  Inline content.
	 */
	Comment_Text = C.CXComment_Text

	/**
	 * \brief A command with word-like arguments that is considered inline content.
	 *
	 * For example: \\c command.
	 */
	Comment_InlineCommand = C.CXComment_InlineCommand

	/**
	 * \brief HTML start tag with attributes (name-value pairs).  Considered
	 * inline content.
	 *
	 * For example:
	 * \verbatim
	 * <br> <br /> <a href="http://example.org/">
	 * \endverbatim
	 */
	Comment_HTMLStartTag = C.CXComment_HTMLStartTag

	/**
	 * \brief HTML end tag.  Considered inline content.
	 *
	 * For example:
	 * \verbatim
	 * </a>
	 * \endverbatim
	 */
	Comment_HTMLEndTag = C.CXComment_HTMLEndTag

	/**
	 * \brief A paragraph, contains inline comment.  The paragraph itself is
	 * block content.
	 */
	Comment_Paragraph = C.CXComment_Paragraph

	/**
	 * \brief A command that has zero or more word-like arguments (number of
	 * word-like arguments depends on command name) and a paragraph as an
	 * argument.  Block command is block content.
	 *
	 * Paragraph argument is also a child of the block command.
	 *
	 * For example: \\brief has 0 word-like arguments and a paragraph argument.
	 *
	 * AST nodes of special kinds that parser knows about (e. g., \\param
	 * command) have their own node kinds.
	 */
	Comment_BlockCommand = C.CXComment_BlockCommand

	/**
	 * \brief A \\param or \\arg command that describes the function parameter
	 * (name, passing direction, description).
	 *
	 * For example: \\param [in] ParamName description.
	 */
	Comment_ParamCommand = C.CXComment_ParamCommand

	/**
	 * \brief A \\tparam command that describes a template parameter (name and
	 * description).
	 *
	 * For example: \\tparam T description.
	 */
	Comment_TParamCommand = C.CXComment_TParamCommand

	/**
	 * \brief A verbatim block command (e. g., preformatted code).  Verbatim
	 * block has an opening and a closing command and contains multiple lines of
	 * text (\c CXComment_VerbatimBlockLine child nodes).
	 *
	 * For example:
	 * \\verbatim
	 * aaa
	 * \\endverbatim
	 */
	Comment_VerbatimBlockCommand = C.CXComment_VerbatimBlockCommand

	/**
	 * \brief A line of text that is contained within a
	 * CXComment_VerbatimBlockCommand node.
	 */
	Comment_VerbatimBlockLine = C.CXComment_VerbatimBlockLine

	/**
	 * \brief A verbatim line command.  Verbatim line has an opening command,
	 * a single line of text (up to the newline after the opening command) and
	 * has no closing command.
	 */
	Comment_VerbatimLine = C.CXComment_VerbatimLine

	/**
	 * \brief A full comment attached to a declaration, contains block content.
	 */
	Comment_FullComment = C.CXComment_FullComment
)

/**
 * \brief The most appropriate rendering mode for an inline command, chosen on
 * command semantics in Doxygen.
 */
type CommentInlineCommandRenderKind int

const (
	/**
	 * \brief Command argument should be rendered in a normal font.
	 */
	CommentInlineCommandRenderKind_Normal CommentInlineCommandRenderKind = C.CXCommentInlineCommandRenderKind_Normal

	/**
	 * \brief Command argument should be rendered in a bold font.
	 */
	CommentInlineCommandRenderKind_Bold = C.CXCommentInlineCommandRenderKind_Bold

	/**
	 * \brief Command argument should be rendered in a monospaced font.
	 */
	CommentInlineCommandRenderKind_Monospaced = C.CXCommentInlineCommandRenderKind_Monospaced

	/**
	 * \brief Command argument should be rendered emphasized (typically italic
	 * font).
	 */
	CommentInlineCommandRenderKind_Emphasized = C.CXCommentInlineCommandRenderKind_Emphasized
)

/**
 * \brief Describes parameter passing direction for \\param or \\arg command.
 */
type CommentParamPassDirection int

const (
	/**
	 * \brief The parameter is an input parameter.
	 */
	CommentParamPassDirection_In = C.CXCommentParamPassDirection_In

	/**
	 * \brief The parameter is an output parameter.
	 */
	CommentParamPassDirection_Out = C.CXCommentParamPassDirection_Out

	/**
	 * \brief The parameter is an input and output parameter.
	 */
	CommentParamPassDirection_InOut = C.CXCommentParamPassDirection_InOut
)