Skip to content

Commit

Permalink
Adding simple style guides (#7)
Browse files Browse the repository at this point in the history
* Adding simple style guides

* Update style.hpp
  • Loading branch information
grf14003 committed Oct 21, 2019
1 parent 03d6f5e commit 46cfff0
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
20 changes: 20 additions & 0 deletions breadcrumbs/doc/style/style.cpp
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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;
};

0 comments on commit 46cfff0

Please sign in to comment.