admin/check-api-docs.awk

   1 #! /bin/sh
   2 # Copyright 2015 The Kyua Authors.
   3 # All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are
   7 # met:
   8 #
   9 # * Redistributions of source code must retain the above copyright
  10 #   notice, this list of conditions and the following disclaimer.
  11 # * Redistributions in binary form must reproduce the above copyright
  12 #   notice, this list of conditions and the following disclaimer in the
  13 #   documentation and/or other materials provided with the distribution.
  14 # * Neither the name of Google Inc. nor the names of its contributors
  15 #   may be used to endorse or promote products derived from this software
  16 #   without specific prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 BEGIN {
  31     failed = 0
  32 }
  33
  34 # Skip empty lines.
  35 /^$/ {next}
  36
  37 # Skip lines that do not directly reference a file.
  38 /^[^\/]/ {next}
  39
  40 # Ignore known problems.  As far as I can tell, all the cases listed here are
  41 # well-documented in the code but Doxygen fails, for some reason or another, to
  42 # properly locate the docstrings.
  43 /engine\/kyuafile\.cpp.*no matching class member/ {next}
  44 /engine\/scheduler\.hpp.*Member setup\(void\).*friend/ {next}
  45 /engine\/scheduler\.hpp.*Member wait_any\(void\)/ {next}
  46 /utils\/optional\.ipp.*no matching file member/ {next}
  47 /utils\/optional\.hpp.*Member make_optional\(const T &\)/ {next}
  48 /utils\/config\/nodes\.hpp.*Member set_lua\(lutok::state &, const int\)/ {next}
  49 /utils\/config\/nodes\.hpp.*Member push_lua\(lutok::state &\)/ {next}
  50 /utils\/config\/nodes\.hpp.*Member set_string\(const std::string &\)/ {next}
  51 /utils\/config\/nodes\.hpp.*Member to_string\(void\)/ {next}
  52 /utils\/config\/nodes\.hpp.*Member is_set\(void\)/ {next}
  53 /utils\/process\/executor\.hpp.*Member spawn\(Hook.*\)/ {next}
  54 /utils\/process\/executor\.hpp.*Member spawn_followup\(Hook.*\)/ {next}
  55 /utils\/process\/executor\.hpp.*Member setup\(void\).*friend/ {next}
  56 /utils\/signals\/timer\.hpp.*Member detail::invoke_do_fired.*friend/ {next}
  57 /utils\/stacktrace_test\.cpp.*no matching class member/ {next}
  58
  59 # Dump any other problems and account for the failure.
  60 {
  61     failed = 1
  62     print
  63 }
  64
  65 END {
  66     if (failed) {
  67         print "ERROR: Unexpected docstring problems encountered"
  68         exit 1
  69     } else {
  70         exit 0
  71     }
  72 }