summaryrefslogtreecommitdiff
path: root/visitor.py
diff options
context:
space:
mode:
authorNicolas Chauvat <nicolas.chauvat@logilab.fr>2008-07-13 21:32:22 +0200
committerNicolas Chauvat <nicolas.chauvat@logilab.fr>2008-07-13 21:32:22 +0200
commitaab929e273a41a188a244b5d2c8b3e53408172ab (patch)
treebdbb169569082a3290de6dbdaf7ef7d68bc919c1 /visitor.py
parent47df8cd6dff5c08b32966a7b59b5da75d23123de (diff)
downloadlogilab-common-aab929e273a41a188a244b5d2c8b3e53408172ab.tar.gz
improve doc for better epydoc generation.
Diffstat (limited to 'visitor.py')
-rw-r--r--visitor.py28
1 files changed, 6 insertions, 22 deletions
diff --git a/visitor.py b/visitor.py
index ca70b9f..10ae8c3 100644
--- a/visitor.py
+++ b/visitor.py
@@ -1,25 +1,14 @@
-# This program 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 2 of the License, or (at your option) any later
-# version.
-#
-# This program 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
-# this program; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-""" Copyright (c) 2002-2003 LOGILAB S.A. (Paris, FRANCE).
- http://www.logilab.fr/ -- mailto:contact@logilab.fr
-
-a generic visitor abstract implementation
+"""A generic visitor abstract implementation.
+
+:copyright: 2002-2008 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
+:license: General Public License version 2 - http://www.gnu.org/licenses
"""
+__docformat__ = "restructuredtext en"
def no_filter(_):
return 1
-
# Iterators ###################################################################
class FilteredIterator(object):
@@ -35,7 +24,6 @@ class FilteredIterator(object):
except :
return None
-
# Base Visitor ################################################################
class Visitor(object):
@@ -77,8 +65,6 @@ class Visitor(object):
"""
return result
-
-
# standard visited mixin ######################################################
class VisitedMixIn(object):
"""
@@ -102,5 +88,3 @@ class VisitedMixIn(object):
def leave(self, visitor, *args, **kwargs):
func = getattr(visitor, 'leave_%s' % self.get_visit_name())
return func(self, *args, **kwargs)
-
-