* milena/doc/Doxyfile.in: Generate tag file and fine tune output.
* milena/doc/DoxygenLayout.xml,
* milena/doc/milena.qhcp: New.
---
ChangeLog | 9 ++++++
milena/doc/Doxyfile.in | 42 +++++++++++++++++++----------
{scribo => milena}/doc/DoxygenLayout.xml | 2 +-
doc/olena.qhcp => milena/doc/milena.qhcp | 3 +-
4 files changed, 38 insertions(+), 18 deletions(-)
copy {scribo => milena}/doc/DoxygenLayout.xml (99%)
copy doc/olena.qhcp => milena/doc/milena.qhcp (62%)
diff --git a/ChangeLog b/ChangeLog
index 473c3d1..b5674dc 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
2012-01-30 Guillaume Lazzara <z(a)lrde.epita.fr>
+ Improve layout and content of Milena's doc.
+
+ * milena/doc/Doxyfile.in: Generate tag file and fine tune output.
+
+ * milena/doc/DoxygenLayout.xml,
+ * milena/doc/milena.qhcp: New.
+
+2012-01-30 Guillaume Lazzara <z(a)lrde.epita.fr>
+
First draft of Scribo documentation.
* scribo/doc/.gitignore,
diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in
index 843280a..494d99c 100644
--- a/milena/doc/Doxyfile.in
+++ b/milena/doc/Doxyfile.in
@@ -1,5 +1,5 @@
-# Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development
-# Laboratory (LRDE)
+# Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and
+# Development Laboratory (LRDE)
#
# This file is part of Olena.
#
@@ -20,8 +20,10 @@
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
-PROJECT_NAME = "Milena (@PACKAGE_NAME@)"
-PROJECT_NUMBER = "User documentation @PACKAGE_VERSION@ @ID@"
+PROJECT_NAME = "Milena"
+PROJECT_NUMBER = "@PACKAGE_VERSION@"
+PROJECT_BRIEF = "An Image Processing Platform"
+PROJECT_LOGO = @top_srcdir@/doc/logo.jpg
OUTPUT_DIRECTORY = @builddir@/user-refman.tmp
CREATE_SUBDIRS = YES
OUTPUT_LANGUAGE = English
@@ -54,8 +56,8 @@ EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = NO
EXTRACT_LOCAL_METHODS = NO
-HIDE_UNDOC_MEMBERS = YES
-HIDE_UNDOC_CLASSES = YES
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = YES
HIDE_IN_BODY_DOCS = YES
INTERNAL_DOCS = NO
@@ -144,9 +146,10 @@ IGNORE_PREFIX = mln::
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
-HTML_HEADER =
-HTML_FOOTER =
-HTML_STYLESHEET =
+HTML_HEADER = @top_srcdir@/doc/header.html
+HTML_FOOTER = @top_srcdir@/doc/subdoc_footer.html
+HTML_STYLESHEET = @top_srcdir@/doc/doxygen.css
+LAYOUT_FILE = @top_srcdir@/doc/DoxygenLayout.xml
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
CHM_FILE =
@@ -327,26 +330,26 @@ SKIP_FUNCTION_MACROS = YES
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
-GENERATE_TAGFILE =
+GENERATE_TAGFILE = milena.tag
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
-CLASS_DIAGRAMS = YES
-HIDE_UNDOC_RELATIONS = YES
+CLASS_DIAGRAMS = NO
+HIDE_UNDOC_RELATIONS = NO
HAVE_DOT = YES
-CLASS_GRAPH = YES
+CLASS_GRAPH = NO
COLLABORATION_GRAPH = NO # Disabled for light doc
GROUP_GRAPHS = NO # Disabled for light doc
UML_LOOK = NO
-TEMPLATE_RELATIONS = YES
+TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = NO # Disabled for light doc
INCLUDED_BY_GRAPH = NO # Disabled for light doc
CALL_GRAPH = NO
CALLER_GRAPH = NO
-GRAPHICAL_HIERARCHY = YES
+GRAPHICAL_HIERARCHY = NO
DIRECTORY_GRAPH = NO # Disabled for light doc
DOT_IMAGE_FORMAT = png
DOT_PATH =
@@ -360,6 +363,15 @@ DOT_CLEANUP = YES
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to the Qt help engine
+#---------------------------------------------------------------------------
+GENERATE_QHP = yes
+QHP_NAMESPACE = "fr.epita.lrde.olena.scribo"
+QHP_VIRTUAL_FOLDER = "scribo-2.0"
+QCH_FILE = "@builddir@/scribo.qch"
+QHG_LOCATION = "qhelpgenerator"
+
# Local Variables:
# mode: Makefile
diff --git a/scribo/doc/DoxygenLayout.xml b/milena/doc/DoxygenLayout.xml
similarity index 99%
copy from scribo/doc/DoxygenLayout.xml
copy to milena/doc/DoxygenLayout.xml
index ac34f54..ff1e5e4 100644
--- a/scribo/doc/DoxygenLayout.xml
+++ b/milena/doc/DoxygenLayout.xml
@@ -1,7 +1,7 @@
<doxygenlayout version="1.0">
<!-- Navigation index tabs for HTML output -->
<navindex>
- <tab type="mainpage" visible="yes"
title="Scribo"/>
+ <tab type="mainpage" visible="yes"
title="Milena"/>
<tab type="pages" visible="yes" title=""/>
<tab type="modules" visible="yes" title=""/>
<tab type="namespaces" visible="yes" title="">
diff --git a/doc/olena.qhcp b/milena/doc/milena.qhcp
similarity index 62%
copy from doc/olena.qhcp
copy to milena/doc/milena.qhcp
index 595d34e..1a4e7ca 100644
--- a/doc/olena.qhcp
+++ b/milena/doc/milena.qhcp
@@ -5,8 +5,7 @@
</assistant>
<docFiles>
<register>
- <file>../milena/doc/user-refman/html/milena.qch</file>
- <file>../scribo/doc/user-refman/html/scribo.qch</file>
+ <file>user-refman/html/milena.qch</file>
</register>
</docFiles>
</QHelpCollectionProject>
\ No newline at end of file
--
1.7.2.5