1
0
Fork 0
mirror of https://github.com/TheLartians/ModernCppStarter.git synced 2025-09-03 23:50:53 +02:00

init doxygen

This commit is contained in:
Lars Melchior 2020-06-03 11:29:33 +02:00
parent 9ede321e5d
commit b31db62605
3 changed files with 2606 additions and 0 deletions

View file

@ -4,13 +4,28 @@
namespace greeter {
/** Language codes to be used with the Greeter class */
enum class LanguageCode { EN, DE, ES, FR };
/**
* A class for greeting in multiple languages
*/
class Greeter {
std::string name;
public:
/**
* Creates a new greeter
* @param name the name to greet
*/
Greeter(std::string name);
/**
* Creates a localized string containing the greeting
* @param lang the language to greet in
* @return a string containing the greeting
*/
std::string greet(LanguageCode lang = LanguageCode::EN) const;
};