Skip to content

Commit 6a40234

Browse files
authored
Merge pull request #6474 from jdannberg/remove_more_deafult_text
remove description of default implementation of declare/parse parameters in plugins
2 parents 9eb29f4 + 60a3619 commit 6a40234

File tree

4 files changed

+4
-28
lines changed

4 files changed

+4
-28
lines changed

include/aspect/boundary_traction/ascii_data.h

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,20 +95,14 @@ namespace aspect
9595
update () override;
9696

9797
/**
98-
* Declare the parameters this class takes through input files. The
99-
* default implementation of this function does not describe any
100-
* parameters. Consequently, derived classes do not have to overload
101-
* this function if they do not take any runtime parameters.
98+
* Declare the parameters this class takes through input files.
10299
*/
103100
static
104101
void
105102
declare_parameters (ParameterHandler &prm);
106103

107104
/**
108105
* Read the parameters this class declares from the parameter file.
109-
* The default implementation of this function does not read any
110-
* parameters. Consequently, derived classes do not have to overload
111-
* this function if they do not take any runtime parameters.
112106
*/
113107
void
114108
parse_parameters (ParameterHandler &prm) override;

include/aspect/geometry_model/spherical_shell.h

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -329,20 +329,14 @@ namespace aspect
329329

330330

331331
/**
332-
* Declare the parameters this class takes through input files. The
333-
* default implementation of this function does not describe any
334-
* parameters. Consequently, derived classes do not have to overload
335-
* this function if they do not take any runtime parameters.
332+
* Declare the parameters this class takes through input files.
336333
*/
337334
static
338335
void
339336
declare_parameters (ParameterHandler &prm);
340337

341338
/**
342339
* Read the parameters this class declares from the parameter file.
343-
* The default implementation of this function does not read any
344-
* parameters. Consequently, derived classes do not have to overload
345-
* this function if they do not take any runtime parameters.
346340
*/
347341
void
348342
parse_parameters (ParameterHandler &prm) override;

include/aspect/gravity_model/ascii_data.h

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,20 +61,14 @@ namespace aspect
6161
Tensor<1,dim> gravity_vector (const Point<dim> &position) const override;
6262

6363
/**
64-
* Declare the parameters this class takes through input files. The
65-
* default implementation of this function does not describe any
66-
* parameters. Consequently, derived classes do not have to overload
67-
* this function if they do not take any runtime parameters.
64+
* Declare the parameters this class takes through input files.
6865
*/
6966
static
7067
void
7168
declare_parameters (ParameterHandler &prm);
7269

7370
/**
7471
* Read the parameters this class declares from the parameter file.
75-
* The default implementation of this function does not read any
76-
* parameters. Consequently, derived classes do not have to overload
77-
* this function if they do not take any runtime parameters.
7872
*/
7973
void
8074
parse_parameters (ParameterHandler &prm) override;

include/aspect/initial_composition/world_builder.h

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,20 +65,14 @@ namespace aspect
6565
double initial_composition (const Point<dim> &position, const unsigned int n_comp) const override;
6666

6767
/**
68-
* Declare the parameters this class takes through input files. The
69-
* default implementation of this function does not describe any
70-
* parameters. Consequently, derived classes do not have to overload
71-
* this function if they do not take any runtime parameters.
68+
* Declare the parameters this class takes through input files.
7269
*/
7370
static
7471
void
7572
declare_parameters (ParameterHandler &prm);
7673

7774
/**
7875
* Read the parameters this class declares from the parameter file.
79-
* The default implementation of this function does not read any
80-
* parameters. Consequently, derived classes do not have to overload
81-
* this function if they do not take any runtime parameters.
8276
*/
8377
void
8478
parse_parameters (ParameterHandler &prm) override;

0 commit comments

Comments
 (0)