Как документировать типы параметров функции Python?

Я знаю, что параметрами могут быть любые объекты, но для документации очень важно указать, что вы ожидаете.

Во-первых, как указать типы параметров, подобные приведенным ниже?

• str (или использовать String или string ?)
• int
• list
• dict
• function ()
• tuple
• экземпляр объекта класса MyClass

Во-вторых, как указать параметры, которые могут быть нескольких типов, например, функция, которая может обрабатывать один параметр, чем может быть int или str ?

Воспользуйтесь приведенным ниже примером, чтобы продемонстрировать синтаксис, необходимый для документирования этого с вашим предлагаемым решением. Помните, что желательно иметь возможность гиперссылки на класс «Image» внутри документации.

def myMethod(self, name, image):
    """
    Does something ...

    name String: name of the image
    image Image: instance of Image Class or a string indicating the filename.

    Return True if operation succeeded or False.
    """
    return True

Обратите внимание: вы можете предложить использовать любой инструмент для документирования (сфинкс, кислород, ...), если он соответствует требованиям.

Обновление:

Похоже, что есть какая-то поддержка для документирования типов параметров в doxygen в целом. Приведенный ниже код работает, но добавляет раздражающий знак $ к имени параметра (потому что изначально он был создан для php).

    @param str $arg description
    @param str|int $arg description