split_name

sphinx_doxysummary.utils.split_name(name: str) → List[str]

Split any item declaration into a list of return type, item name and arguments.

Parameters:

name (str) – Declarartion of the item.

Returns:

List of return type - item name - arguments

Return type:

List[str]

Examples

>>> split_name('spam::Shrub')
['', 'spam::Shrub', '']
>>> split_name('void hello::hello_world(int a, const std::vector<int> & b)')
['void', 'hello::hello_world', '(int a, const std::vector<int> & b)']
>>> split_name('int * get(int * array)')
['int *', 'get', '(int * array)']
>>> split_name('spam::Spam operator * (spam::Spam & x, spam::Spam & y)')
['spam::Spam', 'operator *', '(spam::Spam & x, spam::Spam & y)']
>>> split_name('void* spam::Spam::operator ->* ()')
['void *', 'spam::Spam::operator ->*', '()']