Input::Type::Attribute Class Reference

Class with static methods provided common attributes of Input::Type objects. More...

#include <attribute_lib.hh>

Static Public Member Functions
static string	generic_parameters ()
static string	root_of_generic_subtree ()
static string	embedded_doc ()
static string	link_name ()
static string	obsolete ()

Detailed Description

Class with static methods provided common attributes of Input::Type objects.

These attributes can be used in any Input::Type object.

Definition at line 31 of file attribute_lib.hh.

Member Function Documentation

embedded_doc()

static string Input::Type::Attribute::embedded_doc ( )

inlinestatic

Indicates that formatter should make the type documentation part of the documentation of the type that use it. E.g. documentation of a record key contain documentation of its type.

Value is a bool.

Definition at line 55 of file attribute_lib.hh.

generic_parameters()

static string Input::Type::Attribute::generic_parameters ( )

inlinestatic

This attribute provides a list of names of the free parameters of the subtree of a generic type. Value is a list of strings.

Definition at line 37 of file attribute_lib.hh.

Here is the caller graph for this function:

link_name()

static string Input::Type::Attribute::link_name ( )

inlinestatic

Propose custom target name for hypertext reference.

Format of value: string

Definition at line 63 of file attribute_lib.hh.

obsolete()

static string Input::Type::Attribute::obsolete ( )

inlinestatic

Attribute to mark obsolete types. The value of the attribute is the replacement of the feature, or reason to abandon the type.

Format of value: bool

Definition at line 72 of file attribute_lib.hh.

Here is the caller graph for this function:

root_of_generic_subtree()

static string Input::Type::Attribute::root_of_generic_subtree ( )

inlinestatic

This attribute is set to value 'true' for the generic types that are the root types of a generic subtree, i.e. The Input::Type::Instance was applied to them. Value is a bool.

Definition at line 45 of file attribute_lib.hh.

Here is the caller graph for this function:

---

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

• /opt/flow123d/flow123d/src/input/attribute_lib.hh