Это мой файл lexer.hpp:
/ ** * \файл * \ краткий лексический анализ * \ автор Игорь Защелкин * * Лексический анализ API для MyLisp. * / #ifndef LEXER_H #define LEXER_H #включают <строка> #включают <вектор> / ** * \rief Используется для связывания токена (Token) с его типом. * дата 29 июня 2018 г. * * TokenNumber - 12, 5,4, -200 * TokenString - "Привет, мир" * TokenBoolean - правда, ложь * TokenIdentifier - имя функции, имя переменной * TokenSeparator - (), * / enum TokenType { TokenNumber /// \rief Токены, в которых хранятся числовые данные , TokenString /// \ краткий токены, в которых хранятся символические данные, которые заканчиваются и начинаются в ", TokenBoolean /// \ краткий токены, в которых хранится только одно состояние 1 или 0 , TokenIdentifier /// \rief Токены, которые ссылаются на что-то (переменная, функция) , TokenSeparator /// \rief Токены, которые разбивают логические части кода }; / ** * \ краткое значение типа токена * дата 29 июня 2018 г. * * Просто, обернуть std :: string * / typedef std :: string TokenValue; / ** * \ краткая минимальная часть лексического анализа * дата 29 июня 2018 г. * * Структурированная пара TokenType и TokenValue (он же std :: string) * / class Token { частный: тип const TokenType; /// \ краткий тип токена значение const TokenValue; /// \ краткое значение токена общественности: Token (тип TokenType, значение std :: string); /// \ краткий конструктор const TokenType getType (); /// / краткое получение для свойства типа const TokenValue getValue (); /// \rief Getter для свойства value }; / ** * \ краткий экземпляр API лексического анализа * дата 29 июня 2018 г. * / class Lexer { частный: std :: string code; /// \rief Исходный код общественности: Lexer (std :: string code); /// \ краткий конструктор / ** * \ краткий токенизированный исходный код * дата 29 июня 2018 г. * * Генерация последовательности токенов (std :: vector) из свойства кода (std :: string) * / std :: vector tokenize (); }; #endif // LEXER_H
Все в порядке (это мой разум), но когда я бегу
doxygen src / lexer / lexer.hpp
Doxygen генерирует пустую документацию.
В чем дело?
У вас должен быть файл конфигурации doxygen (Doxyfile), версия по умолчанию может быть сгенерирована с помощью doxygen -g
, В Doxyfile вы можете установить необходимые параметры. Затем вы можете начать doxygen только с doxygen
из doxygen Doxyfile
,
Даже с установкой, используемой OP, я получаю документацию (и множество предупреждающих сообщений, таких как: «warning: игнорирование неизвестного тега` file ‘в строке 2, file lexer.hpp «, указывающего, что что-то не так).
Смотрите также документацию по Doxygen.
Других решений пока нет …