Skip to content
GitLab
Commit cacbfbd3 authored by Guillaume Lazzara's avatar Guillaume Lazzara
Browse files

Improve common documentation. 

	* AUTHORS: Use RST syntax.

	* doc/Doxyfile.in: Use .dox files for documentation.

	* doc/DoxygenLayout.xml: Improve layout.

	* doc/Makefile.am: Add dependencies.

	* doc/lrde.bib,
	* doc/contributors.dox: New.

	* doc/bibliography.hh,
	* doc/mainpage.hh,
	* doc/modules_list.hh: Rename to...

	* doc/bibliography.dox,
	* doc/mainpage.dox,
	* doc/modules_list.dox: ...this.

	* doc/olena.qhcp: Remove.
parent 2cd03c3e
Expand all Hide whitespace changes
Inline Side-by-side
AUTHORS
View file @ cacbfbd3
......@@ -5,7 +5,8 @@ This package was written by and with the assistance of
Active LRDE Staff.
==================
* Thierry Graud theo@lrde.epita.fr
* **Thierry Graud** <theo@lrde.epita.fr>
- Management of the project in the first place.
- Type system.
- Revamp of Metalic (Olena pre-1.0).
......@@ -14,11 +15,15 @@ Active LRDE Staff.
- Olena 1.0 core.
- Numerous hours spent thinking about Olena.
* Guillaume Lazzara z@lrde.epita.fr
* **Guillaume Lazzara** <z@lrde.epita.fr>
- SCRIBO module main author and maintainer.
- Library improvements.
* Roland Levillain roland@lrde.epita.fr
* **Roland Levillain** <roland@lrde.epita.fr>
- Project manager.
- Theoretical mentor.
- Renovation of Swilena (Olena 0.10a).
......@@ -32,30 +37,41 @@ Active LRDE Staff.
Past contributors of LRDE Staff.
================================
* Jrme Darbon jerome@lrde.epita.fr
* **Jrme Darbon** <jerome@lrde.epita.fr>
- Image morphology and Olena morpho.
* Rda Dehak reda@lrde.epita.fr
* **Rda Dehak** <reda@lrde.epita.fr>
- Management of the project.
- Color conversions.
- Cleanup the sources.
* Akim Demaille akim@lrde.epita.fr
* **Akim Demaille** <akim@lrde.epita.fr>
- Configuration system.
- Maintenance of code's clearness.
* Alexandre Duret-Lutz adl@lrde.epita.fr
* **Alexandre Duret-Lutz** <adl@lrde.epita.fr>
- Maintenance of the source tree for several years.
- Type system.
- Test system.
- First documentation system.
- Numerous hours spent on Olena to make it better.
* Fabien Freling fabien.freling@lrde.epita.fr
* **Fabien Freling** <fabien.freling@lrde.epita.fr>
- Work on Melimage with IGR.
- Library improvements.
* Yann Jacquelet jacquelet@lrde.epita.fr
* **Yann Jacquelet** <jacquelet@lrde.epita.fr>
- SCRIBO-related work.
......@@ -63,20 +79,25 @@ Past contributors of LRDE Staff.
Interns.
========
* Arthur Crpin-Leblond
* **Arthur Crpin-Leblond**
- SCRIBO structured outputs (XML, HTML, PDF).
* Raphal Boissel
* **Raphal Boissel**
- Graph implementation of a DIA toolchain in SCRIBO.
=========================
Students from Class 2012.
=========================
* Frdric Bour frederic.bour@lrde.epita.fr
* **Frdric Bour** <frederic.bour@lrde.epita.fr>
- Prototype of the upcoming functions system.
* Julien Marquegnies julien.marquegnies@lrde.epita.fr
* **Julien Marquegnies** <julien.marquegnies@lrde.epita.fr>
- Fast implementation of the Hough transform.
- Many improvements in SCRIBO layout analysis.
......@@ -84,7 +105,8 @@ Students from Class 2012.
Students from Class 2011.
=========================
* Edwin Carlinet edwin.carlinet@lrde.epita.fr
* **Edwin Carlinet** <edwin.carlinet@lrde.epita.fr>
- Accumulators.
- Morphological connected filters.
......@@ -92,32 +114,44 @@ Students from Class 2011.
Students from Class 2010.
=========================
* Florent D'Halluin
* **Florent D'Halluin**
- Document layout viewer.
* Etienne Folio
* **Etienne Folio**
- Color type traits.
=========================
Students from Class 2009.
=========================
* Alexandre Abraham
* **Alexandre Abraham**
- R/W functions.
- Topological watershed transform.
* Nicolas Ballas
* **Nicolas Ballas**
- Image properties.
- Data routines.
* Vivien Delmon
* **Vivien Delmon**
- Misc. corrections.
* Matthieu Garrigues
* **Matthieu Garrigues**
- Value types and I/Os.
- Draft of the FLLT.
* Ugo Jardonnet
* **Ugo Jardonnet**
- Geometrical transforms.
- ICP registration algorithm.
......@@ -125,24 +159,32 @@ Students from Class 2009.
Students from Class 2008.
=========================
* Tristan Croiset
* **Tristan Croiset**
- Dynamic (Dyn) (Olena proto-1.0)
* Quentin Hocquet
* **Quentin Hocquet**
- SCOOL
* Thomas Moulard
* **Thomas Moulard**
- SCOOL
=========================
Students from Class 2007.
=========================
* Christophe Berger
* **Christophe Berger**
- Connected filters (Olena proto-1.0, Olena pre-1.0).
- SCOOP 2 (Olena proto-1.0).
* Nicolas Widynski
* **Nicolas Widynski**
- Connected filters (Olena proto-1.0).
- Inpainting (Olena proto-1.0).
- Segmentation (watershed transform, watersnake, snakes) (Olena proto-1.0)
......@@ -151,16 +193,21 @@ Students from Class 2007.
Students from Class 2006.
=========================
* Simon Odou
* **Simon Odou**
- Contributions to document the code.
- Deconvolution.
- Generic morphers.
- SCOOP 2 (Olena proto-1.0).
* Nicolas Pouillard
* **Nicolas Pouillard**
- Dynamic-static bridge prototype (Dyn) (Olena proto-1.0).
* Damien Thivolle
* **Damien Thivolle**
- Contributions to document the code.
- Generic morphers.
- Configuration system.
......@@ -174,14 +221,17 @@ Students from Class 2006.
Students from Class 2005.
=========================
* Giovanni Palma
* **Giovanni Palma**
- Color conversion.
- Attribute opening and closing algorithms.
- New documentation system.
- Document the code.
- Cleanup the sources.
* Niels Van Vliet
* **Niels Van Vliet**
- Color conversion.
- Attribute opening and closing algorithms.
- Contributions to document the code.
......@@ -191,21 +241,28 @@ Students from Class 2005.
Students from Class 2004.
=========================
* Sylvain Berlemont
* **Sylvain Berlemont**
- Combinatorial maps.
- Cleanup the sources.
* Nicolas Burrus
* **Nicolas Burrus**
- Integre.
- Olena I/O.
- Source tree.
* David Lesage
* **David Lesage**
- Type system.
- New paradigm.
- Cleanup the sources.
* Astrid Wang
* **Astrid Wang**
- New documentation system.
- Static arrays implementation.
......@@ -213,25 +270,36 @@ Students from Class 2004.
Students from Class 2003.
=========================
* Ignacy Gawedzki
* **Ignacy Gawedzki**
- Color system.
* Jean-Sbastien Mouret
* **Jean-Sbastien Mouret**
- Image I/O.
- Source tree and configuration system.
- Fast morphological operators.
* Quc Peyrot
* **Quc Peyrot**
- Watershed algorithm.
* Raphal Poss
* **Raphal Poss**
- Source tree and configuration system.
- Documentation.
* Yann Rgis-Gianas
* **Yann Rgis-Gianas**
- Type system.
* Emmanuel Turquin
* **Emmanuel Turquin**
- Implementation of transforms.
- Integre.
......@@ -239,22 +307,29 @@ Students from Class 2003.
Students from Class 2002.
=========================
* Jean Chalard
* **Jean Chalard**
- Colors.
- Vectors and matrices implementation.
- Olena iterators implementation.
- Wavelets.
* Rmi Coupet
* **Rmi Coupet**
- Olena morpho.
- Data types (pre-0.6).
- Olena core.
- Bibliographical research.
* Ludovic Perrine
* **Ludovic Perrine**
- Fuzzy types.
* Pierre-Yves Strub
* **Pierre-Yves Strub**
- Olena morpho.
- Source tree and configuration system.
- Type system.
......@@ -263,20 +338,28 @@ Students from Class 2002.
Students from Class 2001.
=========================
* Alexis Angelidis
* **Alexis Angelidis**
- Olena logo.
* Vincent Berruchon
* Renaud Franois
* **Vincent Berruchon**
* **Renaud Franois**
- Bibliographical research.
* Anthony Pinagot
* **Anthony Pinagot**
- Olena I/O.
- Statistical operators.
- FFT algorithm.
* Michal Strauss
* **Michal Strauss**
- Image morphology.
- Watershed algorithms.
- Olena I/O.
......@@ -285,7 +368,8 @@ Students from Class 2001.
Students from Class 2000.
=========================
* Yoann Fabre
* **Yoann Fabre**
- Type system.
......@@ -293,17 +377,24 @@ Students from Class 2000.
Other Contributors.
===================
* Guillaume Duhamel
* **Guillaume Duhamel**
- Low-level routines.
* Simon Nivault
* **Simon Nivault**
- Lemming object.
- Many cleanups.
* Dimitri Papadopoulos-Orfanos
* **Dimitri Papadopoulos-Orfanos**
- Type system.
* Heru Xue
* **Heru Xue**
- Color system.
......
ChangeLog
View file @ cacbfbd3
2012-02-01 Guillaume Lazzara <z@lrde.epita.fr>
Improve common documentation.
* AUTHORS: Use RST syntax.
* doc/Doxyfile.in: Use .dox files for documentation.
* doc/DoxygenLayout.xml: Improve layout.
* doc/Makefile.am: Add dependencies.
* doc/lrde.bib,
* doc/contributors.dox: New.
* doc/bibliography.hh,
* doc/mainpage.hh,
* doc/modules_list.hh: Rename to...
* doc/bibliography.dox,
* doc/mainpage.dox,
* doc/modules_list.dox: ...this.
* doc/olena.qhcp: Remove.
2012-02-01 Guillaume Lazzara <z@lrde.epita.fr>
Improve common documentation.
......
doc/Doxyfile.in
View file @ cacbfbd3
......@@ -40,7 +40,7 @@ MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
ALIASES =
ALIASES = " "
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = YES
......@@ -92,17 +92,15 @@ WARN_LOGFILE =
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = @top_srcdir@/doc
FILE_PATTERNS = *.cc \
*.hh \
*.hxx \
*.hcc
FILE_PATTERNS = *.dox
RECURSIVE = YES
EXCLUDE = @top_srcdir@/milena/ \
@top_srcdir@/scribo/
EXCLUDE_SYMLINKS = YES
EXCLUDE_PATTERNS = *spe.hh
EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::*
EXAMPLE_PATH =
EXAMPLE_PATH = @top_srcdir@/doc/ \
@builddir@
EXAMPLE_PATTERNS = *.cc \
*.cc.raw \
*.txt
......
doc/DoxygenLayout.xml
View file @ cacbfbd3
......@@ -2,7 +2,7 @@
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title="Home"/>
<tab type="pages" visible="no" title=""/>
<tab type="pages" visible="yes" title=""/>
<tab type="modules" visible="no" title=""/>
<tab type="namespaces" visible="no" title="">
<tab type="namespaces" visible="no" title=""/>
......
doc/Makefile.am
View file @ cacbfbd3
......@@ -53,13 +53,17 @@ regen-doc:
DOXYFILE_USER = Doxyfile_user
REFMAN_deps = $(srcdir)/footer.html \
$(srcdir)/header.html \
$(srcdir)/doxygen.css \
$(srcdir)/mainpage.hh \
$(srcdir)/DoxygenLayout.xml \
$(srcdir)/modules_list.hh \
$(srcdir)/olena.bib
REFMAN_deps = $(srcdir)/footer.html \
$(srcdir)/header.html \
$(srcdir)/doxygen.css \
$(srcdir)/mainpage.dox \
$(srcdir)/DoxygenLayout.xml \
$(srcdir)/modules_list.dox \
$(srcdir)/olena.bib \
$(srcdir)/contributors.dox \
$(srcdir)/bibliography.dox \
contributors.html \
lrde_olena.html
# Sed is used to generate Doxyfile from Doxyfile.in instead of
# configure, because the former is way faster than the latter.
......@@ -113,8 +117,36 @@ $(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp
EXTRA_DIST += $(USER_REFMAN)
## -------------- ##
## Contributors. ##
## -------------- ##
contributors.html: $(top_srcdir)/AUTHORS
rst2html --stylesheet-path=$(srcdir)/doxygen.css --link-stylesheet \
--input-encoding=latin1 --output-encoding=latin1 \
$(top_srcdir)/AUTHORS > contributors.html
## -------------- ##
## Bibliography. ##
## -------------- ##
# Warning: also generate lrde_olena.cite
lrde_olena.bib:
bib2bib -s plain -oc lrde_olena.cite -ob lrde_olena.bib -c \
'project = "Image" or project = "Olena"' \
-s year -r $(srcdir)/lrde.bib
# Warning: also generate lrde_olena_bib.html
lrde_olena.html: lrde_olena.bib
bibtex2html -s plain -nokeywords -citefile lrde_olena.cite \
-noabstract -nofooter -labelname -nodoc -linebreak -nf urllrde PDF lrde_olena.bib
MAINTAINERCLEANFILES += lrde_olena.cite \
lrde_olena.bib \
lrde_olena_bib.html \
lrde_olena.html
## ---------- ##
## Cleaning. ##
......
doc/bibliography.hh → doc/bibliography.dox
View file @ cacbfbd3
/** \page bibliography Bibliography
Here you can find all the articles related to the Olena platform.
In this page, all publications used to implement Olena or related to Olena itself are referenced.
\li \cite burrus.03.mpool
\li \cite darbon.02.ismm
\li \cite darbon.04.ecoopphd
Summary:
\li \ref olnpublis
\li \ref olnpublisjournals
\li \ref olnpublisconfs
\li \ref olnpublisposters
\li \ref olnpublistechreps
\li \ref{burrus.03.mpool}
\li \ref{darbon.02.ismm}
\li \ref{darbon.04.ecoopphd}
\li \cite duret.00.gcse
\li \cite geraud.00.icpr
\li \cite geraud.01.ai
......@@ -16,4 +23,15 @@
\li \cite levillain.10.wadgmm
\li \cite levillain.11.gretsi
\section olnpublis Olena Publications
\subsection olnpublisjournals In Journals
\subsection olnpublisconfs In Conferences
\htmlinclude lrde_olena.html
\subsection olnpublisposters Posters
\subsection olnpublistechreps Student Technical Reports
*/
doc/contributors.dox 0 → 100644
View file @ cacbfbd3
/** \page Contributors List of contributors
\htmlinclude contributors.html
*/
doc/lrde.bib 0 → 100644
View file @ cacbfbd3
This diff is collapsed.
doc/mainpage.hh → doc/mainpage.dox
View file @ cacbfbd3
......@@ -13,8 +13,8 @@
<tr>
<td>
\li What is Olena ?
\li \ref bibliography
\li Contributors
\li <a class="el" href="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Publications">Bibliography</a>
\li <a class="el" href="a00028.html">Contributors</a>
</td>
<td>
\li \ref moduleslist
......@@ -23,7 +23,7 @@
\li Swilena
</td>
<td>
\li Online Demos
\li <a class="el" href="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Demos">Online Demos</a>
\li Papers Related Programs
\li Olena Powered Programs
</td>
......
doc/olena.qhcp deleted 100644 → 0
View file @ 2cd03c3e
<?xml version="1.0" encoding="UTF-8"?>
<QHelpCollectionProject version="1.0">
<assistant>
<startPage>qthelp://fr.epita.lrde.olena/milena-2.0/index.html</startPage>
</assistant>
<docFiles>
<register>
<file>../milena/doc/user-refman/html/milena.qch</file>
<file>../scribo/doc/user-refman/html/scribo.qch</file>
</register>
</docFiles>
</QHelpCollectionProject>
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment