Doxygen не распознает комментарии (Doxywizard)
Я уверен, что это что-то глупое, что я сделал, но я не вижу, что это такое:
Итак, у меня есть проект c ++, в котором есть файл main.cpp и несколько классов. Он не был написан с учетом doxygen (ошибка № 1), но я пытаюсь исправить свою ошибку и сгенерировать некоторую документацию. Поэтому я установил doxygen и запустил графический интерфейс doxygen, ввел имя проекта / краткий обзор и указал местоположение источника и места назначения.
Также, чтобы получить некоторые выходные данные над функцией, я добавил комментарий в стиле, который требует спецификация doxygen:
//! My actual function doesn't really look like this
/*!
* Some sample detail which isn't exactly the same as the main
* function but the structure is the same
*/
void sampleFunction()
{
doSomethingUninteresting();
}
Однако, когда я нажимаю run в doxywizard, дополнительные комментарии не делаются.
Если я установлю режим извлечения для задокументированных объектов, то только main.cpp даже не появится. Если я установлю его для всех сущностей, main.cpp появится в файлах, и функция там, но в файле нет никаких подробностей.
Как абсолютный новичок, пытающийся дооснастить свой проект, без сомнения, я упустил что-то важное, но во всех прочитанных мной документациях / уроках не предлагается ничего, кроме того, что, как я сказал, должно быть сделано, поэтому я перехожу к знающее SO сообщество для помощи
ОБНОВИТЬ:
В ответ на комментарий Арне Мерца вот еще несколько деталей:
-
Doxywizard находится в Program Files / doxygen / bin, а файл конфигурации находится там, где doxywizard создает его по умолчанию
-
Мой исходный код находится в User / Desktop /
-
Выходная папка находится в User / Desktop / Documentation
Решение
Я был глуп, как я подозревал, чтобы быть в безопасности, я сделал копию своего проекта, и поэтому версия, которую я редактировал, не была версией, интерпретируемой doxygen
Я приношу извинения всем, кто потратил свое время, пытаясь помочь с этим, но я очень ценю ваши попытки сделать это 🙂
Другие решения
Для документирования глобальных функций вы также должны включить имя файла. Например.
/*!
* \file MyFileName.cpp
* \brief a brief description of a file
*/
//! My actual function doesn't really look like this
/*!
* Some sample detail which isn't exactly the same as the main
* function but the structure is the same
*/
void sampleFunction()
{
doSomethingUninteresting();
}
Обратите внимание, что имя после \file Ключевое слово должно быть в точности как имя файла.