1
0
Fork 0
mirror of https://github.com/TheLartians/ModernCppStarter.git synced 2025-08-30 21:51:12 +02:00

Doxygen support (#43)

* init doxygen

* fix format

* use readme as main file

* don't generate LaTeX

* automatically use correct project version and update html settings

* minify Doxyfile

* add documentation

* add workflow to publish documentation

* remove mac comment

* formatting

* fix typo

* grammar
This commit is contained in:
Lars Melchior 2020-06-03 14:31:53 +02:00 committed by GitHub
parent fa77b5371f
commit 032e506c12
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 144 additions and 13 deletions

View file

@ -4,13 +4,27 @@
namespace greeter {
/** Language codes to be used with the Greeter class */
enum class LanguageCode { EN, DE, ES, FR };
/**
* A class for saying hello 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;
};