CMS 3D CMS Logo
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
edm::DocFormatHelper Class Reference

#include <DocFormatHelper.h>

Public Types

enum  DescriptionParent {
  TOP, OR, XOR, AND,
  OTHER
}
 

Public Member Functions

void addCategory (std::string const &pluginCategory, std::string const &section)
 
bool brief () const
 
size_t column1 () const
 
size_t column2 () const
 
size_t column3 () const
 
size_t commentWidth () const
 
int counter () const
 
void decrementCounter ()
 
 DocFormatHelper ()
 
void incrementCounter ()
 
void indent (std::ostream &os) const
 
void indent2 (std::ostream &os) const
 
int indentation () const
 
void init ()
 
size_t lineWidth () const
 
DescriptionParent parent () const
 
int pass () const
 
std::string const & section () const
 
std::string sectionOfCategoryAlreadyPrinted (std::string const &pluginCategory) const
 
void setAtLeast1 (size_t width)
 
void setAtLeast2 (size_t width)
 
void setAtLeast3 (size_t width)
 
void setBrief (bool value)
 
void setCounter (int value)
 
void setIndentation (int value)
 
void setLineWidth (size_t value)
 
void setParent (DescriptionParent value)
 
void setPass (int value)
 
void setSection (std::string const &value)
 
int startColumn2 () const
 

Static Public Member Functions

static int offsetModuleLabel ()
 
static int offsetSectionContent ()
 
static int offsetTopLevelPSet ()
 
static void wrapAndPrintText (std::ostream &os, std::string const &text, size_t indent, size_t suggestedWidth)
 

Private Attributes

bool brief_
 
size_t column1_
 
size_t column2_
 
size_t column3_
 
int counter_
 
int indentation_
 
size_t lineWidth_
 
DescriptionParent parent_
 
int pass_
 
std::vector< std::pair< std::string, std::string > > pluginCategoriesAlreadyPrinted_
 
std::string section_
 
size_t startColumn2_
 

Detailed Description

Definition at line 17 of file DocFormatHelper.h.

Member Enumeration Documentation

◆ DescriptionParent

enum edm::DocFormatHelper::DescriptionParent
Enumerator
TOP 
OR 
XOR 
AND 
OTHER 

Definition at line 19 of file DocFormatHelper.h.

19 { TOP, OR, XOR, AND, OTHER };

Constructor & Destructor Documentation

◆ DocFormatHelper()

edm::DocFormatHelper::DocFormatHelper ( )
inline

Definition at line 21 of file DocFormatHelper.h.

22  : brief_(false),
23  lineWidth_(80),
24  indentation_(4),
25  startColumn2_(24U),
26  section_(),
27  pass_(0),
28  column1_(0),
29  column2_(0),
30  column3_(0),
31  counter_(0),
32  parent_(OTHER) {}
mitigatedMETSequence_cff.U
U
Definition: mitigatedMETSequence_cff.py:36
edm::DocFormatHelper::parent_
DescriptionParent parent_
Definition: DocFormatHelper.h:107

Member Function Documentation

◆ addCategory()

void edm::DocFormatHelper::addCategory ( std::string const &  pluginCategory,
std::string const &  section 
)

Definition at line 146 of file DocFormatHelper.cc.

References pluginCategoriesAlreadyPrinted_, cond::pluginCategory(), and section().

146  {
147  pluginCategoriesAlreadyPrinted_.emplace_back(pluginCategory, section);
148  }
edm::DocFormatHelper::pluginCategoriesAlreadyPrinted_
std::vector< std::pair< std::string, std::string > > pluginCategoriesAlreadyPrinted_
Definition: DocFormatHelper.h:91
edm::DocFormatHelper::section
std::string const & section() const
Definition: DocFormatHelper.h:45
cond::pluginCategory
const char * pluginCategory()
Definition: ProductResolverFactory.cc:64

◆ brief()

bool edm::DocFormatHelper::brief ( ) const
inline

Definition at line 36 of file DocFormatHelper.h.

References brief_.

Referenced by edm::ParameterSetDescription::print(), edm::EmptyGroupDescription::print_(), edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ANDGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterDescriptionBase::printDefault_(), edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::AllowedLabelsDescriptionBase::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

36 { return brief_; }

◆ column1()

size_t edm::DocFormatHelper::column1 ( ) const
inline

Definition at line 51 of file DocFormatHelper.h.

References column1_.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

51 { return column1_; }

◆ column2()

size_t edm::DocFormatHelper::column2 ( ) const
inline

Definition at line 52 of file DocFormatHelper.h.

References column2_.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

52 { return column2_; }

◆ column3()

size_t edm::DocFormatHelper::column3 ( ) const
inline

Definition at line 53 of file DocFormatHelper.h.

References column3_.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

53 { return column3_; }

◆ commentWidth()

size_t edm::DocFormatHelper::commentWidth ( ) const

Definition at line 124 of file DocFormatHelper.cc.

References lineWidth(), startColumn2(), mitigatedMETSequence_cff::U, and ApeEstimator_cff::width.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

124  {
125  // Make the length of a comment at least 30 characters
126  // per line, longer if there is more space available
127  size_t width = 30U;
128  if (lineWidth() > startColumn2() + 30U) {
129  width = lineWidth() - startColumn2();
130  }
131  return width;
132  }
edm::DocFormatHelper::startColumn2
int startColumn2() const
Definition: DocFormatHelper.h:39
mitigatedMETSequence_cff.U
U
Definition: mitigatedMETSequence_cff.py:36
ApeEstimator_cff.width
width
Definition: ApeEstimator_cff.py:24
edm::DocFormatHelper::lineWidth
size_t lineWidth() const
Definition: DocFormatHelper.h:37

◆ counter()

int edm::DocFormatHelper::counter ( ) const
inline

Definition at line 68 of file DocFormatHelper.h.

References counter_.

Referenced by counter.Counters::__getitem__(), edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterDescriptionBase::printDefault_(), edm::ParameterDescription< ParameterSetDescription >::printDefault_(), edm::ParameterDescription< std::vector< ParameterSet > >::printDefault_(), edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

68 { return counter_; }

◆ decrementCounter()

void edm::DocFormatHelper::decrementCounter ( )
inline

Definition at line 71 of file DocFormatHelper.h.

References counter_.

Referenced by edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), and edm::ANDGroupDescription::printNestedContent_().

71 { --counter_; }

◆ incrementCounter()

void edm::DocFormatHelper::incrementCounter ( )
inline

Definition at line 70 of file DocFormatHelper.h.

References counter_.

Referenced by edm::ParameterDescriptionNode::print(), and edm::ParameterDescriptionNode::printNestedContent().

70 { ++counter_; }

◆ indent()

void edm::DocFormatHelper::indent ( std::ostream &  os) const

Definition at line 134 of file DocFormatHelper.cc.

References indentation_.

Referenced by ntuplePrintersDiff.TrackingParticlePrinter::_parentageChain(), edm::ParameterSetDescription::print(), edm::EmptyGroupDescription::print_(), edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterSwitchBase::printCase(), ntuplePrintersDiff.SeedPrinter::printHits(), ntuplePrintersDiff.TrackPrinter::printHits(), edm::ParameterSwitch< T >::printNestedContent_(), edm::AllowedLabelsDescriptionBase::printNestedContentBase_(), ntuplePrintersDiff.TrackingParticlePrinter::printTrackingParticle(), and wrapAndPrintText().

134  {
135  char oldFill = os.fill();
136  os << std::setfill(' ') << std::setw(indentation_) << "";
137  os.fill(oldFill);
138  }

◆ indent2()

void edm::DocFormatHelper::indent2 ( std::ostream &  os) const

Definition at line 140 of file DocFormatHelper.cc.

References startColumn2_.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

140  {
141  char oldFill = os.fill();
142  os << std::setfill(' ') << std::setw(startColumn2_) << "";
143  os.fill(oldFill);
144  }

◆ indentation()

int edm::DocFormatHelper::indentation ( ) const
inline

Definition at line 38 of file DocFormatHelper.h.

References indentation_.

Referenced by edm::ParameterDescriptionBase::printDefault_(), edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

38 { return indentation_; }

◆ init()

void edm::DocFormatHelper::init ( void  )

Definition at line 114 of file DocFormatHelper.cc.

References column1_, column2_, column3_, counter_, OTHER, parent_, pass_, section_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::PluginDescription< T >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

114  {
115  section_ = std::string();
116  pass_ = 0;
117  column1_ = 0;
118  column2_ = 0;
119  column3_ = 0;
120  counter_ = 0;
121  parent_ = OTHER;
122  }
AlCaHLTBitMon_QueryRunRegistry.string
string string
Definition: AlCaHLTBitMon_QueryRunRegistry.py:256
edm::DocFormatHelper::parent_
DescriptionParent parent_
Definition: DocFormatHelper.h:107

◆ lineWidth()

size_t edm::DocFormatHelper::lineWidth ( ) const
inline

Definition at line 37 of file DocFormatHelper.h.

References lineWidth_.

Referenced by commentWidth().

37 { return lineWidth_; }

◆ offsetModuleLabel()

static int edm::DocFormatHelper::offsetModuleLabel ( )
inlinestatic

Definition at line 83 of file DocFormatHelper.h.

Referenced by edm::ConfigurationDescriptions::print().

83 { return 2; }

◆ offsetSectionContent()

static int edm::DocFormatHelper::offsetSectionContent ( )
inlinestatic

Definition at line 85 of file DocFormatHelper.h.

Referenced by edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::PluginDescription< T >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

85 { return 4; }

◆ offsetTopLevelPSet()

static int edm::DocFormatHelper::offsetTopLevelPSet ( )
inlinestatic

Definition at line 84 of file DocFormatHelper.h.

Referenced by edm::ConfigurationDescriptions::printForLabel().

84 { return 2; }

◆ parent()

DescriptionParent edm::DocFormatHelper::parent ( void  ) const
inline

Definition at line 73 of file DocFormatHelper.h.

References parent_.

Referenced by edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

73 { return parent_; }
edm::DocFormatHelper::parent_
DescriptionParent parent_
Definition: DocFormatHelper.h:107

◆ pass()

int edm::DocFormatHelper::pass ( ) const
inline

Definition at line 48 of file DocFormatHelper.h.

References pass_.

Referenced by edm::EmptyGroupDescription::print_(), edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ANDGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterSwitchBase::printCase(), and edm::ParameterSetDescription::printNode().

48 { return pass_; }

◆ section()

std::string const& edm::DocFormatHelper::section ( ) const
inline

Definition at line 45 of file DocFormatHelper.h.

References section_.

Referenced by addCategory(), VarParsing.VarParsing::parseArguments(), edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ANDGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterDescriptionBase::printDefault_(), edm::ParameterDescription< ParameterSetDescription >::printDefault_(), edm::ParameterDescription< std::vector< ParameterSet > >::printDefault_(), edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

45 { return section_; }

◆ sectionOfCategoryAlreadyPrinted()

std::string edm::DocFormatHelper::sectionOfCategoryAlreadyPrinted ( std::string const &  pluginCategory) const

Definition at line 150 of file DocFormatHelper.cc.

References pluginCategoriesAlreadyPrinted_, cond::pluginCategory(), and AlCaHLTBitMon_QueryRunRegistry::string.

150  {
151  auto iter = std::find_if(
152  pluginCategoriesAlreadyPrinted_.begin(),
153  pluginCategoriesAlreadyPrinted_.end(),
154  [&pluginCategory](std::pair<std::string, std::string> const& elem) { return elem.first == pluginCategory; });
155  if (iter == pluginCategoriesAlreadyPrinted_.end()) {
156  return std::string();
157  }
158  return iter->second;
159  }
edm::DocFormatHelper::pluginCategoriesAlreadyPrinted_
std::vector< std::pair< std::string, std::string > > pluginCategoriesAlreadyPrinted_
Definition: DocFormatHelper.h:91
AlCaHLTBitMon_QueryRunRegistry.string
string string
Definition: AlCaHLTBitMon_QueryRunRegistry.py:256
cond::pluginCategory
const char * pluginCategory()
Definition: ProductResolverFactory.cc:64

◆ setAtLeast1()

void edm::DocFormatHelper::setAtLeast1 ( size_t  width)
inline

Definition at line 55 of file DocFormatHelper.h.

References column1_, and ApeEstimator_cff::width.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

55  {
56  if (width > column1_)
57  column1_ = width;
58  }
ApeEstimator_cff.width
width
Definition: ApeEstimator_cff.py:24

◆ setAtLeast2()

void edm::DocFormatHelper::setAtLeast2 ( size_t  width)
inline

Definition at line 59 of file DocFormatHelper.h.

References column2_, and ApeEstimator_cff::width.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

59  {
60  if (width > column2_)
61  column2_ = width;
62  }
ApeEstimator_cff.width
width
Definition: ApeEstimator_cff.py:24

◆ setAtLeast3()

void edm::DocFormatHelper::setAtLeast3 ( size_t  width)
inline

Definition at line 63 of file DocFormatHelper.h.

References column3_, and ApeEstimator_cff::width.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

63  {
64  if (width > column3_)
65  column3_ = width;
66  }
ApeEstimator_cff.width
width
Definition: ApeEstimator_cff.py:24

◆ setBrief()

void edm::DocFormatHelper::setBrief ( bool  value)
inline

Definition at line 41 of file DocFormatHelper.h.

References brief_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel().

41 { brief_ = value; }

◆ setCounter()

void edm::DocFormatHelper::setCounter ( int  value)
inline

Definition at line 69 of file DocFormatHelper.h.

References counter_, and relativeConstraints::value.

Referenced by edm::ParameterSetDescription::print(), edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), and edm::ParameterSwitch< T >::printNestedContent_().

69 { counter_ = value; }

◆ setIndentation()

void edm::DocFormatHelper::setIndentation ( int  value)
inline

Definition at line 43 of file DocFormatHelper.h.

References indentation_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel(), edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), and edm::ParameterSwitchBase::printNestedContentBase().

43 { indentation_ = value; }

◆ setLineWidth()

void edm::DocFormatHelper::setLineWidth ( size_t  value)
inline

Definition at line 42 of file DocFormatHelper.h.

References lineWidth_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel().

42 { lineWidth_ = value; }

◆ setParent()

void edm::DocFormatHelper::setParent ( DescriptionParent  value)
inline

Definition at line 74 of file DocFormatHelper.h.

References parent_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel(), edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), and edm::ParameterSwitchBase::printNestedContentBase().

74 { parent_ = value; }
edm::DocFormatHelper::parent_
DescriptionParent parent_
Definition: DocFormatHelper.h:107

◆ setPass()

void edm::DocFormatHelper::setPass ( int  value)
inline

Definition at line 49 of file DocFormatHelper.h.

References pass_, and relativeConstraints::value.

Referenced by edm::ParameterSetDescription::print(), edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ParameterSwitch< T >::printNestedContent_(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

49 { pass_ = value; }

◆ setSection()

void edm::DocFormatHelper::setSection ( std::string const &  value)
inline

Definition at line 46 of file DocFormatHelper.h.

References section_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel(), edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::PluginDescription< T >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), and edm::ParameterSwitchBase::printNestedContentBase().

46 { section_ = value; }

◆ startColumn2()

int edm::DocFormatHelper::startColumn2 ( ) const
inline

Definition at line 39 of file DocFormatHelper.h.

References startColumn2_.

Referenced by commentWidth(), edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ANDGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), and edm::ParameterDescriptionBase::printDefault_().

39 { return startColumn2_; }

◆ wrapAndPrintText()

void edm::DocFormatHelper::wrapAndPrintText ( std::ostream &  os,
std::string const &  text,
size_t  indent,
size_t  suggestedWidth 
)
static

Definition at line 98 of file DocFormatHelper.cc.

References indent(), and submitPVValidationJobs::text.

Referenced by edm::ConfigurationDescriptions::print(), edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), and edm::ConfigurationDescriptions::printForLabel().

101  {
102  size_t pos = text.find_first_of('\n');
103  if (pos == std::string::npos) {
104  // no embedded newlines
105  wrapAndPrintLine(os, text, indent, suggestedWidth);
106  } else {
107  // print the first line.
108  wrapAndPrintLine(os, text.substr(0, pos), indent, suggestedWidth);
109  // print all lines after the first.
110  wrapAndPrintText(os, text.substr(pos + 1), indent, suggestedWidth);
111  }
112  }
edm::DocFormatHelper::wrapAndPrintText
static void wrapAndPrintText(std::ostream &os, std::string const &text, size_t indent, size_t suggestedWidth)
Definition: DocFormatHelper.cc:98
edm::DocFormatHelper::indent
void indent(std::ostream &os) const
Definition: DocFormatHelper.cc:134

Member Data Documentation

◆ brief_

bool edm::DocFormatHelper::brief_
private

Definition at line 92 of file DocFormatHelper.h.

Referenced by brief(), and setBrief().

◆ column1_

size_t edm::DocFormatHelper::column1_
private

Definition at line 101 of file DocFormatHelper.h.

Referenced by column1(), init(), and setAtLeast1().

◆ column2_

size_t edm::DocFormatHelper::column2_
private

Definition at line 102 of file DocFormatHelper.h.

Referenced by column2(), init(), and setAtLeast2().

◆ column3_

size_t edm::DocFormatHelper::column3_
private

Definition at line 103 of file DocFormatHelper.h.

Referenced by column3(), init(), and setAtLeast3().

◆ counter_

int edm::DocFormatHelper::counter_
private

Definition at line 105 of file DocFormatHelper.h.

Referenced by counter(), decrementCounter(), incrementCounter(), init(), and setCounter().

◆ indentation_

int edm::DocFormatHelper::indentation_
private

Definition at line 94 of file DocFormatHelper.h.

Referenced by indent(), indentation(), and setIndentation().

◆ lineWidth_

size_t edm::DocFormatHelper::lineWidth_
private

Definition at line 93 of file DocFormatHelper.h.

Referenced by lineWidth(), and setLineWidth().

◆ parent_

DescriptionParent edm::DocFormatHelper::parent_
private

Definition at line 107 of file DocFormatHelper.h.

Referenced by init(), parent(), and setParent().

◆ pass_

int edm::DocFormatHelper::pass_
private

Definition at line 99 of file DocFormatHelper.h.

Referenced by init(), pass(), and setPass().

◆ pluginCategoriesAlreadyPrinted_

std::vector<std::pair<std::string, std::string> > edm::DocFormatHelper::pluginCategoriesAlreadyPrinted_
private

Definition at line 91 of file DocFormatHelper.h.

Referenced by addCategory(), and sectionOfCategoryAlreadyPrinted().

◆ section_

std::string edm::DocFormatHelper::section_
private

Definition at line 97 of file DocFormatHelper.h.

Referenced by init(), section(), and setSection().

◆ startColumn2_

size_t edm::DocFormatHelper::startColumn2_
private

Definition at line 95 of file DocFormatHelper.h.

Referenced by indent2(), and startColumn2().

Generated for CMSSW Reference Manual by doxygen 1.8.14