filter_symbolmap#

documenteer.ext.autocppapi.filter_symbolmap(symbol_map, kinds=None, match=None)#

Filter the entries in a symbol map to only those that match a certain API type or name regular expression.

Parameters:

  • symbol_map (doxylink.SymbolMap) – The Doxylink SymbolMap.

  • kinds (set of str, optional) –

    The kinds of APIs to filter for. The class-like APIs are:

    • class

    • struct

    • union

    • interface

  • match (str) – A string that can be compiled into a regular expression. This regular expression matches APIs

Returns:

names – The names of APIs that match the criteria.

Return type:

list of str