Data structure containing plugin export options. More...

#include <fields.h>

Public Attributes
bool	include_comments = true
	Whether or not to include comment fields when generating the tag data structure. More...

bool	generate_doxygen_comments = true
	Whether or not to include doxygen-compatible comments when generating the tag struct. More...

bool	export_legacy_bitfields = false
	Whether or not to export bitfields using the legacy output method. More...

bool	export_comment_descriptions = true
	Whether or not to include descriptions when exporting comment fields. More...

Detailed Description

Data structure containing plugin export options.

These options are used when exporting a BlamPlugin to C++ code.

Member Data Documentation

◆ export_comment_descriptions

bool BlamPluginExportOptions::export_comment_descriptions = true

Whether or not to include descriptions when exporting comment fields.

◆ export_legacy_bitfields

bool BlamPluginExportOptions::export_legacy_bitfields = false

Whether or not to export bitfields using the legacy output method.

If true, then bitfields in tag structs are exported simply as bitfield8/bitfield16/bitfield32. In C++ code, flags use a generic flag# name, where # corresponds to the flag index. This is the "legacy" behavior.

If false, then bitfields are exported with a unique data structure, where each configured flag is exported with its ID, and any remaining flags are exported as unused#, where # corresponds to the flag index. In C++ code, this allows flags to be accessed by ID rather than a generic name, allowing for more readable code and allowing flags to be rearranged or inserted later on without breaking existing code (or breaking it in an obvious manner during compile-time, allowing it to be fixed immediately).

◆ generate_doxygen_comments

bool BlamPluginExportOptions::generate_doxygen_comments = true

Whether or not to include doxygen-compatible comments when generating the tag struct.

◆ include_comments

bool BlamPluginExportOptions::include_comments = true

Whether or not to include comment fields when generating the tag data structure.

The documentation for this struct was generated from the following file: