Skip to content
Snippets Groups Projects
Commit cba05800 authored by Wuttke, Joachim's avatar Wuttke, Joachim
Browse files

Update Doc/Doxygen/README

parent 9ef1c8aa
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 4 additions and 4 deletions
Doc/Doxygen/README.md
+ 4
− 4
View file @ cba05800
...@@ -2,7 +2,6 @@ We support different flavors of Doxygen documentation: ...@@ -2,7 +2,6 @@ We support different flavors of Doxygen documentation:
- "user", the BornAgain user API - "user", the BornAgain user API
- "long", full C++ source documentation for developers - "long", full C++ source documentation for developers
- "dirgraphs", for analysing include dependences
To build the documentation, To build the documentation,
``` ```
...@@ -10,12 +9,13 @@ cd build ...@@ -10,12 +9,13 @@ cd build
# configure: # configure:
cmake -DBORNAGAIN_CONFIGURE_DOXY=ON .. cmake -DBORNAGAIN_CONFIGURE_DOXY=ON ..
# make: # make:
make doxyuser # other make targets are 'doxylong' etc, make doxyuser
# or 'doxy' to build all available flavors make doxylong
make doxy # to build both flavors
``` ```
The configure step writes Doxyfiles to the directory The configure step writes Doxyfiles to the directory
`<build>/doxygen`. Do not edit these files. `<build>/doxygen`. Do not edit these files.
The make step writes the documentation to directories The make step writes the documentation to directories
`<build>/html/user` etc. `<build>/html/user`, `<build>/html/long`.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment