Skip to content

Commit 937b567

Browse files
committed
Correcting some spelling errors
Correcting some spelling errors and obvious doxygen problems.
1 parent 53d3368 commit 937b567

File tree

2 files changed

+13
-15
lines changed

2 files changed

+13
-15
lines changed

lib/Doxygen/Filter.pm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ $VERSION = eval $VERSION;
3535
sub GetLogger
3636
{
3737
#** @method public GetLogger ($object)
38-
# This method is a helper method to get the Log4perl logger object ane make sure
38+
# This method is a helper method to get the Log4perl logger object and make sure
3939
# it knows from which class it was called regardless of where it actually lives.
4040
#*
4141
my $self = shift;

lib/Doxygen/Filter/Perl.pm

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ sub ProcessFile
230230
{
231231
# The general idea is we gather the whole doxygen comment in to an array and process
232232
# that array all at once in the _ProcessDoxygenCommentBlock. This way we do not have
233-
# to artifically keep track of what type of comment block it is between each line
233+
# to artificially keep track of what type of comment block it is between each line
234234
# that we read from the file.
235235
$logger->debug("End of Doxygen Comment Block");
236236
$self->_ProcessDoxygenCommentBlock();
@@ -505,7 +505,7 @@ sub _ChangeState
505505
}
506506
else
507507
{
508-
# If nothing is passed in, lets set the current state to the preivous state.
508+
# If nothing is passed in, lets set the current state to the previous state.
509509
$logger->debug("No state passed in, lets revert to previous state");
510510
my $previous = pop @{$self->{'_sPreviousState'}};
511511
if (defined $previous)
@@ -611,9 +611,7 @@ sub _PrintMethodBlock
611611
#** @method private _PrintMethodBlock ($class, $methodDef)
612612
# This method will print the various subroutines/functions/methods in apprporiate doxygen syntax
613613
# @param class - required string (name of the class)
614-
# @param state - required string (current state)
615-
# @param type - required string (type)
616-
# @param method - required string (name of method)
614+
# @param methodDef - required string (name of method)
617615
#*
618616
my $self = shift;
619617
my $class = shift;
@@ -691,7 +689,7 @@ sub _ProcessPerlMethod
691689
{
692690
#** @method private _ProcessPerlMethod ($line)
693691
# This method will process the contents of a subroutine/function/method and try to figure out
694-
# the name and wether or not it is a private or public method. The private or public status,
692+
# the name and whether or not it is a private or public method. The private or public status,
695693
# if not defined in a doxygen comment block will be determined based on the file name. As with
696694
# C and other languages, an "_" should be the first character for all private functions/methods.
697695
# @param line - required string (full line of code)
@@ -797,9 +795,9 @@ sub _ProcessPerlMethod
797795
$logger->debug("A subroutine has been started but we are not yet in it as we have yet to see an open brace");
798796
}
799797
800-
# Doxygen makes use of the @ symbol and treats it as a special reserved character. This is a problem for perl
801-
# and especailly when we are documenting our own Doxygen code we have print statements that include things like @endcode
802-
# as is found in _PrintMethodBlock(). Lets convert those @ to @amp;
798+
# Doxygen makes use of the `@` symbol and treats it as a special reserved character. This is a problem for perl
799+
# and especially when we are documenting our own Doxygen code we have print statements that include things likea `@endcode`
800+
# as is found in _PrintMethodBlock(). Lets convert those `@` to `@amp;`
803801
$line =~ s/\@endcode/\&\#64\;endcode/g;
804802

805803
# Record the current line for code output
@@ -1096,7 +1094,7 @@ sub _ConvertToOfficialDoxygenSyntax
10961094
{
10971095
#** @method private _ConvertToOfficialDoxygenSyntax ($line)
10981096
# This method will check the current line for various unsupported doxygen comment blocks and convert them
1099-
# to the type we support, '#** @command'. The reason for this is so that we do not need to add them in
1097+
# to the type we support, #** @command. The reason for this is so that we do not need to add them in
11001098
# every if statement throughout the code.
11011099
# @param line - required string (line of code)
11021100
# @retval line - string (line of code)
@@ -1106,7 +1104,7 @@ sub _ConvertToOfficialDoxygenSyntax
11061104
my $logger = $self->GetLogger($self);
11071105
$logger->debug("### Entering _ConvertToOfficialDoxygenSyntax ###");
11081106

1109-
# This will match "## @command" and convert it to "#** @command"
1107+
# This will match ## @command and convert it to #** @command
11101108
if ($line =~ /^\s*##\s+\@/) { $line =~ s/^(\s*)##(\s+\@)/$1#\*\*$2/; }
11111109
else {
11121110
$logger->debug('Nothing to do, did not find any ## @');
@@ -1226,9 +1224,9 @@ continuous "#" comment markers as a blank line can be used as a termination
12261224
mark for the doxygen comment block.
12271225
12281226
In other languages the Doxygen @fn structural indicator is used to document
1229-
subroutines/functions/methods and the parsing engine figures out what is what.
1230-
In Perl that is a lot harder to do so I have added a @method and @function
1231-
structural indicator so that they can be documented seperatly.
1227+
subroutines/functions/methods and the parsing engine figures out what is what.
1228+
In Perl that is a lot harder to do so I have added a `@method` and `@function`
1229+
structural indicator so that they can be documented separately.
12321230
12331231
=head2 Supported Structural Indicators
12341232

0 commit comments

Comments
 (0)