blob: 2903fa6649bfa42a56bc99fba00fead9bf05c311 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
#!@PERL@ -w
#
# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
#
# SPDX-License-Identifier: MPL-2.0
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, you can obtain one at https://mozilla.org/MPL/2.0/.
#
# See the COPYRIGHT file distributed with this work for additional
# information regarding copyright ownership.
# Input filter for feeding our source code into Doxygen.
# Slurp whole file at once
undef $/;
$_ = <>;
# It turns out that there are a lot of cases where we'd really like to
# use what Doxygen calls "brief" documentation in a comment. Doxygen
# has a shorthand way of doing this -- if one is writing C++. ISC
# coding conventions require C, not C++, so we have to do it the
# verbose way, which makes a lot of comments too long to fit on a
# single line without violating another ISC coding standard (80
# character line limit).
#
# So we use Doxygen's input filter mechanism to define our own
# brief comment convention:
#
# /*% foo */
#
# expands to
#
# /*! \brief foo */
#
# and
#
# /*%< foo */
#
# expands to
#
# /*!< \brief foo */
#
s{/\*%(<?)}{/*!$1 \\brief }g;
# Doxygen appears to strip trailing newlines when reading files
# directly but not when reading from an input filter. Go figure.
# Future versions of Doxygen might change this, be warned.
#
s{\n+\z}{};
# Done, send the result to Doxygen.
#
print;
|
