docs: Update doxyxml.

Signed-off-by: Ryan Volz <[email protected]>

docs/doxygen/CMakeLists.txt

@@ -3,32 +3,21 @@
 # This file was generated by gr_modtool, a tool from the GNU Radio framework
 # This file is a part of gr-radar
 #
-# GNU Radio is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3, or (at your option)
-# any later version.
+# SPDX-License-Identifier: GPL-3.0-or-later
 #
-# GNU Radio is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with GNU Radio; see the file COPYING.  If not, write to
-# the Free Software Foundation, Inc., 51 Franklin Street,
-# Boston, MA 02110-1301, USA.
 
 ########################################################################
 # Create the doxygen configuration file
 ########################################################################
-file(TO_NATIVE_PATH ${CMAKE_SOURCE_DIR} top_srcdir)
-file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR} top_builddir)
-file(TO_NATIVE_PATH ${CMAKE_SOURCE_DIR} abs_top_srcdir)
-file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR} abs_top_builddir)
+file(TO_NATIVE_PATH ${PROJECT_SOURCE_DIR} top_srcdir)
+file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR} top_builddir)
+file(TO_NATIVE_PATH ${PROJECT_SOURCE_DIR} abs_top_srcdir)
+file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR} abs_top_builddir)
 
 set(HAVE_DOT ${DOXYGEN_DOT_FOUND})
 set(enable_html_docs YES)
 set(enable_latex_docs NO)
+set(enable_mathjax NO)
 set(enable_xml_docs YES)
 
 configure_file(

docs/doxygen/doxyxml/__init__.py

@@ -4,20 +4,8 @@
 # This file was generated by gr_modtool, a tool from the GNU Radio framework
 # This file is a part of gr-radar
 #
-# GNU Radio is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3, or (at your option)
-# any later version.
+# SPDX-License-Identifier: GPL-3.0-or-later
 #
-# GNU Radio is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with GNU Radio; see the file COPYING.  If not, write to
-# the Free Software Foundation, Inc., 51 Franklin Street,
-# Boston, MA 02110-1301, USA.
 #
 """
 Python interface to contents of doxygen xml documentation.
@@ -64,10 +52,10 @@
 u'Outputs the vital aadvark statistics.'
 
 """
-from __future__ import unicode_literals
 
 from .doxyindex import DoxyIndex, DoxyFunction, DoxyParam, DoxyClass, DoxyFile, DoxyNamespace, DoxyGroup, DoxyFriend, DoxyOther
 
+
 def _test():
     import os
     this_dir = os.path.dirname(globals()['__file__'])
@@ -79,6 +67,6 @@ def _test():
     import doctest
     return doctest.testmod()
 
+
 if __name__ == "__main__":
     _test()
-

docs/doxygen/doxyxml/base.py

@@ -4,29 +4,15 @@
 # This file was generated by gr_modtool, a tool from the GNU Radio framework
 # This file is a part of gr-radar
 #
-# GNU Radio is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3, or (at your option)
-# any later version.
+# SPDX-License-Identifier: GPL-3.0-or-later
 #
-# GNU Radio is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with GNU Radio; see the file COPYING.  If not, write to
-# the Free Software Foundation, Inc., 51 Franklin Street,
-# Boston, MA 02110-1301, USA.
 #
 """
 A base class is created.
 
 Classes based upon this are used to make more user-friendly interfaces
 to the doxygen xml docs than the generated classes provide.
 """
-from __future__ import print_function
-from __future__ import unicode_literals
 
 import os
 import pdb
@@ -97,8 +83,8 @@ def get_cls(self, mem):
         for cls in self.mem_classes:
             if cls.can_parse(mem):
                 return cls
-        raise Exception(("Did not find a class for object '%s'." \
-                                 % (mem.get_name())))
+        raise Exception(("Did not find a class for object '%s'."
+                         % (mem.get_name())))
 
     def convert_mem(self, mem):
         try:

docs/doxygen/doxyxml/doxyindex.py

@@ -4,34 +4,21 @@
 # This file was generated by gr_modtool, a tool from the GNU Radio framework
 # This file is a part of gr-radar
 #
-# GNU Radio is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3, or (at your option)
-# any later version.
+# SPDX-License-Identifier: GPL-3.0-or-later
 #
-# GNU Radio is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with GNU Radio; see the file COPYING.  If not, write to
-# the Free Software Foundation, Inc., 51 Franklin Street,
-# Boston, MA 02110-1301, USA.
 #
 """
 Classes providing more user-friendly interfaces to the doxygen xml
 docs than the generated classes provide.
 """
-from __future__ import absolute_import
-from __future__ import unicode_literals
 
 import os
 
 from .generated import index
 from .base import Base
 from .text import description
 
+
 class DoxyIndex(Base):
     """
     Parses a doxygen xml directory.
@@ -60,17 +47,8 @@ def _parse(self):
                 self._members.append(converted)
 
 
-def generate_swig_doc_i(self):
-    """
-    %feature("docstring") gr_make_align_on_samplenumbers_ss::align_state "
-    Wraps the C++: gr_align_on_samplenumbers_ss::align_state";
-    """
-    pass
-
-
 class DoxyCompMem(Base):
 
-
     kind = None
 
     def __init__(self, *args, **kwargs):
@@ -106,9 +84,11 @@ def set_parameters(self, data):
 class DoxyCompound(DoxyCompMem):
     pass
 
+
 class DoxyMember(DoxyCompMem):
     pass
 
+
 class DoxyFunction(DoxyMember):
 
     __module__ = "gnuradio.utils.doxyxml"
@@ -129,9 +109,11 @@ def _parse(self):
                 self._data['params'].append(DoxyParam(prm))
 
     brief_description = property(lambda self: self.data()['brief_description'])
-    detailed_description = property(lambda self: self.data()['detailed_description'])
+    detailed_description = property(
+        lambda self: self.data()['detailed_description'])
     params = property(lambda self: self.data()['params'])
 
+
 Base.mem_classes.append(DoxyFunction)
 
 
@@ -156,9 +138,11 @@ def description(self):
         return '\n\n'.join(descriptions)
 
     brief_description = property(lambda self: self.data()['brief_description'])
-    detailed_description = property(lambda self: self.data()['detailed_description'])
+    detailed_description = property(
+        lambda self: self.data()['detailed_description'])
     name = property(lambda self: self.data()['declname'])
 
+
 class DoxyParameterItem(DoxyMember):
     """A different representation of a parameter in Doxygen."""
 
@@ -200,9 +184,11 @@ def _parse(self):
         self.process_memberdefs()
 
     brief_description = property(lambda self: self.data()['brief_description'])
-    detailed_description = property(lambda self: self.data()['detailed_description'])
+    detailed_description = property(
+        lambda self: self.data()['detailed_description'])
     params = property(lambda self: self.data()['params'])
 
+
 Base.mem_classes.append(DoxyClass)
 
 
@@ -223,7 +209,9 @@ def _parse(self):
         self.process_memberdefs()
 
     brief_description = property(lambda self: self.data()['brief_description'])
-    detailed_description = property(lambda self: self.data()['detailed_description'])
+    detailed_description = property(
+        lambda self: self.data()['detailed_description'])
+
 
 Base.mem_classes.append(DoxyFile)
 
@@ -244,6 +232,7 @@ def _parse(self):
             return
         self.process_memberdefs()
 
+
 Base.mem_classes.append(DoxyNamespace)
 
 
@@ -287,6 +276,7 @@ class DoxyFriend(DoxyMember):
 
     kind = 'friend'
 
+
 Base.mem_classes.append(DoxyFriend)
 
 
@@ -301,4 +291,5 @@ class DoxyOther(Base):
     def can_parse(cls, obj):
         return obj.kind in cls.kinds
 
+
 Base.mem_classes.append(DoxyOther)

docs/doxygen/doxyxml/generated/__init__.py

@@ -5,4 +5,3 @@
 resultant classes are not very friendly to navigate so the rest of the
 doxyxml module processes them further.
 """
-from __future__ import unicode_literals