Browse Source

Update doxygen again

tags/version/0.1.15^0
Kai Kretschmann 2 months ago
parent
commit
db08c39d04
3 changed files with 7 additions and 10 deletions
  1. 5
    8
      JCmeasure.cpp
  2. 1
    1
      MeasureBase.cpp
  3. 1
    1
      MeasureEntropy.cpp

+ 5
- 8
JCmeasure.cpp View File

@@ -1,11 +1,8 @@
1 1
 /**
2 2
  * @file JCmeasure.cpp
3 3
  * @author Kai KRETSCHMANN
4
- *
5
- * @section DESCRIPTION
6
- *
7
- * Main method to start application.
8
- *
4
+ * @copyright SPDX-License-Identifier: MIT
5
+ * @brief Main method to start application.
9 6
  **/
10 7
 #include <iostream>
11 8
 #include <memory>
@@ -18,10 +15,10 @@ using namespace std;
18 15
 using namespace jastacry;
19 16
 
20 17
 /**
21
- * Main method.
18
+ * @brief Main method.
22 19
  *
23
- * @param argc Number of parameters, we expect one means == 2
24
- * @param argv Array of arguments, first one will be file name.
20
+ * @param argc [in] - Number of parameters, we expect one means == 2
21
+ * @param argv [in] - Array of arguments, first one will be file name.
25 22
  *
26 23
  */
27 24
 int main(int argc, char **argv) {

+ 1
- 1
MeasureBase.cpp View File

@@ -2,7 +2,7 @@
2 2
  * @file MeasureBase.h
3 3
  * @author Kai KRETSCHMANN
4 4
  *
5
- * @license SPDX-License-Identifier: MIT
5
+ * @copyright SPDX-License-Identifier: MIT
6 6
  *
7 7
  * @brief Base class for doing measurements.
8 8
  *

+ 1
- 1
MeasureEntropy.cpp View File

@@ -2,7 +2,7 @@
2 2
  * @file MeasureEntropy.h
3 3
  * @author Kai KRETSCHMANN
4 4
  *
5
- * @license SPDX-License-Identifier: MIT
5
+ * @copyright SPDX-License-Identifier: MIT
6 6
  *
7 7
  * @brief Real entropy calculation class for doing measurements.
8 8
  *

Loading…
Cancel
Save
Social stuff:
Mastodon