Revert "use relative path in tagfiles, otherwise documentation output cannot be moved"

This reverts commit ea256c954a.

Conflicts:
	Documentation/CMakeLists.txt
This commit is contained in:
Sébastien Loriot 2013-06-13 15:21:07 +02:00
parent ceab41bda6
commit 0f8498f3b5
6 changed files with 205 additions and 4 deletions

View File

@ -54,7 +54,7 @@ function(configure_doxygen_package CGAL_PACKAGE_NAME)
foreach(depend ${DEPENDENCIES}) foreach(depend ${DEPENDENCIES})
file(APPEND ${CGAL_DOC_PACKAGE_DEFAULTS} file(APPEND ${CGAL_DOC_PACKAGE_DEFAULTS}
"TAGFILES += ${CGAL_DOC_TAG_DIR}/${depend}.tag=../${depend}\n") "TAGFILES += ${CGAL_DOC_TAG_DIR}/${depend}.tag=${CGAL_DOC_OUTPUT_DIR}/${depend}/html\n")
endforeach() endforeach()
configure_file(${CGAL_PACKAGE_DIR}/doc/${CGAL_PACKAGE_NAME}/Doxyfile.in configure_file(${CGAL_PACKAGE_DIR}/doc/${CGAL_PACKAGE_NAME}/Doxyfile.in

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

@ -131,7 +131,7 @@ namespace Mesh_3 {
template < typename C3T3, typename MeshDomain, typename MeshCriteria > template < typename C3T3, typename MeshDomain, typename MeshCriteria >
void void
init_c3t3(C3T3& c3t3, const MeshDomain& domain, const MeshCriteria& criteria) init_c3t3(C3T3& c3t3, const MeshDomain& domain, const MeshCriteria&)
{ {
typedef typename MeshDomain::Point_3 Point_3; typedef typename MeshDomain::Point_3 Point_3;
typedef typename MeshDomain::Index Index; typedef typename MeshDomain::Index Index;

View File

@ -777,6 +777,9 @@ void MainWindow::open(QString filename)
fileinfo.absoluteDir().absolutePath()); fileinfo.absoluteDir().absolutePath());
Scene_item* scene_item = load_item(fileinfo, find_loader(load_pair.first)); Scene_item* scene_item = load_item(fileinfo, find_loader(load_pair.first));
if(scene_item != 0) {
this->addToRecentFiles(filename);
}
selectSceneItem(scene->addItem(scene_item)); selectSceneItem(scene->addItem(scene_item));
} }
@ -1122,7 +1125,6 @@ void MainWindow::on_actionLoad_triggered()
this->addToRecentFiles(filename); this->addToRecentFiles(filename);
} else { } else {
open(filename); open(filename);
this->addToRecentFiles(filename);
} }
} }
} }

View File

@ -46,7 +46,7 @@ public:
/// In that case, the function will be scanned over the bounding box to /// In that case, the function will be scanned over the bounding box to
/// compute approximation of the extrema. If the method is not /// compute approximation of the extrema. If the method is not
/// overloaded by derived classes, the default is to return false. /// overloaded by derived classes, the default is to return false.
virtual bool get_min_max(double& min, double& max) { virtual bool get_min_max(double&, double&) {
return false; return false;
} }
}; };

View File

@ -0,0 +1,199 @@
#!/usr/bin/env python
# This script creates the directory structure for a new package.
# Usage:
# cgal_create_package_dir.py Package_name [optional creation directory]
import sys
import os
import re
import argparse
import shutil
parser = argparse.ArgumentParser(
description='Create directory structure for a new CGAL package.',
epilog='A single directory named after the package, which contains ' +
'the whole directory structure, is created at the creation path.')
parser.add_argument('packagename',
help='name of new CGAL package')
parser.add_argument('creationpath', nargs='?',
help='directory where package is created; ' +
'if omitted, the package directory is created ' +
'in the current directory')
args = parser.parse_args()
packagename = args.packagename
creationpath = args.creationpath
doxystring = \
r"""@INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS}
PROJECT_NAME = "CGAL ${CGAL_CREATED_VERSION_NUM} - Put title of project here"
INPUT = ${CMAKE_SOURCE_DIR}/PACKAGENAME/doc/PACKAGENAME/ \
${CMAKE_SOURCE_DIR}/PACKAGENAME/include
"""
descrstring = \
r"""// PRETTY PACKAGE NAME should equal the project title in Doxyfile.in
/// \defgroup PkgPACKAGE PRETTY PACKAGE NAME Reference
/// \defgroup PkgPACKAGEConcepts Concepts
/// \ingroup PkgPACKAGE
/// \defgroup PkgPACKAGEAlgorithmClasses Algorithm Classes
/// \ingroup PkgPACKAGE
/// \defgroup PkgPACKAGETraitsClasses Traits Classes
/// \ingroup PkgPACKAGE
/// \defgroup PkgPACKAGEMiscellaneous Miscellaneous
/// \ingroup PkgPACKAGE
/*!
\addtogroup PkgPACKAGE
\todo check generated documentation
\cgalPkgDescriptionBegin{PACKAGE NAME,PkgPACKAGESummary}
\cgalPkgPicture{pkg-small.png}
\cgalPkgSummaryBegin
\cgalPkgAuthors{PACKAGE AUTHOR}
\cgalPkgDesc{PACKAGE DESCRIPTION.
The package provides ... }
\cgalPkgManuals{Chapter_PACKAGE_NAME,PkgPACKAGE}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{X.X}
\cgalPkgDependsOn{\ref PkgDEPENDENCY}
\cgalPkgBib{cgal:x-x}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{DEMO 1,demo1.zip}
\cgalPkgDemo{DEMO 2,demo2.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
*/
"""
usermanstring = \
r"""namespace CGAL {
/*!
\mainpage User Manual
\anchor Chapter_PACKAGE_NAME
\anchor chaptermine
\cgalAutoToc
\author AUTHOR1, AUTHOR2
This chapter describes the ...
\section secmydefinitions Definitions
Section on definitions here ...
\section secmyexamples Examples
\subsection myFirstExample First Example
The following example shows ...
*/
} /* namespace CGAL */
"""
depsstring = \
r"""Manual
Kernel_23
STL_Extension
Algebraic_foundations
Circulator
Stream_support
"""
if re.match("^[A-Za-z_][A-Za-z0-9_]*$", packagename):
if creationpath and (not creationpath == '.'):
packagepath = os.path.join(creationpath, packagename)
else:
packagepath = packagename
os.mkdir(packagepath)
open(os.path.join(packagepath, 'dont_submit'), 'w').close()
inclpath = os.path.join(packagepath, 'include', 'CGAL', packagename)
os.makedirs(inclpath)
os.mkdir(os.path.join(packagepath, 'src'))
testpath = os.path.join(packagepath, 'test', packagename)
os.makedirs(testpath)
os.mkdir(os.path.join(testpath, 'data'))
os.mkdir(os.path.join(testpath, 'include'))
expath = os.path.join(packagepath, 'examples', packagename)
os.makedirs(expath)
os.mkdir(os.path.join(expath, 'data'))
os.mkdir(os.path.join(expath, 'include'))
open(os.path.join(expath, 'README'), 'w').close()
demopath = os.path.join(packagepath, 'demo', packagename)
os.makedirs(demopath)
os.mkdir(os.path.join(demopath, 'data'))
os.mkdir(os.path.join(demopath, 'include'))
open(os.path.join(demopath, 'README'), 'w').close()
benpath = os.path.join(packagepath, 'benchmark', packagename)
os.makedirs(benpath)
os.mkdir(os.path.join(packagepath, 'scripts'))
os.mkdir(os.path.join(packagepath, 'developer_scripts'))
infopath = os.path.join(packagepath, 'package_info', packagename)
os.makedirs(infopath)
open(os.path.join(infopath, 'copyright.txt'), 'w').close()
open(os.path.join(infopath, 'description.txt'), 'w').close()
open(os.path.join(infopath, 'license.txt'), 'w').close()
open(os.path.join(infopath, 'long_description.txt'), 'w').close()
open(os.path.join(infopath, 'maintainer'), 'w').close()
docpath = os.path.join(packagepath, 'doc', packagename)
os.makedirs(docpath)
os.mkdir(os.path.join(docpath, 'CGAL'))
os.mkdir(os.path.join(docpath, 'Concepts'))
figpath = os.path.join(docpath, 'fig')
os.mkdir(figpath)
open(os.path.join(docpath, 'examples.txt'), 'w').close()
usermanpath = os.path.join(docpath, (packagename + '.txt'))
usermanfile = open(usermanpath, 'w')
usermanfile.write(usermanstring)
usermanfile.close()
doxypath = os.path.join(docpath, ('Doxyfile.in'))
doxyfile = open(doxypath, 'w')
doxyfile.write(re.sub('PACKAGENAME', packagename, doxystring))
doxyfile.close()
descrpath = os.path.join(docpath, 'PackageDescription.txt')
descrfile = open(descrpath, 'w')
descrfile.write(descrstring)
descrfile.close()
depspath = os.path.join(docpath, ('dependencies'))
depsfile = open(depspath, 'w')
depsfile.write(depsstring)
depsfile.close()
# try to find figure pkg-small.png and copy it to figure path
scriptdir = os.path.dirname(sys.argv[0])
cgaldir = os.path.dirname(os.path.dirname(scriptdir))
figfile = os.path.join(cgaldir, 'Documentation', 'doc',
'Documentation', 'fig', 'pkg-small.png')
if os.path.exists(figfile):
shutil.copy(figfile, figpath)
else:
sys.stderr.write("Error: Bad package name: " + packagename + '\n')
sys.stderr.write("The package name should consist of:" + '\n')
sys.stderr.write \
("letters, digits and underscores and not start with a digit." + '\n')