From a5d218fd1a7e842b7ea4ac7809b0ba89856a5205 Mon Sep 17 00:00:00 2001 From: HampusM Date: Thu, 9 Jun 2022 17:10:32 +0200 Subject: docs: fix basic example code style --- examples/basic/src/basic_example.cpp | 2 +- examples/basic/src/bootstrap.cpp | 2 +- examples/basic/src/bootstrap.hpp | 2 +- examples/basic/src/enemy.cpp | 2 +- examples/basic/src/enemy.hpp | 4 ++-- examples/basic/src/enemy_creator.cpp | 9 ++++++--- examples/basic/src/enemy_creator.hpp | 4 ++-- examples/basic/src/hero.hpp | 2 +- examples/basic/src/interfaces/enemy.hpp | 6 +++++- examples/basic/src/interfaces/enemy_creator.hpp | 5 +++-- examples/basic/src/interfaces/hero.hpp | 1 + examples/basic/src/interfaces/weapon.hpp | 3 ++- examples/basic/src/sword.cpp | 2 +- examples/basic/src/sword.hpp | 2 +- 14 files changed, 28 insertions(+), 18 deletions(-) (limited to 'examples') diff --git a/examples/basic/src/basic_example.cpp b/examples/basic/src/basic_example.cpp index e91235f..2974c09 100644 --- a/examples/basic/src/basic_example.cpp +++ b/examples/basic/src/basic_example.cpp @@ -4,7 +4,7 @@ #include -int main() +auto main() -> int { auto container = bootstrap(); diff --git a/examples/basic/src/bootstrap.cpp b/examples/basic/src/bootstrap.cpp index 7a78aec..ac81bd9 100644 --- a/examples/basic/src/bootstrap.cpp +++ b/examples/basic/src/bootstrap.cpp @@ -12,7 +12,7 @@ #include "hero.hpp" #include "sword.hpp" -yacppdic::Container bootstrap() +auto bootstrap() -> yacppdic::Container { auto container = yacppdic::Container(); diff --git a/examples/basic/src/bootstrap.hpp b/examples/basic/src/bootstrap.hpp index 104248f..9febbd9 100644 --- a/examples/basic/src/bootstrap.hpp +++ b/examples/basic/src/bootstrap.hpp @@ -2,4 +2,4 @@ #include -yacppdic::Container bootstrap(); +auto bootstrap() -> yacppdic::Container; diff --git a/examples/basic/src/enemy.cpp b/examples/basic/src/enemy.cpp index 3923794..60bd98b 100644 --- a/examples/basic/src/enemy.cpp +++ b/examples/basic/src/enemy.cpp @@ -2,7 +2,7 @@ Enemy::Enemy(int health) noexcept : _health(health) {} -int Enemy::get_health() const noexcept +auto Enemy::get_health() const noexcept -> int { return _health; } diff --git a/examples/basic/src/enemy.hpp b/examples/basic/src/enemy.hpp index b345f7f..a6fc778 100644 --- a/examples/basic/src/enemy.hpp +++ b/examples/basic/src/enemy.hpp @@ -7,9 +7,9 @@ class Enemy : public IEnemy, public yacppdic::AutoWirable { public: - Enemy(int health) noexcept; + explicit Enemy(int health) noexcept; - int get_health() const noexcept override; + [[nodiscard]] auto get_health() const noexcept -> int override; void do_damage(int damage) noexcept override; diff --git a/examples/basic/src/enemy_creator.cpp b/examples/basic/src/enemy_creator.cpp index 820ce1b..fd8a809 100644 --- a/examples/basic/src/enemy_creator.cpp +++ b/examples/basic/src/enemy_creator.cpp @@ -1,19 +1,22 @@ #include "enemy_creator.hpp" +#include + + EnemyCreator::EnemyCreator( IEnemyFactory small_enemy_factory, IEnemyFactory big_enemy_factory ) noexcept - : _small_enemy_factory(small_enemy_factory), _big_enemy_factory(big_enemy_factory) + : _small_enemy_factory(std::move(std::move(small_enemy_factory))), _big_enemy_factory(std::move(std::move(big_enemy_factory))) { } -std::unique_ptr EnemyCreator::create_small_enemy() noexcept +auto EnemyCreator::create_small_enemy() noexcept -> std::unique_ptr { return _small_enemy_factory(); } -std::unique_ptr EnemyCreator::create_big_enemy() noexcept +auto EnemyCreator::create_big_enemy() noexcept -> std::unique_ptr { return _big_enemy_factory(); } diff --git a/examples/basic/src/enemy_creator.hpp b/examples/basic/src/enemy_creator.hpp index a220008..231b7f4 100644 --- a/examples/basic/src/enemy_creator.hpp +++ b/examples/basic/src/enemy_creator.hpp @@ -19,9 +19,9 @@ public: IEnemyFactory big_enemy_factory ) noexcept; - std::unique_ptr create_small_enemy() noexcept override; + auto create_small_enemy() noexcept -> std::unique_ptr override; - std::unique_ptr create_big_enemy() noexcept override; + auto create_big_enemy() noexcept -> std::unique_ptr override; private: IEnemyFactory _small_enemy_factory; diff --git a/examples/basic/src/hero.hpp b/examples/basic/src/hero.hpp index e4959d2..e310817 100644 --- a/examples/basic/src/hero.hpp +++ b/examples/basic/src/hero.hpp @@ -10,7 +10,7 @@ class Hero : public IHero, public yacppdic::AutoWirable { public: - Hero(std::shared_ptr weapon) noexcept; + explicit Hero(std::shared_ptr weapon) noexcept; void fight(IEnemy &enemy) noexcept override; diff --git a/examples/basic/src/interfaces/enemy.hpp b/examples/basic/src/interfaces/enemy.hpp index 5f49ca6..5ad7d90 100644 --- a/examples/basic/src/interfaces/enemy.hpp +++ b/examples/basic/src/interfaces/enemy.hpp @@ -4,15 +4,19 @@ #include +// NOLINTNEXTLINE(modernize-avoid-c-arrays, cppcoreguidelines-avoid-c-arrays) constexpr char SMALL_ENEMY_TAG[] = "small"; + +// NOLINTNEXTLINE(modernize-avoid-c-arrays, cppcoreguidelines-avoid-c-arrays) constexpr char BIG_ENEMY_TAG[] = "big"; +// NOLINTNEXTLINE(cppcoreguidelines-special-member-functions) class IEnemy { public: virtual ~IEnemy() noexcept = default; - virtual int get_health() const noexcept = 0; + [[nodiscard]] virtual auto get_health() const noexcept -> int = 0; virtual void do_damage(int damage) noexcept = 0; }; diff --git a/examples/basic/src/interfaces/enemy_creator.hpp b/examples/basic/src/interfaces/enemy_creator.hpp index 820b636..2675fea 100644 --- a/examples/basic/src/interfaces/enemy_creator.hpp +++ b/examples/basic/src/interfaces/enemy_creator.hpp @@ -4,12 +4,13 @@ #include +// NOLINTNEXTLINE(cppcoreguidelines-special-member-functions) class IEnemyCreator { public: virtual ~IEnemyCreator() = default; - virtual std::unique_ptr create_small_enemy() noexcept = 0; + virtual auto create_small_enemy() noexcept -> std::unique_ptr = 0; - virtual std::unique_ptr create_big_enemy() noexcept = 0; + virtual auto create_big_enemy() noexcept -> std::unique_ptr = 0; }; diff --git a/examples/basic/src/interfaces/hero.hpp b/examples/basic/src/interfaces/hero.hpp index 25e18fc..41441d6 100644 --- a/examples/basic/src/interfaces/hero.hpp +++ b/examples/basic/src/interfaces/hero.hpp @@ -2,6 +2,7 @@ #include "interfaces/enemy.hpp" +// NOLINTNEXTLINE(cppcoreguidelines-special-member-functions) class IHero { public: diff --git a/examples/basic/src/interfaces/weapon.hpp b/examples/basic/src/interfaces/weapon.hpp index 7404115..78e4f42 100644 --- a/examples/basic/src/interfaces/weapon.hpp +++ b/examples/basic/src/interfaces/weapon.hpp @@ -1,9 +1,10 @@ #pragma once +// NOLINTNEXTLINE(cppcoreguidelines-special-member-functions) class IWeapon { public: virtual ~IWeapon() noexcept = default; - virtual int get_strength() const noexcept = 0; + [[nodiscard]] virtual auto get_strength() const noexcept -> int = 0; }; diff --git a/examples/basic/src/sword.cpp b/examples/basic/src/sword.cpp index 5d5ec40..6c8b74e 100644 --- a/examples/basic/src/sword.cpp +++ b/examples/basic/src/sword.cpp @@ -1,6 +1,6 @@ #include "sword.hpp" -int Sword::get_strength() const noexcept +auto Sword::get_strength() const noexcept -> int { return _strength; } diff --git a/examples/basic/src/sword.hpp b/examples/basic/src/sword.hpp index 25695b7..5ee3fef 100644 --- a/examples/basic/src/sword.hpp +++ b/examples/basic/src/sword.hpp @@ -7,7 +7,7 @@ class Sword : public IWeapon, public yacppdic::AutoWirable { public: - int get_strength() const noexcept override; + [[nodiscard]] auto get_strength() const noexcept -> int override; private: int _strength = 30; -- cgit v1.2.3-18-g5258