Re: [CMake] Any recent guides to adding support for doxygen

2009-10-14 Thread Hendrik Sattler

Zitat von John Drescher :


I want to add doxygen support to my projects but my google searches
are not finding good recent information on how to do this. Or has
nothing changed in the last 3 years?


Create a normal configuration file for doxygen replace some of it by  
variables and use configure_file().

Some that are good candidates:
PROJECT_NUMBER
  You may want to keep version numbers in one place (in CmakeLists.txt)

OUTPUT_DIRECTORY
INPUT
  As those may change when doing out-of-source builds, this is rather  
mandatory.


GENERATE_*
  You can generate more that one Doxyfile from a Doxyfile.in, each used to
  generate another output format. Connect that to custom commands and targets.

Most of the other stuff is probably static enough to leave them fixed  
in the template .in file.


HS


___
Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://www.cmake.org/mailman/listinfo/cmake


Re: [CMake] Any recent guides to adding support for doxygen

2009-10-14 Thread Ben Boeckel
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA256

John Drescher wrote:

> I want to add doxygen support to my projects but my google 
searches
> are not finding good recent information on how to do this. Or 
has
> nothing changed in the last 3 years?
> 

I have Doxygen files that I use. Features:

- - Two-pass so .tag files are picked up
- - Creates its own directories
- - Dumps verbosity to a file instead of the console

Relevant files attached. It uses sed and I can't remember why I 
used it instead of configure_file.

- --Ben
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.10 (GNU/Linux)

iQIcBAEBCAAGBQJK1fNUAAoJEKaxavVX4C1XwxkQAJO84qXncCjTRd7509ADAa01
SlA/OS5zLG6IgEbnGS3jmrhJ9Pw4Z4cTFTn1y2nwzPCHLH4ODZmdw6yIm6owV/A5
UXh1oSYetbXukqeMlEdkJfNH0QFkqgwFpoARVxjL+xCvJwd55wOsiIIJmJIDYXd6
xDVZxQK0B7Kud4dmHCORhN8fWoyf1lo4uJ+gijUtiIHFmhQWBOJLafYTRQXkKRI8
xG2MIfSIJ3AoDHXghQz5bCI432RPI24E8kQd7ieGkY3rzyID8zGZO8sIEu2qgGMm
951wEhlhF1eCBCpXmBNy21AlGyW5ppJTBJIPbl7OwxqgooQfikAy5NA2yPfACRbP
8Y4sT5/xjqSjuL/tfu7K3QmeqTxI6oUMl5MXM+V7qi/P1BUMa9g+H0u0tfi2Uew1
YcA0iXJfnj1nnaBy3rPSlyheyEoBJC8Fj4vYOE+yOQKRC2eLdgcTIpj0EUOjiGnb
W+W+MPHrrFMNTminPl0E0cBAVo2tgELh+5DbNg2DobmUrL+g8+RIyzbXR1QDFouT
GXx56Kp7yStJ6hMzB6bzVqahGXaNhsKcuSXiFELEz2qpHMNUbtfPpjIGUNYEAQxq
ybWyc1eob6bT2RDQoGtE8G5Xjvc2hdRbEZP2RPsHsGem9Bk/2XPeti+igaRqaVsm
yFULmWBamfkCJ2TDE8Ag
=GbKW
-END PGP SIGNATURE-
# Doxyfile 1.5.7.1-KDevelop

#---
# Project related configuration options
#---
DOXYFILE_ENCODING  = UTF-8
PROJECT_NAME   = _PROJECT_NAME
PROJECT_NUMBER = 1
OUTPUT_DIRECTORY   = DOCUMENTATION_OUTPUT_PATH/_PROJECT_NAME
CREATE_SUBDIRS = YES
OUTPUT_LANGUAGE= English
BRIEF_MEMBER_DESC  = YES
REPEAT_BRIEF   = YES
ABBREVIATE_BRIEF   = "The $name class" \
 "The $name widget" \
 "The $name file" \
 is \
 provides \
 specifies \
 contains \
 represents \
 a \
 an \
 the
ALWAYS_DETAILED_SEC= NO
INLINE_INHERITED_MEMB  = NO
FULL_PATH_NAMES= YES
STRIP_FROM_PATH= PROJECT_SOURCE_DIR
STRIP_FROM_INC_PATH= 
SHORT_NAMES= NO
JAVADOC_AUTOBRIEF  = NO
QT_AUTOBRIEF   = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS   = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE   = 4
ALIASES= 
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO
BUILTIN_STL_SUPPORT= NO
CPP_CLI_SUPPORT= NO
SIP_SUPPORT= NO
IDL_PROPERTY_SUPPORT   = YES
DISTRIBUTE_GROUP_DOC   = NO
SUBGROUPING= YES
TYPEDEF_HIDES_STRUCT   = NO
SYMBOL_CACHE_SIZE  = 0
#---
# Build related configuration options
#---
EXTRACT_ALL= NO
EXTRACT_PRIVATE= NO
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = YES
EXTRACT_ANON_NSPACES   = NO
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS  = NO
INTERNAL_DOCS  = NO
CASE_SENSE_NAMES   = YES
HIDE_SCOPE_NAMES   = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO= YES
SORT_MEMBER_DOCS   = YES
SORT_BRIEF_DOCS= YES
SORT_GROUP_NAMES   = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST  = YES
GENERATE_TESTLIST  = YES
GENERATE_BUGLIST   = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS   = 
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES= YES
SHOW_DIRECTORIES   = YES
SHOW_FILES = YES
SHOW_NAMESPACES= YES
FILE_VERSION_FILTER= 
LAYOUT_FILE= 
#---
# configuration options related to warning and progress messages
#---
QUIET  = YES
WARNINGS   = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR  = YES
WARN_NO_PARAMDOC   = YES
WARN_FORMAT= "$file:$line: $text"
WARN_LOGFILE   = DOCUMENTATION_OUTPUT_PATH/_PROJECT_NAME.warnings
#---
# configuration options related to the input files
#---
INPUT  = PROJECT_SOURCE_DIR
INPUT_ENCODING = UTF-8
FILE_PATTERNS  = *.cpp \
 *.h
RECURSIVE  = YES
EXCLUDE= 
EXCLUDE_SYMLINKS   = NO
EXCLUDE_PATTERNS   = test

[CMake] Any recent guides to adding support for doxygen

2009-10-14 Thread John Drescher
I want to add doxygen support to my projects but my google searches
are not finding good recent information on how to do this. Or has
nothing changed in the last 3 years?

-- 
John M. Drescher
___
Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://www.cmake.org/mailman/listinfo/cmake