23 lines
1.2 KiB
Text
23 lines
1.2 KiB
Text
////////////////////////////////////////////////////////////////////////////////
|
|
// (c) Copyright, Ubisoft Entertainment Inc. || Created by Harbour //
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
The "doc" folder contains the doxygen files for the project (chm).
|
|
|
|
Command line to generate the documentation (assuming doxygen is installed on the system):
|
|
> doxygen doxyfile
|
|
> doxygen doxyfile > output.txt 2>errors.txt
|
|
|
|
Friendly reminder:
|
|
If the chm file is opened while launching the command, doxygen fails to update the file.
|
|
|
|
Important Note:
|
|
The doxyfile configuration must explicitly specify the ubiservices/core/config.h header FIRST
|
|
as INPUT to work around a doxygen bug/limitation where the macro definitions are not handled
|
|
properly until the file that defines them be preprocessed" & parsed properly.
|
|
|
|
INPUT = ../public/ubiservices/core/configs/config.h \
|
|
|
|
By default, doxygen processes the files based on full path alphabetic order. In the case
|
|
of the UbiServices project, the project namespace compiler macros are defined in config.h
|
|
Doxygen ignores all the macro instructions it encounters BEFORE processing the definition
|
|
no matter of the #include instructions in the header files.
|