Struct IEntityComments#
Defined in File core_idl.h
Inheritance Relationships#
Derived Type#
public CEntity(Class CEntity)
Struct Documentation#
-
struct IEntityComments#
Comment interface.
Subclassed by CEntity
Public Types
-
enum class ECommentMask : uint32_t#
Comment mask.
Values:
-
enumerator c_style_javadoc#
Comment of the form “/‍** … *‍/”.
-
enumerator c_style_javadoc_post#
Comment of the form “/‍**< … *‍/”.
-
enumerator c_style_qt#
Comment of the form “/*! … *‍/”.
-
enumerator c_style_qt_post#
Comment of the form “/*!< … *‍/”.
-
enumerator c_style#
Comment of the form “/* … *‍/”.
-
enumerator cpp_style_javadoc#
Comment of the form “/// …”.
-
enumerator cpp_style_javadoc_post#
Comment of the form “///< …”.
-
enumerator cpp_style_qt#
Comment of the form “//! …”.
-
enumerator cpp_style_qt_post#
Comment of the form “///< …”.
-
enumerator cpp_style#
Comment of the form “// …”.
-
enumerator loc_succeeding#
Comment location is succeeding statement.
-
enumerator format_javadoc#
Comment using javadoc form.
-
enumerator format_qt#
Comment using QT form.
-
enumerator format_mask#
Comment formatting mask.
-
enumerator c_style_javadoc
Comment of the form “/‍** … *‍/”.
-
enumerator c_style_javadoc
Comment of the form “/‍** … *‍/”.
-
enumerator c_style_javadoc_post
Comment of the form “/‍**< … *‍/”.
-
enumerator c_style_javadoc_post
Comment of the form “/‍**< … *‍/”.
-
enumerator c_style_qt
Comment of the form “/*! … *‍/”.
-
enumerator c_style_qt
Comment of the form “/*! … *‍/”.
-
enumerator c_style_qt_post
Comment of the form “/*!< … *‍/”.
-
enumerator c_style_qt_post
Comment of the form “/*!< … *‍/”.
-
enumerator c_style
Comment of the form “/* … *‍/”.
-
enumerator c_style
Comment of the form “/* … *‍/”.
-
enumerator cpp_style_javadoc
Comment of the form “/// …”.
-
enumerator cpp_style_javadoc
Comment of the form “/// …”.
-
enumerator cpp_style_javadoc_post
Comment of the form “///< …”.
-
enumerator cpp_style_javadoc_post
Comment of the form “///< …”.
-
enumerator cpp_style_qt
Comment of the form “//! …”.
-
enumerator cpp_style_qt
Comment of the form “//! …”.
-
enumerator cpp_style_qt_post
Comment of the form “///< …”.
-
enumerator cpp_style_qt_post
Comment of the form “///< …”.
-
enumerator cpp_style
Comment of the form “// …”.
-
enumerator cpp_style
Comment of the form “// …”.
-
enumerator loc_succeeding
Comment location is succeeding statement.
-
enumerator loc_succeeding
Comment location is succeeding statement.
-
enumerator format_javadoc
Comment using javadoc form.
-
enumerator format_javadoc
Comment using javadoc form.
-
enumerator format_qt
Comment using QT form.
-
enumerator format_qt
Comment using QT form.
-
enumerator format_mask
Comment formatting mask.
-
enumerator format_mask
Comment formatting mask.
-
enumerator c_style_javadoc#
-
enum ECommentMask
Comment mask.
Values:
-
enumerator c_style_javadoc
Comment of the form “/‍** … *‍/”.
-
enumerator c_style_javadoc_post
Comment of the form “/‍**< … *‍/”.
-
enumerator c_style_qt
Comment of the form “/*! … *‍/”.
-
enumerator c_style_qt_post
Comment of the form “/*!< … *‍/”.
-
enumerator c_style
Comment of the form “/* … *‍/”.
-
enumerator cpp_style_javadoc
Comment of the form “/// …”.
-
enumerator cpp_style_javadoc_post
Comment of the form “///< …”.
-
enumerator cpp_style_qt
Comment of the form “//! …”.
-
enumerator cpp_style_qt_post
Comment of the form “///< …”.
-
enumerator cpp_style
Comment of the form “// …”.
-
enumerator loc_succeeding
Comment location is succeeding statement.
-
enumerator format_javadoc
Comment using javadoc form.
-
enumerator format_qt
Comment using QT form.
-
enumerator format_mask
Comment formatting mask.
-
enumerator c_style_javadoc
Public Functions
-
virtual sdv::u8string GetComments(uint32_t &ruiFlags) const = 0#
Get the comment lines for this entity as one string.
Remark
For c-style multi-line comments, the indentation and additional asterisk character at the beginning of each line is removed.
- Parameters:
ruiFlags – [out] Reference to the variable receiving the comment flags (a bitmask combination of sdv::idl::IEntityComments::ECommentMask).
- Returns:
Returns the comment string. If the comment contains multiple lines, each line is ending with a newline.
- u8string GetComments (out uint32 ruiFlags) const
Get the comment lines for this entity as one string.
Remark
For c-style multi-line comments, the indentation and additional asterisk character at the beginning of each line is removed.
- Parameters:
ruiFlags – [out] Reference to the variable receiving the comment flags (a bitmask combination of sdv::idl::IEntityComments::ECommentMask).
- Returns:
Returns the comment string. If the comment contains multiple lines, each line is ending with a newline.
Public Static Attributes
-
static ::sdv::interface_id _id = 0xEE1AD4FC2B9217BB#
Interface ID.
-
enum class ECommentMask : uint32_t#