From: Brian Gerkey <brian@ge...> - 2006-05-17 16:51:56
On May 15, 2006, at 11:46 AM, Jordi wrote:
> If I execute make docs in the doc/ subdirectory I get the doxygen
> documentation of the source code.
> But how can I transform the .txt files of the documentation
> directory to html
A 'make doc' in the doc directory will process all the Player code
and the .txt files into a set of html files in the 'player-docs'
subdirectory. For example, architecture.txt becomes player-docs/
architecture.html. But there is not necessarily a one-to-one mapping
between .txt and .html files. A single .txt file may create multiple
Doxygen @page's or @group's, which will in turn produce
multiple .html files.
Each file to be processed is declared explicitly in the player.dox
file. So if you're trying to add new .txt files, you need to add
them to the INPUT variable in that file.