[pygccxml-commit] source/pyplusplus/experimental filters.py,1.1,1.2

[Matthias B. <mb...@us...>]

Update of /cvsroot/pygccxml/source/pyplusplus/experimental
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12673

Modified Files:
	filters.py 
Log Message:
Doc string updates

Index: filters.py
===================================================================
RCS file: /cvsroot/pygccxml/source/pyplusplus/experimental/filters.py,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** filters.py	14 Mar 2006 10:25:12 -0000	1.1
--- filters.py	14 Mar 2006 18:08:57 -0000	1.2
***************
*** 54,59 ****
              # It was only a successful match when the entire string was matched
              return m.end()==len(txt)
! 
! 
  
  # FilterBase
--- 54,58 ----
              # It was only a successful match when the entire string was matched
              return m.end()==len(txt)
!         
  
  # FilterBase
***************
*** 81,86 ****
      def parentConstraints(self):
          """Return the parent constraints.
          
!         @returns: Tuple (parent, recursive)
          """
          return None
--- 80,101 ----
      def parentConstraints(self):
          """Return the parent constraints.
+ 
+         A filter can use this method to indicate that it will always
+         return False if the parent is not a particular node.
          
!         The following return values are possible:
! 
!           - C{None}: There are no constraints. The filter may return True on any node.
!           - C{[]}: The filter will always return False.
!           - C{[(parent, recursive),...]}: The parent constraints.
! 
!         A single parent constraint (I{parent}, I{recursive}) means that the
!         filter may only return True on children of I{parent}. If I{recursive}
!         is set to True these can also be grand-children, otherwise they
!         are only the direct children. On all other nodes, the filter will
!         always return False so the search algorithm may decide not to visit
!         them at all to speed up the search.
!         
!         @returns: None, an empty list or a list of tuples (parent, recursive).
          """
          return None