Techwizz/Gobligine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fixed generating DoxyGen documentation, added to CMake

Browse source
This commit is contained in:
Pali Rohár 2011-03-26 23:30:14 +01:00
parent 8bdb1a3f52
commit c9c69a0a7e
6 changed files with 968 additions and 518 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CMakeLists.txt
View file

@ -294,6 +294,7 @@ find_package(OpenGLES)
find_package(SDL_gles)
find_package(Sqlite)
find_package(Doxygen)
include(CheckFunctionExists)
@ -325,6 +326,8 @@ option(WITH_X "Compile Stratagus with X Window System clipboard pasting support"
#option(WITH_OPENGL "Use OpenGL for rendering" ON)
option(WITH_OPENGLES "Compile Stratagus with OpenGL ES 1.1 rendering support instead OpenGL" OFF)
option(ENABLE_DOC "Generate Stratagus source code documentation with Doxygen" ON)
# Stratagus definitions
add_definitions(${PNG_DEFINITIONS} -DUSE_ZLIB)
@ -478,6 +481,19 @@ if(ENABLE_STATIC AND WIN32 AND MINGW)
set_target_properties(png2stratagus PROPERTIES LINK_FLAGS "${LINK_FLAGS} -static-libgcc")
endif()
########### next target ###############
if(DOXYGEN_FOUND AND ENABLE_DOC)
add_custom_command(OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen/index.html
COMMAND ${DOXYGEN_EXECUTABLE} ARGS ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen.cfg
DEPENDS ${CMAKE_SOURCE_DIR}/doc/doxygen*.cfg stratagus
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
COMMENT "Generating Stratagus souce code documentation with Doxygen" VERBATIM
)
add_custom_target(doc ALL DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen/index.html)
set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen/)
endif()
########### install files ###############
install(TARGETS stratagus DESTINATION games)

17
contrib/doxygen-header.html
View file

@ -1,17 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>$title</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff"><PRE WIDTH=80>
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</PRE><B>(C) Copyright 2001-2006 by The Stratagus Project. Distributed under the
<A HREF="gpl.html">"GNU General Public License"</A></B><HR>

6
doc/doxygen-footer.cfg Normal file
View file

@ -0,0 +1,6 @@
<hr/>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br/>
All trademarks and copyrights on this page are owned by their respective owners.<br/>
</body>
</html>

24
doc/doxygen-header.cfg Normal file
View file

@ -0,0 +1,24 @@
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>$title</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<pre width="80">
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr/>

1413
contrib/doxygen-stratagus.cfg → doc/doxygen.cfg
View file

File diff suppressed because it is too large Load diff

10
src/stratagus/stratagus.cpp
View file

@ -10,9 +10,8 @@
//
/**@name stratagus.cpp - The main file. */
//
// (c) Copyright 1998-2008 by Lutz Sammer, Francois Beerten, and
// Jimmy Salmon
// (c) Copyright 2010 by Pali Rohár
// (c) Copyright 1998-2011 by Lutz Sammer, Francois Beerten,
// Jimmy Salmon and Pali Rohár
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
@ -38,8 +37,7 @@
** @section Introduction Introduction
**
** Welcome to the source code documentation of the Stratagus engine.
** Extract the source documentation with doxygen (http://www.doxygen.org)
** or doc++ (http://www.zib.de/Visual/software/doc++/index.html) tools.
** Extract the source documentation with doxygen (http://www.doxygen.org) tool.
**
** Any help to improve this documention is welcome. If you didn't
** understand something or you found an error or a wrong spelling
@ -48,7 +46,7 @@
** @section Informations Informations
**
** Visit the https://launchpad.net/stratagus web page for the latest news and
** ../doc/readme.html for other documentations.
** <A HREF="../index.html">Stratagus Info</A> for other documentations.
**
** @section Modules Modules
**