1#!@PERL@ -w
2#
3# Copyright (C) 2006, 2007, 2012  Internet Systems Consortium, Inc. ("ISC")
4#
5# Permission to use, copy, modify, and/or distribute this software for any
6# purpose with or without fee is hereby granted, provided that the above
7# copyright notice and this permission notice appear in all copies.
8#
9# THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11# AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15# PERFORMANCE OF THIS SOFTWARE.
16
17# Id: doxygen-input-filter.in,v 1.4 2007/06/19 23:47:13 tbox Exp
18
19# Input filter for feeding our source code into Doxygen.
20
21# Slurp whole file at once
22undef $/;
23$_ = <>;
24
25# It turns out that there are a lot of cases where we'd really like to
26# use what Doxygen calls "brief" documentation in a comment.  Doxygen
27# has a shorthand way of doing this -- if one is writing C++.  ISC
28# coding conventions require C, not C++, so we have to do it the
29# verbose way, which makes a lot of comments too long to fit on a
30# single line without violating another ISC coding standard (80
31# character line limit).
32#
33# So we use Doxygen's input filter mechanism to define our own
34# brief comment convention:
35#
36#	/*% foo */
37#
38# expands to
39#
40#	/*! \brief foo */
41#
42# and
43#
44#	/*%< foo */
45#
46# expands to
47#
48#	/*!< \brief foo */
49#
50s{/\*%(<?)}{/*!$1 \\brief }g;
51
52# Doxygen appears to strip trailing newlines when reading files
53# directly but not when reading from an input filter.  Go figure.
54# Future versions of Doxygen might change this, be warned.
55#
56s{\n+\z}{};
57
58# Done, send the result to Doxygen.
59#
60print;
61