example - A-F-Kazakov/cmake-template GitHub Wiki
Header file example.hpp
namespace tmpl
{
namespace lib
{
struct example;
std::ostream& operator<<(std::ostream& os, tmpl::lib::example const& exmpl);
}
}
Struct tmpl::lib::example
struct example
{
example();
example(std::string);
};
meaningless writer object
This is more complex and exaustive description of this class
Constructor tmpl::lib::example::example
example();
Effects: Creates the default example object
Constructor tmpl::lib::example::example
example(std::string);
Effects: creates example instance with specified string
Function tmpl::lib::operator<<
std::ostream& operator<<(std::ostream& os, tmpl::lib::example const& exmpl);
example stream operator
Return values: same output stream
prints underlying data to specific stream
Parameters
os- specific output streamexmpl- instance of the example