From a9a8d94936880fbd8f47e847220f6825e0a3d8b5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Bj=C3=B6rk?= <ddbjork@gmail.com>
Date: Wed, 21 Dec 2016 14:09:26 +0100
Subject: [PATCH] SystemDesign: Code of Conduct: added inti description, and
naming table
---
chapters/systemDesign.tex | 25 +++++++++++++++++--------
1 file changed, 17 insertions(+), 8 deletions(-)
diff --git a/chapters/systemDesign.tex b/chapters/systemDesign.tex
index f421603..9e6022d 100644
--- a/chapters/systemDesign.tex
+++ b/chapters/systemDesign.tex
@@ -1,21 +1,30 @@
\subsection{Code of Conduct}
The code follows a simple code of conduct. This generally helps avoid variable naming collisions and similar issues which may result in undefined behavior. With much consideration to simplicity in development it has been kept limited to resolve the most important code structuring issues.
-
- Each file of code contains a group of functions related to a specific functionality. To avoid memory leaks and overwriting data, every function and global variable in a file has a prefix, which is the same as the name of the file. Enabling a developer to easily follow the codeflow through files when coding or debugging.
-
+
+ Each file of code contains a group of functions related to a specific functionality. To avoid memory leaks and overwriting data, every function and global variable in a file has a prefix, which is the same as the name of the file. Enabling a developer to easily follow the code flow through files when coding or debugging.
+
The prefix must begin with a capital letter and variables and functions should begin with a lower case letter, unless it is an abbreviation, though this is discouraged.
-
+
Most of the functionality has to be initialized on boot before it can be used. The decision to make an \texttt{Prefix\_init()} function makes it easy to keep code flow and code names similar throughout the code.
-
-
+ \begin{center}
+ \begin{tabular}{ r l }
+ Prefix & \texttt{IMU} \\
+ Filename & \texttt{IMU.c} \\
+ & \texttt{IMU.h} \\
+ Namespace & \texttt{IMU\_variable} \\
+ & \texttt{IMU\_functionName()}\\
+ Initialization & \texttt{IMU\_init()}
+ \end{tabular}
+ \end{center}
+
\subsection{Static Design}
\subsubsection{Class Diagram}
\begin{figure}[H]
\centering
\includegraphics[width=\textwidth]{Pictures/uml}
\end{figure}
-
+
\subsubsection{Module Diagram}
\begin{figure}[H]
\centering
@@ -26,4 +35,4 @@
\subsection{Dynamic Design}
\subsubsection{Activity Diagram}
\subsubsection{Sequence Diagram}
- \subsubsection{State Diagram}
\ No newline at end of file
+ \subsubsection{State Diagram}
--
GitLab