Skip to content

Commit

Permalink
extend doc comment for ISuperCoolFeatures
Browse files Browse the repository at this point in the history
  • Loading branch information
daixtrose committed Oct 16, 2024
1 parent 4edbbca commit d9d524a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions polymorphism/include/polymorphism/i_super_cool_features.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@
namespace classic {

/// @brief A typical interface definition via a class with pure virtual functions/methods.
///
/// This interface demonstrates classic polymorphism in C++.
///
/// @details
/// - coolFeature(): Returns a string representing some cool feature.
/// - set(std::string s): Sets some internal state of the implementing class.
class ISuperCoolFeatures {
public:
[[nodiscard]] virtual std::string coolFeature() const = 0; // Pure virtual function
Expand Down

0 comments on commit d9d524a

Please sign in to comment.