asciidoxy/generator/asciidoc.py
def filter(self,
               *,
               members: Optional[FilterSpec] = None,
               inner_classes: Optional[FilterSpec] = None,
               enum_values: Optional[FilterSpec] = None,
               exceptions: Optional[FilterSpec] = None) -> str:
        """Set a default filter used when inserting API reference documentation.

        The filter controls which members of an element are inserted. Only the members matching the
        filter are inserted, the others are ignored. Depending on the exact type of element
        inserted, its members, inner classes, enum values and/or exceptions can be filtered.

        A filter specification is either a single string, a list of strings, or a dictionary.

        A single string is the same as a list of strings with just one item.

        A list of strings defines a set of regular expressions to be applied to the name. They are
        applied in the order they are specified. If the element is still included after all filters
        have been applied, it is inserted.

        Each string can have the following value:

        * `NONE`: Exclude all elements.
        * `ALL`: Include all elements.
        * `<regular expression>` or `+<regular expression`: Include elements that match the regular
          expression.
        * `-<regular expression>`: Exclude elements that match the regular expression.

        If the first string is an include regular expression, an implicit `NONE` is prepended, if
        the first string is an exclude regular expression, an implicit `ALL` is prepended.

        Some filters support filtering on other properties than the name. By default they only
        filter on the name. To filter the other properties use a dictionary, where the key is the
        name of the property, and the value is a string or list of strings with the filter.

        Args:
            members:       Filter to apply to members of a compound. Supports filtering on `name`,
                               `kind`, and `prot`ection level.
            inner_classes: Filter to apply to inner classes of a compound. Supports filtering on
                               `name` and `kind`.
            enum_values:   Filter to apply to enum values of a compound or member. Supports
                               filtering on `name` only.
            exceptions:    Filter to apply to exceptions thrown by a member. Supports filtering on
                               the `name` of the exception type only.

        Returns:
            An empty string.
        """
        self._context.insert_filter = InsertionFilter(members, inner_classes, enum_values,
                                                      exceptions)
        return ""
Set a default filter used when inserting API reference documentation.

        The filter controls which members of an element are inserted. Only the members matching the
        filter are inserted, the others are ignored. Depending on the exact type of element
        inserted, its members, inner classes, enum values and/or exceptions can be filtered.

        A filter specification is either a single string, a list of strings, or a dictionary.

        A single string is the same as a list of strings with just one item.

        A list of strings defines a set of regular expressions to be applied to the name. They are
        applied in the order they are specified. If the element is still included after all filters
        have been applied, it is inserted.

        Each string can have the following value:

        * `NONE`: Exclude all elements.
        * `ALL`: Include all elements.
        * `<regular expression>` or `+<regular expression`: Include elements that match the regular
          expression.
        * `-<regular expression>`: Exclude elements that match the regular expression.

        If the first string is an include regular expression, an implicit `NONE` is prepended, if
        the first string is an exclude regular expression, an implicit `ALL` is prepended.

        Some filters support filtering on other properties than the name. By default they only
        filter on the name. To filter the other properties use a dictionary, where the key is the
        name of the property, and the value is a string or list of strings with the filter.

        Args:
            members:       Filter to apply to members of a compound. Supports filtering on `name`,
                               `kind`, and `prot`ection level.
            inner_classes: Filter to apply to inner classes of a compound. Supports filtering on
                               `name` and `kind`.
            enum_values:   Filter to apply to enum values of a compound or member. Supports
                               filtering on `name` only.
            exceptions:    Filter to apply to exceptions thrown by a member. Supports filtering on
                               the `name` of the exception type only.

        Returns:
            An empty string.
        
Set a default filter used when inserting API reference documentation.
The filter controls which members of an element are inserted. Only the members matching the
filter are inserted, the others are ignored. Depending on the exact type of element
inserted, its members, inner classes, enum values and/or exceptions can be filtered.

A filter specification is either a single string, a list of strings, or a dictionary.

A single string is the same as a list of strings with just one item.

A list of strings defines a set of regular expressions to be applied to the name. They are
applied in the order they are specified. If the element is still included after all filters
have been applied, it is inserted.

Each string can have the following value.

`NONE`: Exclude all elements.
`ALL`: Include all elements.
`` or `+<regular expression`: Include elements that match the regular
expression.
`-`: Exclude elements that match the regular expression.

If the first string is an include regular expression, an implicit `NONE` is prepended, if
the first string is an exclude regular expression, an implicit `ALL` is prepended.

Some filters support filtering on other properties than the name. By default they only
filter on the name. To filter the other properties use a dictionary, where the key is the
name of the property, and the value is a string or list of strings with the filter.
Set a default filter used when inserting API reference documentation . The filter controls which members of an element are inserted . Only the members matching the filter are inserted the others are ignored . Depending on the exact type of element inserted its members inner classes enum values and / or exceptions can be filtered . A filter specification is either a single string a list of strings or a dictionary . A single string is the same as a list of strings with just one item . A list of strings defines a set of regular expressions to be applied to the name . They are applied in the order they are specified . If the element is still included after all filters have been applied it is inserted . Each string can have the following value . ` NONE ` : Exclude all elements . ` ALL ` : Include all elements . ` ` or ` + <regular expression ` : Include elements that match the regular expression . ` - ` : Exclude elements that match the regular expression . If the first string is an include regular expression an implicit ` NONE ` is prepended if the first string is an exclude regular expression an implicit ` ALL ` is prepended . Some filters support filtering on other properties than the name . By default they only filter on the name . To filter the other properties use a dictionary where the key is the name of the property and the value is a string or list of strings with the filter .
def filter(self,
               *,
               members: Optional[FilterSpec] = None,
               inner_classes: Optional[FilterSpec] = None,
               enum_values: Optional[FilterSpec] = None,
               exceptions: Optional[FilterSpec] = None) -> str:
        self._context.insert_filter = InsertionFilter(members, inner_classes, enum_values,
                                                      exceptions)
        return ""
def filter ( self , * , members : Optional [ FilterSpec ] = None , inner_classes : Optional [ FilterSpec ] = None , enum_values : Optional [ FilterSpec ] = None , exceptions : Optional [ FilterSpec ] = None ) -> str : self . _context . insert_filter = InsertionFilter ( members , inner_classes , enum_values , exceptions ) return ""
Set a default filter used when inserting API reference documentation.
Set a default filter used when inserting API reference documentation .
"""Set a default filter used when inserting API reference documentation.

        The filter controls which members of an element are inserted. Only the members matching the
        filter are inserted, the others are ignored. Depending on the exact type of element
        inserted, its members, inner classes, enum values and/or exceptions can be filtered.

        A filter specification is either a single string, a list of strings, or a dictionary.

        A single string is the same as a list of strings with just one item.

        A list of strings defines a set of regular expressions to be applied to the name. They are
        applied in the order they are specified. If the element is still included after all filters
        have been applied, it is inserted.

        Each string can have the following value:

        * `NONE`: Exclude all elements.
        * `ALL`: Include all elements.
        * `<regular expression>` or `+<regular expression`: Include elements that match the regular
          expression.
        * `-<regular expression>`: Exclude elements that match the regular expression.

        If the first string is an include regular expression, an implicit `NONE` is prepended, if
        the first string is an exclude regular expression, an implicit `ALL` is prepended.

        Some filters support filtering on other properties than the name. By default they only
        filter on the name. To filter the other properties use a dictionary, where the key is the
        name of the property, and the value is a string or list of strings with the filter.

        Args:
            members:       Filter to apply to members of a compound. Supports filtering on `name`,
                               `kind`, and `prot`ection level.
            inner_classes: Filter to apply to inner classes of a compound. Supports filtering on
                               `name` and `kind`.
            enum_values:   Filter to apply to enum values of a compound or member. Supports
                               filtering on `name` only.
            exceptions:    Filter to apply to exceptions thrown by a member. Supports filtering on
                               the `name` of the exception type only.

        Returns:
            An empty string.
        """
An empty string.
An empty string .
self
members
Optional[FilterSpec]
Filter to apply to members of a compound. Supports filtering on `name`,
`kind`, and `prot`ection level.
Filter to apply to members of a compound . Supports filtering on ` name ` ` kind ` and ` prot ` ection level .
inner_classes
Optional[FilterSpec]
Filter to apply to inner classes of a compound. Supports filtering on
`name` and `kind`.
Filter to apply to inner classes of a compound . Supports filtering on ` name ` and ` kind ` .
enum_values
Optional[FilterSpec]
Filter to apply to enum values of a compound or member. Supports
filtering on `name` only.
Filter to apply to enum values of a compound or member . Supports filtering on ` name ` only .
exceptions
Optional[FilterSpec]
Filter to apply to exceptions thrown by a member. Supports filtering on
the `name` of the exception type only.
Filter to apply to exceptions thrown by a member . Supports filtering on the ` name ` of the exception type only .