Add a description of extract-doc.pl script

[libucw.git] / build / extract-doc.pl

diff --git a/build/extract-doc.pl b/build/extract-doc.pl
index 4b700c14488a3c0bea9c5ef0dc013bf59dd4cbe3..7eb28354f699ed9eb705a33934625dbae93fc6e3 100755 (executable)
--- a/build/extract-doc.pl
+++ b/build/extract-doc.pl
@@ -1,4 +1,7 @@
 #!/usr/bin/perl
+# Script for extracting documentation out of header files
+# (c) 2008 Michal Vaner <vorner@ucw.cz>
+
 use strict;
 use warnings;
 
@@ -26,9 +29,14 @@ sub formatNote( $$ ) {
        $head =~ s/(\S)[ ]+/$1 /g;
        print OUT "\n";
        print OUT "''''\n";
-       print OUT "..................\n";
-       print OUT "$head\n";
-       print OUT "..................\n\n";
+       chomp $head;
+       if($head =~ /\w+\([^()]*\)/ && $head !~ /\n/) {
+               print OUT "!!f!$head!!!\n\n";
+       } else {
+               print OUT "..................\n";
+               print OUT "$head\n";
+               print OUT "..................\n\n";
+       }
        print OUT "$comment\n\n";
 }