1
0
mirror of https://github.com/pocoproject/poco.git synced 2024-12-25 09:05:50 +01:00
poco/contrib/poco-doc.pl
Aleksandar Fabijanic d75e68c027 new trunk (base for 1.5)
windows build only
2012-04-23 01:14:34 +00:00

48 lines
1.0 KiB
Perl

#!/usr/bin/perl -wi
#
# poco-doc.pl
#
# This script, when run on a POCO header file, moves the documentation
# for classes, methods, etc above their declarations, making the code
# suitable for running through Doxygen, etc.
#
# Author: Caleb Epstein <caleb.epstein@gmail.com>
#
# $Id$
use strict;
use warnings;
my @COMMENT;
my @DECL;
my $comment_re = qr@^\s*//@;
while (<>) {
if ((/^\s*(template|class|enum)/ and not /\;\s*$/) or
(/[\(\)](\s*const)?\;$/ and $_ !~ $comment_re)) {
if (scalar @DECL) {
print join ("", @COMMENT) if scalar @COMMENT;
print join ("", @DECL);
}
@DECL = ($_);
@COMMENT = ();
next;
} elsif (m@^\s*///@ and scalar @DECL) {
push (@COMMENT, $_);
} else {
if (scalar @DECL) {
print join ("", @COMMENT) if scalar @COMMENT;
print join ("", @DECL);
@COMMENT = @DECL = ();
}
# Handle in-line documentation of enum values
if (m@^\s*[^/]@ and m@/// @) {
s@/// @///< @;
}
print;
}
}