tokenize_arg

sphinx_doxysummary.utils.tokenize_arg(argument: str) → List[Set[str]]

Split a C++ argument into its components.

Parameters:

argument (str) – One argument of the function.

Returns:

List of set of tokens from the argument.

Return type:

List[Set[str]]

Examples

>>> tokenize_arg('int argc')  # type + var-name
[{'argc', 'int'}]
>>> tokenize_arg('const char *a')  # with specifier
[{'char'}, {'*'}, {'a'}]
>>> tokenize_arg('char&& a')  # reference to r-value
[{'char'}, {'&'}, {'&'}, {'a'}]
>>> tokenize_arg('const std::vector< double *, int > & x_')  # template
[{'const', 'std::vector<double *, int>'}, {'&'}, {'x_'}]