Skip to content

Adding simple style guides #7

Merged
merged 2 commits into from Oct 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions breadcrumbs/doc/style/style.cpp
@@ -0,0 +1,20 @@
/*

This file correspondes to style.hpp and is an example of
the .cpp files that would correspond to the .hpp file.

*/


#include "style.hpp"


char TestClass::attrTwoTimesTwo()
{
return c_attrTwo << 1
}

int TestClass::getAttrSum()
{
return c_attrTwo + i_attrOne
}
30 changes: 30 additions & 0 deletions breadcrumbs/doc/style/style.hpp
@@ -0,0 +1,30 @@
/*

This file contains the style of each programming construct
to use in this project.

It should be followed to the letter! All spaces are
necessary! Make sure to take note of camel case and other
variable naming schemes!

*/

// Header File:
class TestClass
{
public:
// Constructors
TestClass(int AttrOne, char AttrTwo);
// Mutator methods
int getAttrSum();
char attrTwoTimesTwo();
void setAttrOne(int newAttrOne) { i_attrOne = newAttrOne }
void setAttrTwo(char newAttrTwo) { c_attrTwo = newAttrTwo }
// Accessor methods
int getAttrOne() { return i_attrOne }
char getAttrTwo() { return c_attrTwo }
private:
// Private variables
int i_attrOne = 0;
char c_attrTwo;
};