Boost C++ Libraries

PrevUpHomeNext

Code Links

If you want to link to a function, class, member, enum, concept, global, or header in the reference section, you can use:

[funcref fully::qualified::function_name The link text]
[classref fully::qualified::class_name The link text]
[memberref fully::qualified::member_name The link text]
[enumref fully::qualified::enum_name The link text]
[macroref MACRO_NAME The link text]
[conceptref ConceptName The link text]
[headerref path/to/header.hpp The link text]
[globalref fully::qualified::global The link text]

Again, the link text is optional. If this is not present, the link text will automatically be the function, class, member, enum, macro, concept, global, or header name. Example:

[classref boost::bar::baz]

would have "boost::bar::baz" as the link text.


PrevUpHomeNext