Namespaces
Variants

    Template:dsc expos mem tclass

    From cppreference.com

    |- class="t-dsc" | no member given |
    (exposition-only member class template*) |-

    [edit] [{{purge}}] Template documentation

    This is one of the family of templates used for creation of description list. These templates should be used to design function, variable or type lists.

    List template families

    • dsc **** : For creation of member variable/function lists.
    • dcl **** : For creation of detailed declaration lists (those including actual declaration code).
    • sdsc **** : For creation of lists representing various syntaxes of a language feature. Used in subpages of cpp/language.
    • par **** : For creation of lists explaining function parameters.
    • spar **** : For creation of lists explaining syntax parameters.
    • nv **** : For creation of feature lists in navbars.
    • elink **** : For creation of External links lists.

    {{dsc begin}}

    starts the description list

    {{dsc end}}

    ends the description list

    {{dsc h1|heading }}

    adds heading to the description list (h3 level)

    {{dsc h2|heading }}

    adds sub-heading to the description list (h5 level)

    {{dsc header}}

    adds explanation which header the features come from

    {{dsc namespace}}

    adds explanation which namespace the features are in

    {{dsc sep}}

    adds a separator

    {{dsc|name |explanation }}

    adds a generic item to the description list. If explanation is omitted, the item spans through both columns.

    {{dsc hitem|name |explanation }}

    adds a highlighted item to the description list. If explanation is omitted, the item spans through both columns.

    {{dsc inc|location |param1 (optional)|param2 (optional)|... }}

    Sets dsc-list-template-name variable to location, includes the template from location and unsets the variable. Use this template whenever copying dsc items from a template; this will add an edit link to them. The unnamed parameters param1, param2, ... are passed to the template.

    {{dsc break}}

    breaks the columns. The width of the columns above does not depend on the content below and vice-versa.

    {{dsc todo|reason }}

    adds a todo item (similar to {{todo}})

    Specialized templates

    There are templates already specialized for most of the usage cases.

    Classes

    {{dsc class|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a class.

    {{dsc tclass|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a class template.

    {{dsc talias|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of an alias template.

    {{dsc ptclass|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a class template specialization.

    {{dsc mem class|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a member class.

    {{dsc mem tclass|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a member class template.

    {{dsc expos mem class|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of an exposition-only member class.

    {{dsc expos mem tclass|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of an exposition-only member class template.

    {{dsc expos mem type|name |explanation |private=yes (optional)|protected=yes (optional)|maybe=yes|some-text (optional)|notes=rev (optional)|id=anchor-name (optional)}}

    • describes an exposition-only member type.
    • The private, protected, and maybe params, if provided, add the (private), (protected), and (optional) annotations respectively; notes is typically used for life marks such as {{mark c++26}} for (C++26).
    • The nolink and inlinemem params are not supported directly (behaves as if they are true).
    • If id param is provided, generates an inplace anchor with given anchor-name. Note that leading/trailing underscores in anchor-name are unconditionally trimmed.
    Functions

    {{dsc fun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a function

    {{dsc expos fun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of an exposition-only function

    {{dsc tfun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a function template.

    {{dsc expos tfun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of an exposition-only function template.

    {{dsc mem fun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a public member function.

    {{dsc prot mem fun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a protected member function.

    {{dsc priv mem fun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a private member function.

    {{dsc expos mem fun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of an exposition-only member function.

    {{dsc mem ctor|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a public constructor.

    {{dsc prot mem ctor|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a protected constructor.

    {{dsc mem dtor|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a public destructor.

    {{dsc prot mem dtor|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a protected destructor.

    {{dsc mem vdtor|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a virtual public destructor.

    {{dsc prot mem vdtor|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a virtual protected destructor.

    {{dsc mem sfun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a static member function.

    {{dsc expos mem sfun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of an exposition-only static member function.

    {{dsc mem vfun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a virtual public member function template.

    {{dsc prot mem vfun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a virtual protected member function template.

    {{dsc macro fun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a function macro.

    {{dsc macro tfun|link |title=link title (optional)|notes=link notes (optional)|explanation }}

    adds an item linking to a description of a type-generic function macro.
    Constants

    {{