Doxygen пропущенные записи (в зависимости от заказа) - PullRequest
0 голосов
/ 06 ноября 2018

Хотите создать html-документацию из документированного c-заголовка. Но у меня странная проблема с doxygen:
Некоторые записи (перечисления, структуры, ..) пропущены в html. Если я переупорядочу одну из пропущенных записей (поместите их в список двух других, которые уже отображаются, чем это будет показано тоже?!? Есть ли правило для порядка записей? Если да, могу ли я отключить это правило?

Используйте 1.8.11 в Linux и последний (1.8.14) в Windows. Например, у меня есть несколько структур a, b, c, d, и struct d struct является частью c.
В "C" мне нужно написать d перед c, в противном случае я получаю ошибку компилятора. Но Doxygen - по какой-то странной причине перечисляет c, только если он расположен перед d. Так что либо я могу скомпилировать, либо иметь полную документацию.

Ответы [ 2 ]

0 голосов
/ 07 ноября 2018

Заголовочный файл был довольно большим - чтобы его можно было разместить здесь - поэтому я попытался уменьшить его и нашел проблему. Структура, которая не будет отображаться, имеет в своем заголовке doxygen оператор @code blabla, но ей нужен @endcode (который был пропущен). Извините за эту ложную тревогу. Спасибо Альберту за эту помощь. Задавать правильные вопросы тоже помогает!

0 голосов
/ 06 ноября 2018

Я создал небольшой пример, и в этом примере я вижу все элементы:

/** \file */

/** docu structure a */
struct a
{
  /** docu member a */
  int mem_a;
};

/** docu structure b */
struct b
{
  /** docu member b */
  int mem_b;
};

/** docu structure d */
struct d
{
  /** docu member d */
  int mem_d;
};

/** docu structure c */
struct c
{
  /** docu member c */
  int mem_c;
  /** docu structure inside c */
  struct d str_d;
};

Я использовал Doxyfile по умолчанию (doxygen -g).

...