Message: Re: Creating a local copy of doxygen documentation Not Logged In (login)
 Next-in-Thread Next-in-Thread
 Next-in-Forum Next-in-Forum

Ok Re: Creating a local copy of doxygen documentation 

Forum: Documentation and Examples
Re: Question Creating a local copy of doxygen documentation
Date: 27 Sep, 2016
From: <php1ic>

I had misunderstood about doxygen, creating a local copy of the webpage was not as complicated as I thought.

For anyone that has this 'issue' in the future here is how I built the html documentation:

- From the source directory create a default config file

[geant4.10.02.p02/source]$ doxygen -g default.cfg

- Make the required changes. There are *many* options, but the following changes worked for me to create a basic webpage

35c35
< PROJECT_NAME           = "My Project"
---
> PROJECT_NAME           = "Geant4 v10.2.2"
61c61
< OUTPUT_DIRECTORY       =
---
> OUTPUT_DIRECTORY       = ../documents
71c71
< CREATE_SUBDIRS         = NO
---
> CREATE_SUBDIRS         = YES
180c180
< JAVADOC_AUTOBRIEF      = NO
---
> JAVADOC_AUTOBRIEF      = YES
245c245
< OPTIMIZE_OUTPUT_FOR_C  = NO
---
> OPTIMIZE_OUTPUT_FOR_C  = YES
312c312
< BUILTIN_STL_SUPPORT    = NO
---
> BUILTIN_STL_SUPPORT    = YES
398c398
< LOOKUP_CACHE_SIZE      = 0
---
> LOOKUP_CACHE_SIZE      = 2
412c412
< EXTRACT_ALL            = NO
---
> EXTRACT_ALL            = YES
782c782
< RECURSIVE              = NO
---
> RECURSIVE              = YES
924c924
< REFERENCED_BY_RELATION = NO
---
> REFERENCED_BY_RELATION = YES
1575c1575
< GENERATE_LATEX         = YES
---
> GENERATE_LATEX         = NO
2059c2059
< CLASS_DIAGRAMS         = YES
---
> CLASS_DIAGRAMS         = NO
2090c2090
< HAVE_DOT               = YES
---
> HAVE_DOT               = NO


- Still in the source directory, run doxygen passing your config file as an argument. There is lots of output so probably best to redirect it into a file. I was happy for errors to be printed to screen.

[geant4.10.02.p02/source]$ doxygen my_config.cfg > doxygen.out

- In the directory specified, there should now be an index.html which you can point your browser to

[geant4.10.02.p02]$ ls documents/html/index.html 
documents/html/index.html

 Add Message Add Message
to: "Re: Creating a local copy of doxygen documentation"

 Subscribe Subscribe

This site runs SLAC HyperNews version 1.11-slac-98, derived from the original HyperNews


[ Geant 4 Home | Geant 4 HyperNews | Search | Request New Forum | Feedback ]