diff options
author | Tom Rondeau <tom@trondeau.com> | 2014-07-07 12:18:00 -0400 |
---|---|---|
committer | Tom Rondeau <tom@trondeau.com> | 2014-07-07 12:18:00 -0400 |
commit | 597b93798a804cde1783d6d2ab53b348d57c44cd (patch) | |
tree | b65e73bb0de634ff5d209b15971ebdabf369a45c /docs/doxygen | |
parent | 1151e5502ccd440ebd89599cf7e4be4fb5ed8334 (diff) |
Removing trailing/extra whitespaces before release.
We should be more careful about letting these into the code in the future. In emacs, we can use (add-hook 'before-save-hook 'delete-trailing-whitespace).
Diffstat (limited to 'docs/doxygen')
-rw-r--r-- | docs/doxygen/doxyxml/doxyindex.py | 40 | ||||
-rw-r--r-- | docs/doxygen/other/logger.dox | 4 | ||||
-rw-r--r-- | docs/doxygen/other/msg_passing.dox | 4 | ||||
-rw-r--r-- | docs/doxygen/other/thread_affinity.dox | 2 | ||||
-rw-r--r-- | docs/doxygen/swig_doc.py | 24 |
5 files changed, 37 insertions, 37 deletions
diff --git a/docs/doxygen/doxyxml/doxyindex.py b/docs/doxygen/doxyxml/doxyindex.py index 69c6de07f5..e039737714 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 and namespaces we want the contents to be @@ -81,7 +81,7 @@ 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 def set_parameters(self, data): vs = [ddc.value for ddc in data.detaileddescription.content_] @@ -133,7 +133,7 @@ Base.mem_classes.append(DoxyFunction) class DoxyParam(DoxyMember): - + __module__ = "gnuradio.utils.doxyxml" def _parse(self): @@ -178,11 +178,11 @@ class DoxyParameterItem(DoxyMember): class DoxyClass(DoxyCompound): - + __module__ = "gnuradio.utils.doxyxml" kind = 'class' - + def _parse(self): if self._parsed: return @@ -201,14 +201,14 @@ class DoxyClass(DoxyCompound): params = property(lambda self: self.data()['params']) Base.mem_classes.append(DoxyClass) - + class DoxyFile(DoxyCompound): - + __module__ = "gnuradio.utils.doxyxml" kind = 'file' - + def _parse(self): if self._parsed: return @@ -218,7 +218,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']) @@ -226,7 +226,7 @@ Base.mem_classes.append(DoxyFile) class DoxyNamespace(DoxyCompound): - + __module__ = "gnuradio.utils.doxyxml" kind = 'namespace' @@ -240,12 +240,12 @@ class DoxyNamespace(DoxyCompound): if self._error: return self.process_memberdefs() - + Base.mem_classes.append(DoxyNamespace) class DoxyGroup(DoxyCompound): - + __module__ = "gnuradio.utils.doxyxml" kind = 'group' @@ -273,7 +273,7 @@ class DoxyGroup(DoxyCompound): self.process_memberdefs() title = property(lambda self: self.data()['title']) - + Base.mem_classes.append(DoxyGroup) @@ -288,7 +288,7 @@ Base.mem_classes.append(DoxyFriend) class DoxyOther(Base): - + __module__ = "gnuradio.utils.doxyxml" kinds = set(['variable', 'struct', 'union', 'define', 'typedef', 'enum', @@ -297,6 +297,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/other/logger.dox b/docs/doxygen/other/logger.dox index 7b0f64e12b..f057e59d9b 100644 --- a/docs/doxygen/other/logger.dox +++ b/docs/doxygen/other/logger.dox @@ -205,7 +205,7 @@ input to our logging macros like 'GR_LOG_INFO(LOG, "message")'. \section logPy Logging from Python -The logging capability has been brought out python via swig. The configuration +The logging capability has been brought out python via swig. The configuration of the logger can be manipulated via the following calls: \code from gnuradio import gr @@ -214,7 +214,7 @@ of the logger can be manipulated via the following calls: gr.logger_reset_config() # Resets logger config by removing all appenders \endcode -Once the logger is configured you can manipulate a logger via a wrapper class gr.logger(). +Once the logger is configured you can manipulate a logger via a wrapper class gr.logger(). You can isntantiate this by the following. (Reference logger.h for list of methods) \code from gnuradio import gr diff --git a/docs/doxygen/other/msg_passing.dox b/docs/doxygen/other/msg_passing.dox index c184681f23..11abf35728 100644 --- a/docs/doxygen/other/msg_passing.dox +++ b/docs/doxygen/other/msg_passing.dox @@ -76,7 +76,7 @@ the messages that are posted to it. After using the gr::basic_block::message_port_register_in to declare a subscriber port, we must then bind this port to the message handler. For this, we use Boost's 'bind' function: - + \code set_msg_handler(pmt::pmt_t port_id, boost::bind(&block_class::message_handler_function, this, _1)); @@ -114,7 +114,7 @@ All messages published by the \b src block on port \a pdus will be received by \b dbg on port \a print. Note here how we are just using strings to define the ports, not PMT symbols. This is a convenience to the user to be able to more easily type in the port names (for -reference, you can create a PMT symbol in Python using the +reference, you can create a PMT symbol in Python using the pmt::intern function as pmt.intern("string")). Users can also query blocks for the names of their input and output diff --git a/docs/doxygen/other/thread_affinity.dox b/docs/doxygen/other/thread_affinity.dox index bccdd56573..edac813866 100644 --- a/docs/doxygen/other/thread_affinity.dox +++ b/docs/doxygen/other/thread_affinity.dox @@ -57,7 +57,7 @@ Where \p mask is a vector of core numbers to set the thread's affinity to. The current core affinity can be retrieved using the member function: - + - gr::block::processor_affinity() When set before the flowgraph is started, the scheduler will set the diff --git a/docs/doxygen/swig_doc.py b/docs/doxygen/swig_doc.py index da104a2e00..c9e89aec1b 100644 --- a/docs/doxygen/swig_doc.py +++ b/docs/doxygen/swig_doc.py @@ -1,23 +1,23 @@ # # Copyright 2010-2012 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. -# +# """ Creates the swig_doc.i SWIG interface file. Execute using: python swig_doc.py xml_path outputfilename @@ -65,7 +65,7 @@ class Block2(object): Checks if doxyxml produced objects correspond to a new style gnuradio block. """ - + @classmethod def includes(cls, item): if not isinstance(item, DoxyClass): @@ -75,7 +75,7 @@ class Block2(object): return False is_a_block2 = item.has_member('make', DoxyFunction) and item.has_member('sptr', DoxyOther) return is_a_block2 - + def utoascii(text): """ @@ -100,7 +100,7 @@ def combine_descriptions(obj): if dd: description.append(dd) return utoascii('\n\n'.join(description)).strip() - + def format_params(parameteritems): output = ['Args:'] template = ' {0} : {1}' @@ -112,7 +112,7 @@ entry_templ = '%feature("docstring") {name} "{docstring}"' def make_entry(obj, name=None, templ="{description}", description=None, params=[]): """ Create a docstring entry for a swig interface file. - + obj - a doxyxml object from which documentation will be extracted. name - the name of the C object (defaults to obj.name()) templ - an optional template for the docstring containing only one @@ -235,11 +235,11 @@ def make_block2_entry(di, block): return "\n\n".join(output) def make_swig_interface_file(di, swigdocfilename, custom_output=None): - + output = [""" /* * This file was automatically generated using swig_doc.py. - * + * * Any changes to it will be lost next time it is regenerated. */ """] @@ -277,7 +277,7 @@ def make_swig_interface_file(di, swigdocfilename, custom_output=None): # Create docstrings for functions # Don't include the make functions since they have already been dealt with. - funcs = [f for f in di.in_category(DoxyFunction) + funcs = [f for f in di.in_category(DoxyFunction) if f.name() not in make_funcs and not f.name().startswith('std::')] for f in funcs: try: |