diff options
author | Tom Rondeau | 2012-04-13 18:36:53 -0400 |
---|---|---|
committer | Tom Rondeau | 2012-04-13 18:36:53 -0400 |
commit | f919f9dcbb54a08e6e26d6c229ce92fb784fa1b2 (patch) | |
tree | 7e846386b9eb1676f9a93fc4a1e55916b9accc97 /docs/doxygen/doxyxml | |
parent | 6a1e9783fec6ed827f49db27c171591d30f32933 (diff) | |
download | gnuradio-f919f9dcbb54a08e6e26d6c229ce92fb784fa1b2.tar.gz gnuradio-f919f9dcbb54a08e6e26d6c229ce92fb784fa1b2.tar.bz2 gnuradio-f919f9dcbb54a08e6e26d6c229ce92fb784fa1b2.zip |
Removed whitespace and added dtools/bin/remove-whitespace as a tool to do this in the future.
The sed script was provided by Moritz Fischer.
Diffstat (limited to 'docs/doxygen/doxyxml')
-rw-r--r-- | docs/doxygen/doxyxml/__init__.py | 14 | ||||
-rw-r--r-- | docs/doxygen/doxyxml/base.py | 18 | ||||
-rw-r--r-- | docs/doxygen/doxyxml/doxyindex.py | 42 | ||||
-rw-r--r-- | docs/doxygen/doxyxml/example/aadvark.cc | 8 | ||||
-rw-r--r-- | docs/doxygen/doxyxml/example/aadvark.h | 8 | ||||
-rw-r--r-- | docs/doxygen/doxyxml/example/xml/combine.xslt | 2 | ||||
-rw-r--r-- | docs/doxygen/doxyxml/example/xml/compound.xsd | 34 | ||||
-rw-r--r-- | docs/doxygen/doxyxml/example/xml/index.xsd | 2 | ||||
-rw-r--r-- | docs/doxygen/doxyxml/text.py | 10 |
9 files changed, 69 insertions, 69 deletions
diff --git a/docs/doxygen/doxyxml/__init__.py b/docs/doxygen/doxyxml/__init__.py index c9786c3f8..5cd0b3c6c 100644 --- a/docs/doxygen/doxyxml/__init__.py +++ b/docs/doxygen/doxyxml/__init__.py @@ -1,23 +1,23 @@ # # Copyright 2010 Free Software Foundation, Inc. -# +# # This file is part of GNU Radio -# +# # 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. -# +# # 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. @@ -27,7 +27,7 @@ doxygen-generated xml used in this example. >>> # Parse the doxygen docs. >>> import os ->>> this_dir = os.path.dirname(globals()['__file__']) +>>> this_dir = os.path.dirname(globals()['__file__']) >>> xml_path = this_dir + "/example/xml/" >>> di = DoxyIndex(xml_path) @@ -68,7 +68,7 @@ from doxyindex import DoxyIndex, DoxyFunction, DoxyParam, DoxyClass, DoxyFile, D def _test(): import os - this_dir = os.path.dirname(globals()['__file__']) + this_dir = os.path.dirname(globals()['__file__']) xml_path = this_dir + "/example/xml/" di = DoxyIndex(xml_path) # Get the Aadvark class diff --git a/docs/doxygen/doxyxml/base.py b/docs/doxygen/doxyxml/base.py index 097e3f15b..e8f026ab9 100644 --- a/docs/doxygen/doxyxml/base.py +++ b/docs/doxygen/doxyxml/base.py @@ -1,23 +1,23 @@ # # Copyright 2010 Free Software Foundation, Inc. -# +# # This file is part of GNU Radio -# +# # 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. -# +# # 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. @@ -144,7 +144,7 @@ class Base(object): self._in_category[cat] = [mem for mem in self._members if cat.includes(mem)] return self._in_category[cat] - + def get_member(self, name, cat=None): self.confirm_no_error() # Check if it's in a namespace or class. @@ -173,7 +173,7 @@ class Base(object): def members(self): self.confirm_no_error() return self._members - + def process_memberdefs(self): mdtss = [] for sec in self._retrieved_data.compounddef.sectiondef: @@ -188,7 +188,7 @@ class Base(object): if pair not in uniques: uniques.add(pair) self._members.append(converted) - + def retrieve_data(self): filename = os.path.join(self._xml_path, self.refid + '.xml') try: @@ -197,7 +197,7 @@ class Base(object): print('Error in xml in file %s' % filename) self._error = True self._retrieved_data = None - + def check_parsed(self): if not self._parsed: self._parse() diff --git a/docs/doxygen/doxyxml/doxyindex.py b/docs/doxygen/doxyxml/doxyindex.py index 42aa4ca58..0132ab86f 100644 --- a/docs/doxygen/doxyxml/doxyindex.py +++ b/docs/doxygen/doxyxml/doxyindex.py @@ -1,23 +1,23 @@ # # Copyright 2010 Free Software Foundation, Inc. -# +# # This file is part of GNU Radio -# +# # 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. -# +# # 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. @@ -40,7 +40,7 @@ class DoxyIndex(Base): if self._parsed: return super(DoxyIndex, self)._parse() - self._root = index.parse(os.path.join(self._xml_path, 'index.xml')) + self._root = index.parse(os.path.join(self._xml_path, 'index.xml')) for mem in self._root.compound: converted = self.convert_mem(mem) # For files we want the contents to be accessible directly @@ -78,14 +78,14 @@ class DoxyCompMem(Base): bd = description(getattr(parse_data, 'briefdescription', None)) dd = description(getattr(parse_data, 'detaileddescription', None)) self._data['brief_description'] = bd - self._data['detailed_description'] = dd + self._data['detailed_description'] = dd class DoxyCompound(DoxyCompMem): pass class DoxyMember(DoxyCompMem): pass - + class DoxyFunction(DoxyMember): @@ -111,7 +111,7 @@ Base.mem_classes.append(DoxyFunction) class DoxyParam(DoxyMember): - + __module__ = "gnuradio.utils.doxyxml" def _parse(self): @@ -126,11 +126,11 @@ class DoxyParam(DoxyMember): declname = property(lambda self: self.data()['declname']) class DoxyClass(DoxyCompound): - + __module__ = "gnuradio.utils.doxyxml" kind = 'class' - + def _parse(self): if self._parsed: return @@ -147,14 +147,14 @@ class DoxyClass(DoxyCompound): detailed_description = property(lambda self: self.data()['detailed_description']) Base.mem_classes.append(DoxyClass) - + class DoxyFile(DoxyCompound): - + __module__ = "gnuradio.utils.doxyxml" kind = 'file' - + def _parse(self): if self._parsed: return @@ -164,7 +164,7 @@ class DoxyFile(DoxyCompound): if self._error: return self.process_memberdefs() - + brief_description = property(lambda self: self.data()['brief_description']) detailed_description = property(lambda self: self.data()['detailed_description']) @@ -172,16 +172,16 @@ Base.mem_classes.append(DoxyFile) class DoxyNamespace(DoxyCompound): - + __module__ = "gnuradio.utils.doxyxml" kind = 'namespace' - + Base.mem_classes.append(DoxyNamespace) class DoxyGroup(DoxyCompound): - + __module__ = "gnuradio.utils.doxyxml" kind = 'group' @@ -209,7 +209,7 @@ class DoxyGroup(DoxyCompound): self.process_memberdefs() title = property(lambda self: self.data()['title']) - + Base.mem_classes.append(DoxyGroup) @@ -224,7 +224,7 @@ Base.mem_classes.append(DoxyFriend) class DoxyOther(Base): - + __module__ = "gnuradio.utils.doxyxml" kinds = set(['variable', 'struct', 'union', 'define', 'typedef', 'enum', 'dir', 'page']) @@ -232,6 +232,6 @@ class DoxyOther(Base): @classmethod def can_parse(cls, obj): return obj.kind in cls.kinds - + Base.mem_classes.append(DoxyOther) diff --git a/docs/doxygen/doxyxml/example/aadvark.cc b/docs/doxygen/doxyxml/example/aadvark.cc index 5744c428a..f91c1ba56 100644 --- a/docs/doxygen/doxyxml/example/aadvark.cc +++ b/docs/doxygen/doxyxml/example/aadvark.cc @@ -1,19 +1,19 @@ /* -*- c++ -*- */ /* * Copyright 2010 Free Software Foundation, Inc. - * + * * This file is part of GNU Radio - * + * * 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. - * + * * 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, diff --git a/docs/doxygen/doxyxml/example/aadvark.h b/docs/doxygen/doxyxml/example/aadvark.h index 7b8f29c98..d3c17445e 100644 --- a/docs/doxygen/doxyxml/example/aadvark.h +++ b/docs/doxygen/doxyxml/example/aadvark.h @@ -1,19 +1,19 @@ /* -*- c++ -*- */ /* * Copyright 2010 Free Software Foundation, Inc. - * + * * This file is part of GNU Radio - * + * * 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. - * + * * 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, diff --git a/docs/doxygen/doxyxml/example/xml/combine.xslt b/docs/doxygen/doxyxml/example/xml/combine.xslt index abdd9ac75..6de203a2b 100644 --- a/docs/doxygen/doxyxml/example/xml/combine.xslt +++ b/docs/doxygen/doxyxml/example/xml/combine.xslt @@ -1,4 +1,4 @@ -<!-- XSLT script to combine the generated output into a single file. +<!-- XSLT script to combine the generated output into a single file. If you have xsltproc you could use: xsltproc combine.xslt index.xml >all.xml --> diff --git a/docs/doxygen/doxyxml/example/xml/compound.xsd b/docs/doxygen/doxyxml/example/xml/compound.xsd index 369e2300f..5bb567052 100644 --- a/docs/doxygen/doxyxml/example/xml/compound.xsd +++ b/docs/doxygen/doxyxml/example/xml/compound.xsd @@ -173,7 +173,7 @@ <xsd:complexType name="descriptionType" mixed="true"> <xsd:sequence> - <xsd:element name="title" type="xsd:string" minOccurs="0"/> + <xsd:element name="title" type="xsd:string" minOccurs="0"/> <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="internal" type="docInternalType" minOccurs="0" /> @@ -283,7 +283,7 @@ <xsd:complexType name="docSect1Type" mixed="true"> <xsd:sequence> - <xsd:element name="title" type="xsd:string" /> + <xsd:element name="title" type="xsd:string" /> <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="internal" type="docInternalS1Type" minOccurs="0" /> @@ -293,7 +293,7 @@ <xsd:complexType name="docSect2Type" mixed="true"> <xsd:sequence> - <xsd:element name="title" type="xsd:string" /> + <xsd:element name="title" type="xsd:string" /> <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="internal" type="docInternalS2Type" minOccurs="0" /> @@ -303,7 +303,7 @@ <xsd:complexType name="docSect3Type" mixed="true"> <xsd:sequence> - <xsd:element name="title" type="xsd:string" /> + <xsd:element name="title" type="xsd:string" /> <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="sect4" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="internal" type="docInternalS3Type" minOccurs="0" /> @@ -313,7 +313,7 @@ <xsd:complexType name="docSect4Type" mixed="true"> <xsd:sequence> - <xsd:element name="title" type="xsd:string" /> + <xsd:element name="title" type="xsd:string" /> <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="internal" type="docInternalS4Type" minOccurs="0" /> </xsd:sequence> @@ -353,7 +353,7 @@ <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> - + <xsd:group name="docTitleCmdGroup"> <xsd:choice> <xsd:element name="ulink" type="docURLLink" /> @@ -532,20 +532,20 @@ <xsd:complexType name="docImageType" mixed="true"> <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" /> - <xsd:attribute name="type" type="DoxImageKind" /> - <xsd:attribute name="name" type="xsd:string" /> - <xsd:attribute name="width" type="xsd:string" /> - <xsd:attribute name="height" type="xsd:string" /> + <xsd:attribute name="type" type="DoxImageKind" /> + <xsd:attribute name="name" type="xsd:string" /> + <xsd:attribute name="width" type="xsd:string" /> + <xsd:attribute name="height" type="xsd:string" /> </xsd:complexType> <xsd:complexType name="docDotFileType" mixed="true"> <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" /> - <xsd:attribute name="name" type="xsd:string" /> + <xsd:attribute name="name" type="xsd:string" /> </xsd:complexType> <xsd:complexType name="docTocItemType" mixed="true"> <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" /> - <xsd:attribute name="id" type="xsd:string" /> + <xsd:attribute name="id" type="xsd:string" /> </xsd:complexType> <xsd:complexType name="docTocListType"> @@ -558,14 +558,14 @@ <xsd:sequence> <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> - <xsd:attribute name="langid" type="xsd:string" /> + <xsd:attribute name="langid" type="xsd:string" /> </xsd:complexType> <xsd:complexType name="docParamListType"> <xsd:sequence> <xsd:element name="parameteritem" type="docParamListItem" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> - <xsd:attribute name="kind" type="DoxParamListKind" /> + <xsd:attribute name="kind" type="DoxParamListKind" /> </xsd:complexType> <xsd:complexType name="docParamListItem"> @@ -593,7 +593,7 @@ <xsd:element name="xreftitle" type="xsd:string" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="xrefdescription" type="descriptionType" /> </xsd:sequence> - <xsd:attribute name="id" type="xsd:string" /> + <xsd:attribute name="id" type="xsd:string" /> </xsd:complexType> <xsd:complexType name="docCopyType"> @@ -602,11 +602,11 @@ <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="internal" type="docInternalType" minOccurs="0" /> </xsd:sequence> - <xsd:attribute name="link" type="xsd:string" /> + <xsd:attribute name="link" type="xsd:string" /> </xsd:complexType> <xsd:complexType name="docCharType"> - <xsd:attribute name="char" type="DoxCharRange"/> + <xsd:attribute name="char" type="DoxCharRange"/> </xsd:complexType> <xsd:complexType name="docEmptyType"/> diff --git a/docs/doxygen/doxyxml/example/xml/index.xsd b/docs/doxygen/doxyxml/example/xml/index.xsd index d7ab2a906..bfe960c0f 100644 --- a/docs/doxygen/doxyxml/example/xml/index.xsd +++ b/docs/doxygen/doxyxml/example/xml/index.xsd @@ -25,7 +25,7 @@ <xsd:attribute name="refid" type="xsd:string" use="required"/> <xsd:attribute name="kind" type="MemberKind" use="required"/> </xsd:complexType> - + <xsd:simpleType name="CompoundKind"> <xsd:restriction base="xsd:string"> <xsd:enumeration value="class"/> diff --git a/docs/doxygen/doxyxml/text.py b/docs/doxygen/doxyxml/text.py index ddf2c36e2..629edd180 100644 --- a/docs/doxygen/doxyxml/text.py +++ b/docs/doxygen/doxyxml/text.py @@ -1,23 +1,23 @@ # # Copyright 2010 Free Software Foundation, Inc. -# +# # This file is part of GNU Radio -# +# # 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. -# +# # 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. -# +# """ Utilities for extracting text from generated classes. """ |