Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
N
NP_TMcode
Manage
Activity
Members
Plan
Wiki
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Container Registry
Analyze
Contributor analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Giacomo Mulas
NP_TMcode
Commits
ca120efc
Commit
ca120efc
authored
1 year ago
by
Giovanni La Mura
Browse files
Options
Downloads
Patches
Plain Diff
Use doxygen compliant syntax for class documentation
parent
4c9b8fe1
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
src/sphere/List.h
+1
-1
1 addition, 1 deletion
src/sphere/List.h
src/sphere/edfb.h
+20
-19
20 additions, 19 deletions
src/sphere/edfb.h
with
21 additions
and
20 deletions
src/sphere/List.h
+
1
−
1
View file @
ca120efc
...
...
@@ -2,7 +2,7 @@
#define LIST_OUT_OF_BOUNDS_EXCEPTION 1
#endif
/*
! \class List<T>
/*
*
* \brief A class to represent dynamic lists.
*
* This class helps in the creation and management of dynamic lists of
...
...
This diff is collapsed.
Click to expand it.
src/sphere/edfb.h
+
20
−
19
View file @
ca120efc
/*
! \class DEDFB
/*
*
* \brief A class to represent EDFB configuration data.
*
* This class replicates the structure of formatted DEDFB input data
...
...
@@ -32,22 +32,29 @@ class DEDFB {
double
*
dc0
;
public:
/*! \fn DEDFB(std::string)
* \brief Data structure constructor.
*
* The default procedure to import a configuration file is to build a
* configuration object, according to one of the following flavours:
*
* DEDFB edfb_cfg = DEDFB("FILE_NAME"); // configuration object
*
* or
*
* DEDFB *edfb_cfg_ptr = new DEDFB("FILE_NAME"); // pointer version
*/
DEDFB
(
std
::
string
file_name
);
/*! \fn print()
* \brief Print the data structure to console.
*
* This is a simple function to print the data read from a configuration
* file to the screen. This operation can be useful for debug and testing.
*/
void
print
();
};
/*! \fn DEDFB(std::string)
* \brief Data structure constructor.
*
* The default procedure to import a configuration file is to build a
* configuration object, according to one of the following flavours:
*
* DEDFB edfb_cfg = DEDFB("FILE_NAME"); // configuration object
*
* or
*
* DEDFB *edfb_cfg_ptr = new DEDFB("FILE_NAME"); // pointer version
*/
DEDFB
::
DEDFB
(
std
::
string
file_name
)
{
FILE
*
input_file
=
fopen
(
file_name
.
c_str
(),
"r"
);
int
exp_exdc
,
exp_wp
,
exp_xip
;
...
...
@@ -116,12 +123,6 @@ DEDFB::DEDFB(std::string file_name) {
fclose
(
input_file
);
}
/*! \fn print()
* \brief Print the data structure to console.
*
* This is a simple function to print the data read from a configuration
* file to the screen. This operation can be useful for debug and testing.
*/
void
DEDFB
::
print
()
{
printf
(
"### CONFIGURATION DATA ###
\n
"
);
printf
(
"NSPH = %d
\n
"
,
nsph
);
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment