Make doc-check fail the build on warnings

[alexxy/gromacs.git] / docs / doxygen / reporter.py

diff --git a/docs/doxygen/reporter.py b/docs/doxygen/reporter.py
index e541c54235f84f2fbf5c419f8d2e3397f49e6328..14e2bfbd88ef5bb55f806a5ceb1c90cc34b91b73 100644 (file)
--- a/docs/doxygen/reporter.py
+++ b/docs/doxygen/reporter.py
@@ -165,6 +165,7 @@ class Reporter(object):
         self._messages = []
         self._filters = []
         self._quiet = quiet
+        self._had_warnings = False
 
     def _write(self, message):
         """Implement actual message writing."""
@@ -178,6 +179,7 @@ class Reporter(object):
         sys.stderr.write(wholemsg)
         if self._logfp:
             self._logfp.write(wholemsg)
+        self._had_warnings = True
 
     def _report(self, message):
         """Handle a single reporter message."""
@@ -215,6 +217,10 @@ class Reporter(object):
                 text = 'warning: unused filter: ' + filterobj.get_text()
                 self._write(Message(text))
 
+    def had_warnings(self):
+        """Return true if any warnings have been reported."""
+        return self._had_warnings
+
     def close_log(self):
         """Close the log file if one exists."""
         assert not self._messages
@@ -240,6 +246,10 @@ class Reporter(object):
         self._report(Message('warning: ' + message, details,
             location=entity.get_reporter_location()))
 
+    def cyclic_issue(self, message, details=None):
+        """Report a cyclic dependency issue."""
+        self._report(Message('warning: ' + message, details))
+
     def doc_error(self, entity, message):
         """Report an issue in documentation."""
         self._report(Message('error: ' + entity.get_name() + ': ' + message,