From f523d63cc7bf5d5b8299f363c8e3442f41fa9ea7 Mon Sep 17 00:00:00 2001 From: Alexandre Bique Date: Sun, 5 Apr 2009 00:26:44 +0100 Subject: [PATCH] [doc] updated mainpage --- doc/Doxyfile | 4 ++-- doc/mainpage.doch | 8 ++++++++ doc/roadmap.doch | 3 ++- src/ozulis/ozulis.hh | 15 --------------- 4 files changed, 12 insertions(+), 18 deletions(-) create mode 100644 doc/mainpage.doch delete mode 100644 src/ozulis/ozulis.hh diff --git a/doc/Doxyfile b/doc/Doxyfile index b38d3c8..3c11eca 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -31,7 +31,7 @@ PROJECT_NAME = Ozulis # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 0.1 +PROJECT_NUMBER = 0.5 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. @@ -552,7 +552,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = src doc/roadmap.doch doc/conventions.doch +INPUT = src doc/roadmap.doch doc/conventions.doch doc/mainpage.doch # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/doc/mainpage.doch b/doc/mainpage.doch new file mode 100644 index 0000000..7648f9e --- /dev/null +++ b/doc/mainpage.doch @@ -0,0 +1,8 @@ +/** + * @mainpage Ozulis + * @section Introduction + * This is an experimental compiler for an undefined language. + * + * @li @ref roadmap "Roadmap" + * @li @ref conventions "Conventions" + */ diff --git a/doc/roadmap.doch b/doc/roadmap.doch index 23b0596..c3f611a 100644 --- a/doc/roadmap.doch +++ b/doc/roadmap.doch @@ -1,5 +1,5 @@ /** - * @page Roadmap + * @page roadmap *

Roadmap

* * This page describe the roadmap of Ozulis. @@ -76,4 +76,5 @@ * - find a logo * - make a website * - create a mailing list + * - make a better css for the documentation */ diff --git a/src/ozulis/ozulis.hh b/src/ozulis/ozulis.hh deleted file mode 100644 index 048489b..0000000 --- a/src/ozulis/ozulis.hh +++ /dev/null @@ -1,15 +0,0 @@ -/** - * @mainpage Ozulis - * @section Introduction - * This is an experimental compiler for an undefined language. - * - * @section Modules - * @dot - * digraph example { - * node [shape=record, fontname=Helvetica, fontsize=10]; - * b [ label="class B" URL="\ref B"]; - * c [ label="class C" URL="\ref C"]; - * b -> c [ arrowhead="open", style="dashed" ]; - * } - * @enddot - */ -- 2.11.4.GIT