Doxygen: ссылка на члена класса C ++ со страницы без написания имени класса - PullRequest
0 голосов
/ 13 февраля 2019

Допустим, у меня есть класс Foo с функцией-членом bar(), документированный с помощью Doxygen:

foo.h:

/// This is the Foo class.
class Foo
{
  /// Does something.
  void bar();
};

истраница в отдельном файле, на которую я хочу сослаться bar() (записано в Markdown):

notes.md:

To do something, call bar().

Я хочу "панель () "на сгенерированной странице для ссылки на документацию по функции bar().Я могу сделать это, написав Foo::bar() вместо этого, но я не хочу, чтобы это отображалось как "Foo :: bar ()" на странице.Какой хороший способ сделать это?

1 Ответ

0 голосов
/ 13 февраля 2019

Лучшее решение, которое я нашел на данный момент, это использовать \ref в notes.md:

To do something, call \ref Foo::bar() "bar()".

На мой взгляд, это все еще немного грязно, хотя,Он также не показывает краткое описание функции при наведении мыши, в отличие от автоматически сгенерированных ссылок.

...