Merge pull request #9 from albert-github/feature/bug_section_label

Correcting multiple use of doxygen section labels

Author: jordan2175

lib/Doxygen/Filter/Perl.pm

@@ -805,6 +805,7 @@ sub _ProcessPodCommentBlock
 
     my $parser = new Pod::POM();
     my $pom = $parser->parse_text($sPodRawText);
+    Doxygen::Filter::Perl::POD->setAsLabel($self->{'_hData'}->{'filename'}->{'fullpath'});
     my $sPodParsedText = Doxygen::Filter::Perl::POD->print($pom);
 
     $self->{'_hData'}->{'class'}->{$sClassName}->{'comments'} .= $sPodParsedText;

lib/Doxygen/Filter/Perl/POD.pm

@@ -30,7 +30,50 @@ use Log::Log4perl;
 
 our $VERSION     = '1.72';
 $VERSION = eval $VERSION;
+our $labelCnt = 0;  # label counter to see to it that when e.g. twice a =head1 NAME in a file it is still an unique label
+our $sectionLabel = 'x';
 
+sub convertText
+{
+    # based on e.g. a file name try to create a doxygen label prefix
+    my $label = shift;
+    $label =~ s/_/__/g;
+    $label =~ s/:/_1/g;
+    $label =~ s/\//_2/g;
+    $label =~ s/</_3/g;
+    $label =~ s/>/_4/g;
+    $label =~ s/\*/_5/g;
+    $label =~ s/&/_6/g;
+    $label =~ s/\|/_7/g;
+    $label =~ s/\./_8/g;
+    $label =~ s/!/_9/g;
+    $label =~ s/,/_00/g;
+    $label =~ s/ /_01/g;
+    $label =~ s/{/_02/g;
+    $label =~ s/}/_03/g;
+    $label =~ s/\?/_04/g;
+    $label =~ s/\^/_05/g;
+    $label =~ s/%/_06/g;
+    $label =~ s/\(/_07/g;
+    $label =~ s/\)/_08/g;
+    $label =~ s/\+/_09/g;
+    $label =~ s/=/_0A/g;
+    $label =~ s/\$/_0B/g;
+    $label =~ s/\\/_0C/g;
+    $label =~ s/@/_0D/g;
+    $label =~ s/-/_0E/g;
+    $label =~ s/[^a-z0-9A-Z]/_/g;
+    print("New $label\n");
+
+    $label = "x$label"; # label should not start with a underscore
+}
+sub setAsLabel
+{
+    # based on e.g. a file name try to create a doxygen label prefix
+    my $self = shift;
+    my $tmpLabel = shift;
+    $sectionLabel = convertText($tmpLabel);
+}
 
 sub view_pod 
 {
@@ -42,18 +85,36 @@ sub view_head1
 {
     my ($self, $head1) = @_;
     my $title = $head1->title->present($self);
-    my $name = $title;
-    $name =~ s/\s/_/g;
-    return "\n\@section $name $title\n" . $head1->content->present($self);
+    my $name = convertText($title);
+    $labelCnt += 1;
+    return "\n\@section $sectionLabel$name$labelCnt $title\n" . $head1->content->present($self);
 }
 
 sub view_head2 
 {
     my ($self, $head2) = @_;
     my $title = $head2->title->present($self);
-    my $name = $title;
-    $name =~ s/\s/_/g;    
-    return "\n\@subsection $name $title\n" . $head2->content->present($self);
+    my $name = convertText($title);
+    $labelCnt += 1;
+    return "\n\@subsection $sectionLabel$name$labelCnt $title\n" . $head2->content->present($self);
+}
+
+sub view_head3
+{
+    my ($self, $head3) = @_;
+    my $title = $head3->title->present($self);
+    my $name = convertText($title);
+    $labelCnt += 1;
+    return "\n\@subsubsection $sectionLabel$name$labelCnt $title\n" . $head3->content->present($self);
+}
+
+sub view_head4 
+{
+    my ($self, $head4) = @_;
+    my $title = $head4->title->present($self);
+    my $name = convertText($title);
+    $labelCnt += 1;
+    return "\n\@paragraph $sectionLabel$name$labelCnt $title\n" . $head4->content->present($self);
 }
 
 sub view_seq_code