From 870cf7536c8f0d8a05deee14495cbfd80806d3ee Mon Sep 17 00:00:00 2001 From: Guille Gutierrez Date: Wed, 26 Apr 2023 10:09:57 -0400 Subject: [PATCH] Update 'C++GUIDE.md' --- C++GUIDE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/C++GUIDE.md b/C++GUIDE.md index 6832489..90a1010 100644 --- a/C++GUIDE.md +++ b/C++GUIDE.md @@ -175,7 +175,7 @@ Modern C++ solves lot's of issues with clasic C++ specially related to multiplat All public classes, properties, and methods must have code comments in the header files, we are using [doxygen](https://www.doxygen.nl) for auto documentation and the code comments must start with capital letters and /// syntax is preferred -File include for documentation needs to be added in both hpp and cpp files, after the license and contact information. +File include for documentation needs to be added only in the hpp files, after the license and contact information. ##### .hpp Example @@ -194,6 +194,7 @@ Project Coder Guillermo Gutierrez Morote namespace sample { + /// Person class description class Person { public: