CERC/documentation
61
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 'C++GUIDE.md'

Browse Source
This commit is contained in:
Guille Gutierrez 2023-04-26 10:09:57 -04:00
parent caa28c27c2
commit 870cf7536c
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
C++GUIDE.md
View File

@ -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 <Guillermo.GutierrezMorote@concordia.ca
#include <string>
namespace sample {
/// Person class description
class Person
{
public: