Документирование математических формул в виде комментариев в python коде с использованием Doxygen

Question

мой вопрос является расширением этого , и я хочу, чтобы Doxygen вывел математические формулы и текст, которые находятся в той же строке комментария моего python исходного кода. Давайте возьмем следующий пример:

# Create homogeneous probability matrix from the colors matrix
def create_probability_map(colors_map):
    """!\f$(x_1,y_1)\f$"""
    pass

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

# Create homogeneous probability matrix from the colors matrix
def create_probability_map(colors_map):
    """Formula is: !\f$(x_1,y_1)\f$"""
    pass

Вывод будет не таким, как ожидалось. Кто-нибудь знает, как это исправить?

Пробуя другие несколько комбинаций, я обнаружил, что Doxygen выводит правильный комментарий если текст следует за математической формулой, как показано ниже:

# Create homogeneous probability matrix from the colors matrix
def create_probability_map(colors_map):
    """!\f$(x_1,y_1)\f$ is the formula"""
    pass

PS: мне также показалось странным, что предположительно Doxygen не может обрабатывать математические формулы на Python, как указано в документации (в частности, здесь ). Документация устарела?

Answer 1

Я попробовал с doxygen 1.8.18 следующий код:

## \file

# Create homogeneous probability matrix from the colors matrix
def create_probability_map1(colors_map):
    """!\f$(x_1,y_1)\f$"""
    pass

# Create homogeneous probability matrix from the colors matrix
def create_probability_map2(colors_map):
    """Formula is: !\f$(x_2,y_2)\f$"""
    pass

# Create homogeneous probability matrix from the colors matrix
def create_probability_map3(colors_map):
    """!\f$(x_3,y_3)\f$ is the formula"""
    pass

# Create homogeneous probability matrix from the colors matrix
def create_probability_map4(colors_map):
    """!Formula is: \f$(x_4,y_4)\f$ is the formula"""
    pass

со стандартными настройками конфигурации doxygen, это приводит к:

Мне кажется, все в порядке, строки do c с """! рассматриваются как комментарии doxygen, а с """ отображаются как дословно / код (как также показано в упомянутой ссылке в вопросе).