Skip to content

Commit 0d01f87

Browse files
Alex-JordanAlex-Jordan
authored
Merge pull request #1264 from pstaabp/clean-up-lib-POD
Clean up pod in the lib directory
2 parents 8d537b4 + 20f753b commit 0d01f87

24 files changed

+734
-667
lines changed

‎lib/AnswerHash.pm

Lines changed: 125 additions & 134 deletions
Large diffs are not rendered by default.

‎lib/AnswerIO.pm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
=head1 NAME
33
4-
AnswerIO.pm
4+
AnswerIO.pm
55
6-
=head1 SYNPOSIS
6+
=head1 SYNOPSIS
77
88
This is not really an object, but it gives us a place to IO used by answer
99
macros.

‎lib/Applet.pm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
Applet.pl - Provides code for inserting GeogebraWebApplets into webwork problems
55
6-
=head1 SYNPOSIS
6+
=head1 SYNOPSIS
77
88
###################################
99
# Create the applet object

‎lib/ChoiceList.pm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
=head1 NAME
88
9-
ChoiceList.pm -- super-class for all ChoiceList structures
9+
ChoiceList.pm - super-class for all ChoiceList structures
1010
1111
=head1 SYNOPSIS
1212

‎lib/Circle.pm

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11

22
=head1 NAME
33
4-
Circle
4+
Circle
55
6-
=head1 SYNPOSIS
6+
=head1 SYNOPSIS
77
88
use Carp;
9-
use GD;
10-
use WWPlot;
11-
use Fun;
9+
use GD;
10+
use WWPlot;
11+
use Fun;
1212
1313
1414
=head1 DESCRIPTION
@@ -17,29 +17,28 @@ This module defines a circle which can be inserted as a stamp in a graph (WWPlot
1717
1818
=head2 Command:
1919
20-
$circle_object = new Circle( $center_pos_x, $center_pos_y, $radius, $border_color, $fill_color);
21-
20+
$circle_object = new Circle( $center_pos_x, $center_pos_y, $radius, $border_color, $fill_color);
2221
2322
=head2 Examples:
2423
25-
Here is the code used to define the subroutines open_circle
26-
and closed_circle in PGgraphmacros.pl
24+
Here is the code used to define the subroutines open_circle
25+
and closed_circle in PGgraphmacros.pl
2726
28-
sub open_circle {
29-
my ($cx,$cy,$color) = @_;
30-
new Circle ($cx, $cy, 4,$color,'nearwhite');
31-
}
27+
sub open_circle {
28+
my ($cx,$cy,$color) = @_;
29+
new Circle ($cx, $cy, 4,$color,'nearwhite');
30+
}
3231
33-
sub closed_circle {
34-
my ($cx,$cy, $color) = @_;
35-
$color = 'black' unless defined $color;
36-
new Circle ($cx, $cy, 4,$color, $color);
37-
}
32+
sub closed_circle {
33+
my ($cx,$cy, $color) = @_;
34+
$color = 'black' unless defined $color;
35+
new Circle ($cx, $cy, 4,$color, $color);
36+
}
3837
39-
$circle_object2 = closed_circle( $x_position, $y_position, $color );
38+
$circle_object2 = closed_circle( $x_position, $y_position, $color );
4039
41-
@circle_objects = $graph -> stamps($circle_object2);
42-
# puts a filled dot at ($x_position, $y_position) on the graph -- using real world coordinates.
40+
@circle_objects = $graph -> stamps($circle_object2);
41+
# puts a filled dot at ($x_position, $y_position) on the graph -- using real world coordinates.
4342
4443
=cut
4544

‎lib/Fraction.pm

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,47 +7,46 @@
77
# numerator/denominator.
88
# VS 7/20/2000
99

10-
=head3 Fraction
10+
=head1 NAME
1111
12-
This object is designed to ease the use of fractions
12+
Fraction - This object is designed to ease the use of fractions
1313
14-
=head4 Variables and Methods
14+
=head1 VARIABLES
1515
16-
Variables
16+
numerator # numerator of fraction
17+
denominator # denominator of fraction
1718
18-
numerator #numerator of fraction
19-
denominator #denominator of fraction
19+
=head1 METHODS
2020
21-
Arithmetic Methods #these will all accept a scalar value or
22-
#another fraction as an argument
21+
Arithmetic Methods #these will all accept a scalar value or
22+
#another fraction as an argument
2323
24-
plus #returns the sum of the fraction and argument
25-
minus #returns fraction minus argument
26-
subtractFrom #returns argument minus fraction
27-
divBy #returns fraction divided by argument
28-
divInto #returns argument divided by fraction
29-
times #returns fraction times argument
30-
compare #returns <, =, or > for the relation of fraction to argument
24+
plus #returns the sum of the fraction and argument
25+
minus #returns fraction minus argument
26+
subtractFrom #returns argument minus fraction
27+
divBy #returns fraction divided by argument
28+
divInto #returns argument divided by fraction
29+
times #returns fraction times argument
30+
compare #returns <, =, or > for the relation of fraction to argument
3131
32-
pow #returns fraction raised to argument, a given integer power
32+
pow #returns fraction raised to argument, a given integer power
3333
3434
35-
Other methods
35+
Other methods
3636
37-
reduce #reduces to lowest terms, and makes sure denominator is positive
38-
scalar #returns the scalar value numerator/denominator
39-
print #prints the fraction
40-
print_mixed #prints the fractionas a mixed number
41-
print_inline #prints the fraction like this 2/3
37+
reduce #reduces to lowest terms, and makes sure denominator is positive
38+
scalar #returns the scalar value numerator/denominator
39+
print #prints the fraction
40+
print_mixed #prints the fractionas a mixed number
41+
print_inline #prints the fraction like this 2/3
4242
4343
44-
=head4 Synopsis
44+
=head1 SYNOPSIS
4545
46-
The fraction object stores two variables, numerator and denominator. The basic
46+
The fraction object stores two variables, numerator and denominator. The basic
4747
arithmatic methods listed above can be performed on a fraction, and it can return its own
4848
scalar value for use with functions expecting a scalar (ie, sqrt($frac->scalar) ).
4949
50-
5150
=cut
5251

5352
package Fraction;

‎lib/Fun.pm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131

3232
=head1 NAME
3333
34-
Fun
34+
Fun
3535
36-
=head1 SYNPOSIS
36+
=head1 SYNOPSIS
3737
3838
use Carp;
3939
use GD;

‎lib/Hermite.pm

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,31 @@ use Carp;
44

55
=head1 NAME
66
7-
Hermite.pm
7+
Hermite.pm
88
9-
=head1 SYNPOSIS
10-
11-
Usage:
12-
$obj = new Hermit(\@x_values, \y_valuses \@yp_values);
13-
14-
#get and set methods
15-
$ra_x_values = $obj -> ra_x(\@x_values);
16-
$ra_y_values = $obj -> ra_y;
17-
$ra_yp_values = $obj -> ra_yp;
18-
19-
$obj -> initialize; # calculates the approximation
20-
21-
#get methods
22-
$rf_function = $obj -> rf_f;
23-
$rf_function_derivative = $obj -> rf_fp;
24-
$rf_function_2nd_derivative = $obj -> rf_fpp;
25-
26-
$rh_critical_points =$obj -> rh_critical_points
27-
$rh_inflection_points =$obj -> rh_inflection_points
9+
=head1 SYNOPSIS
2810
11+
Usage:
2912
13+
$obj = new Hermit(\@x_values, \y_valuses \@yp_values);
3014
15+
#get and set methods
16+
$ra_x_values = $obj -> ra_x(\@x_values);
17+
$ra_y_values = $obj -> ra_y;
18+
$ra_yp_values = $obj -> ra_yp;
19+
$obj -> initialize; # calculates the approximation
20+
#get methods
21+
$rf_function = $obj -> rf_f;
22+
$rf_function_derivative = $obj -> rf_fp;
23+
$rf_function_2nd_derivative = $obj -> rf_fpp;
24+
$rh_critical_points =$obj -> rh_critical_points
25+
$rh_inflection_points =$obj -> rh_inflection_points
3126
3227
=head1 DESCRIPTION
3328
3429
This module defines an object containing a Hermite spline approximation to a function.
35-
The approximation
36-
consists of a piecewise cubic polynomial which agrees with the original
37-
function and its first derivative at
38-
the node points.
30+
The approximation consists of a piecewise cubic polynomial which agrees with the original
31+
function and its first derivative at the node points.
3932
4033
This is useful for creating on the fly graphics. Care must be taken to use a small
4134
number of points spaced reasonably far apart, preferably

‎lib/Label.pm

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11

22
=head1 NAME
33
4-
Label
4+
Label
55
66
7-
=head1 SYNPOSIS
7+
=head1 SYNOPSIS
88
99
use Carp;
1010
use GD;
@@ -19,8 +19,8 @@ This module defines labels for the graph objects (WWPlot).
1919
2020
=head2 Usage
2121
22-
$label1 = new Label($x_value, $y_value, $label_string, $label_color, @options)
23-
$options is an array with (*'d defaults)
22+
$label1 = new Label($x_value, $y_value, $label_string, $label_color, @options)
23+
$options is an array with (*'d defaults)
2424
- one of 'left'*, 'center', 'right' (horizontal alignment)
2525
- one of 'bottom', 'center', 'top'* (verical alignment)
2626
- one of 'horizontal'*, 'vertical' (orientation)

‎lib/List.pm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
=head1 NAME
88
9-
List.pm -- super-class for all list structures
9+
List.pm - super-class for all list structures
1010
1111
=head1 SYNOPSIS
1212

0 commit comments

Comments
 (0)