diff --git a/Doc/Doxygen/README.md b/Doc/Doxygen/README.md index 33122b51814f5556a545e5eb2b8f528770c397f8..eb04b640117411534dd7508253f4d816282a9232 100644 --- a/Doc/Doxygen/README.md +++ b/Doc/Doxygen/README.md @@ -2,7 +2,6 @@ We support different flavors of Doxygen documentation: - "user", the BornAgain user API - "long", full C++ source documentation for developers -- "dirgraphs", for analysing include dependences To build the documentation, ``` @@ -10,12 +9,13 @@ cd build # configure: cmake -DBORNAGAIN_CONFIGURE_DOXY=ON .. # make: -make doxyuser # other make targets are 'doxylong' etc, - # or 'doxy' to build all available flavors +make doxyuser +make doxylong +make doxy # to build both flavors ``` The configure step writes Doxyfiles to the directory `<build>/doxygen`. Do not edit these files. The make step writes the documentation to directories -`<build>/html/user` etc. +`<build>/html/user`, `<build>/html/long`.