decompiler  1.0.0
Public Member Functions | List of all members
ghidra::OptionCommentIndent Class Reference

How many characters to indent comment lines. More...

Inheritance diagram for ghidra::OptionCommentIndent:
ghidra::ArchOption

Public Member Functions

 OptionCommentIndent (void)
 Constructor.
 
virtual string apply (Architecture *glb, const string &p1, const string &p2, const string &p3) const
 Apply a particular configuration option to the Architecture. More...
 
- Public Member Functions inherited from ghidra::ArchOption
string getName (void) const
 Return the name of the option.
 

Additional Inherited Members

- Static Public Member Functions inherited from ghidra::ArchOption
static bool onOrOff (const string &p)
 Parse an "on" or "off" string. More...
 
- Protected Attributes inherited from ghidra::ArchOption
string name
 Name of the option.
 

Detailed Description

How many characters to indent comment lines.

The first parameter gives the integer value. Comment lines are indented this much independent of the associated code's nesting depth.

Member Function Documentation

◆ apply()

string ghidra::OptionCommentIndent::apply ( Architecture glb,
const string &  p1,
const string &  p2,
const string &  p3 
) const
virtual

Apply a particular configuration option to the Architecture.

This method is overloaded by the different Option classes to provide possible configuration of different parts of the Architecture. The user can provide up to three optional parameters to tailor a specific type of configuration. The method returns a confirmation/failure message as feedback.

Parameters
glbis the Architecture being configured
p1is the first optional configuration string
p2is the second optional configuration string
p3is the third optional configuration string
Returns
a confirmation/failure message

Implements ghidra::ArchOption.

References ghidra::Architecture::print, and ghidra::PrintLanguage::setLineCommentIndent().


The documentation for this class was generated from the following files: