FYS3150/Project-3
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Cory Balaton
2023-09-29 13:55:10 +02:00
parent b0b05d239b
commit 9967101a70
18 changed files with 34 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
man_pages/man3/Particle.3
View File

@@ -1,4 +1,4 @@
.TH "Particle" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "Particle" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -57,7 +57,7 @@ Definition at line \fB19\fP of file \fBParticle\&.hpp\fP\&.
.PP
Initialize the particle\&. Initialize the particle with a charge, mass, position and velocity\&.
.PP
Definition at line \fB17\fP of file \fBParticle\&.cpp\fP\&.
Definition at line \fB16\fP of file \fBParticle\&.cpp\fP\&.
.SH "Friends And Related Function Documentation"
.PP
.SS "friend class \fBPenningTrap\fP\fC [friend]\fP"

8
man_pages/man3/Particle.cpp.3
View File

@@ -1,4 +1,4 @@
.TH "src/Particle.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "src/Particle.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -34,12 +34,6 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)
No known bugs
.RE
.PP
.PP
\fBTodo\fP
.RS 4
Implement constructor
.RE
.PP
.PP
Definition in file \fBParticle\&.cpp\fP\&.

2
man_pages/man3/Particle.hpp.3
View File

@@ -1,4 +1,4 @@
.TH "include/Particle.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "include/Particle.hpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
man_pages/man3/PenningTrap.3
View File

@@ -1,4 +1,4 @@
.TH "PenningTrap" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "PenningTrap" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
man_pages/man3/PenningTrap.cpp.3
View File

@@ -1,4 +1,4 @@
.TH "src/PenningTrap.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "src/PenningTrap.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
man_pages/man3/PenningTrap.hpp.3
View File

@@ -1,4 +1,4 @@
.TH "include/PenningTrap.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "include/PenningTrap.hpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
man_pages/man3/bug.3
View File

@@ -1,4 +1,4 @@
.TH "bug" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "bug" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
man_pages/man3/constants.hpp.3
View File

@@ -1,4 +1,4 @@
.TH "include/constants.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "include/constants.hpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
man_pages/man3/main.cpp.3
View File

@@ -1,4 +1,4 @@
.TH "src/main.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "src/main.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
man_pages/man3/test_suite.cpp.3
View File

@@ -1,4 +1,4 @@
.TH "src/test_suite.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "src/test_suite.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME

4
man_pages/man3/todo.3
View File

@@ -1,12 +1,10 @@
.TH "todo" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "todo" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME
todo \- Todo List
.PP
.IP "\fBFile \fBParticle\&.cpp\fP \fP" 1c
Implement constructor
.IP "\fBFile \fBPenningTrap\&.cpp\fP \fP" 1c
Implement constructor
.PP

2
man_pages/man3/utils.cpp.3
View File

@@ -1,4 +1,4 @@
.TH "src/utils.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "src/utils.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
man_pages/man3/utils.hpp.3
View File

@@ -1,4 +1,4 @@
.TH "include/utils.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "include/utils.hpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME