создание поддокументов с doxygen

Question

У меня есть большое программное обеспечение на C++, зарегистрированное с помощью doxygen. Как я могу настроить его так, чтобы я мог создавать поддокументы для определенных классов? Классы документируются с комментариями в источнике, их .Dox-файлы и images/directory. Мне нужно создать отдельный PDF-файл, относящийся к одному классу.

Я могу использовать группировку для определения того, что будет включено в этот поддокумент, но как я могу генерировать вывод для одной группы?

Answer 1

Если у вас есть определенный .dox-файл на каждый запрашиваемый выходной объект, то все, что вам нужно сделать, это определить в этом файле как входные файлы, объявляющие и определяющие этот класс.

Скажем, например, вы хотите, выход только для класса MyClass который объявлен в файле myclass.hpp и реализация которых в myclass.cpp, то в myclass.dox, просто добавьте это:

INPUT = ./myclass.cpp \ 
    ./myclass.hpp 

Конечно, вы можете иметь разные пути для .cpp и .hpp. Или вы можете документировать несколько классов.

Затем запустите doxygen на этом myclass.dox файл.

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

HTML_OUTPUT = html_myclass