Remove doc header (show version number on the main page) (#404)
authorAlpar Juttner <alpar@cs.elte.hu>
Fri, 04 Mar 2011 10:31:12 +0100
changeset 1037d3b041452dd8
parent 1036 021e232acda2
child 1038 27ddc8009ac3
child 1039 7f37e5fc416e
child 1040 8e39ccaabf48
child 1044 66156a3498ea
Remove doc header (show version number on the main page) (#404)
configure.ac
doc/CMakeLists.txt
doc/Doxyfile.in
doc/mainpage.dox
doc/mainpage.dox.in
     1.1 --- a/configure.ac	Fri Jan 21 22:04:22 2011 +0100
     1.2 +++ b/configure.ac	Fri Mar 04 10:31:12 2011 +0100
     1.3 @@ -98,13 +98,14 @@
     1.4  
     1.5  dnl Add dependencies on files generated by configure.
     1.6  AC_SUBST([CONFIG_STATUS_DEPENDENCIES],
     1.7 -  ['$(top_srcdir)/doc/Doxyfile.in $(top_srcdir)/lemon/lemon.pc.in $(top_srcdir)/cmake/version.cmake.in'])
     1.8 +  ['$(top_srcdir)/doc/Doxyfile.in $(top_srcdir)/doc/mainpage.dox.in $(top_srcdir)/lemon/lemon.pc.in $(top_srcdir)/cmake/version.cmake.in'])
     1.9  
    1.10  AC_CONFIG_FILES([
    1.11  Makefile
    1.12  demo/Makefile
    1.13  cmake/version.cmake
    1.14  doc/Doxyfile
    1.15 +doc/mainpage.dox
    1.16  lemon/lemon.pc
    1.17  ])
    1.18  
     2.1 --- a/doc/CMakeLists.txt	Fri Jan 21 22:04:22 2011 +0100
     2.2 +++ b/doc/CMakeLists.txt	Fri Mar 04 10:31:12 2011 +0100
     2.3 @@ -11,6 +11,12 @@
     2.4    @ONLY
     2.5  )
     2.6  
     2.7 +CONFIGURE_FILE(
     2.8 +  ${PROJECT_SOURCE_DIR}/doc/mainpage.dox.in
     2.9 +  ${PROJECT_BINARY_DIR}/doc/mainpage.dox
    2.10 +  @ONLY
    2.11 +)
    2.12 +
    2.13  IF(DOXYGEN_EXECUTABLE AND GHOSTSCRIPT_EXECUTABLE)
    2.14    FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/)
    2.15    SET(GHOSTSCRIPT_OPTIONS -dNOPAUSE -dBATCH -q -dEPSCrop -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sDEVICE=pngalpha)
     3.1 --- a/doc/Doxyfile.in	Fri Jan 21 22:04:22 2011 +0100
     3.2 +++ b/doc/Doxyfile.in	Fri Mar 04 10:31:12 2011 +0100
     3.3 @@ -4,8 +4,8 @@
     3.4  # Project related configuration options
     3.5  #---------------------------------------------------------------------------
     3.6  DOXYFILE_ENCODING      = UTF-8
     3.7 -PROJECT_NAME           = @PACKAGE_NAME@
     3.8 -PROJECT_NUMBER         = @PACKAGE_VERSION@
     3.9 +PROJECT_NAME           = 
    3.10 +PROJECT_NUMBER         = 
    3.11  PROJECT_BRIEF          =
    3.12  PROJECT_LOGO           =
    3.13  OUTPUT_DIRECTORY       = 
    3.14 @@ -96,7 +96,8 @@
    3.15                           "@abs_top_srcdir@/lemon/concepts" \
    3.16                           "@abs_top_srcdir@/demo" \
    3.17                           "@abs_top_srcdir@/tools" \
    3.18 -                         "@abs_top_srcdir@/test/test_tools.h"
    3.19 +                         "@abs_top_srcdir@/test/test_tools.h" \
    3.20 +                         "@abs_top_builddir@/doc/mainpage.dox"
    3.21  INPUT_ENCODING         = UTF-8
    3.22  FILE_PATTERNS          = *.h \
    3.23                           *.cc \
    3.24 @@ -148,7 +149,7 @@
    3.25  HTML_COLORSTYLE_GAMMA  = 80
    3.26  HTML_TIMESTAMP         = YES
    3.27  HTML_ALIGN_MEMBERS     = YES
    3.28 -HTML_DYNAMIC_SECTIONS  = NO
    3.29 +HTML_DYNAMIC_SECTIONS  = YES
    3.30  GENERATE_DOCSET        = NO
    3.31  DOCSET_FEEDNAME        = "Doxygen generated docs"
    3.32  DOCSET_BUNDLE_ID       = org.doxygen.Project
     4.1 --- a/doc/mainpage.dox	Fri Jan 21 22:04:22 2011 +0100
     4.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.3 @@ -1,51 +0,0 @@
     4.4 -/* -*- mode: C++; indent-tabs-mode: nil; -*-
     4.5 - *
     4.6 - * This file is a part of LEMON, a generic C++ optimization library.
     4.7 - *
     4.8 - * Copyright (C) 2003-2009
     4.9 - * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
    4.10 - * (Egervary Research Group on Combinatorial Optimization, EGRES).
    4.11 - *
    4.12 - * Permission to use, modify and distribute this software is granted
    4.13 - * provided that this copyright notice appears in all copies. For
    4.14 - * precise terms see the accompanying LICENSE file.
    4.15 - *
    4.16 - * This software is provided "AS IS" with no warranty of any kind,
    4.17 - * express or implied, and with no claim as to its suitability for any
    4.18 - * purpose.
    4.19 - *
    4.20 - */
    4.21 -
    4.22 -/**
    4.23 -\mainpage LEMON Documentation
    4.24 -
    4.25 -\section intro Introduction
    4.26 -
    4.27 -\subsection whatis What is LEMON
    4.28 -
    4.29 -LEMON stands for <b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling
    4.30 -and <b>O</b>ptimization in <b>N</b>etworks.
    4.31 -It is a C++ template
    4.32 -library aimed at combinatorial optimization tasks which
    4.33 -often involve in working
    4.34 -with graphs.
    4.35 -
    4.36 -<b>
    4.37 -LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    4.38 -project.
    4.39 -You are free to use it in your commercial or
    4.40 -non-commercial applications under very permissive
    4.41 -\ref license "license terms".
    4.42 -</b>
    4.43 -
    4.44 -\subsection howtoread How to read the documentation
    4.45 -
    4.46 -If you would like to get to know the library, see
    4.47 -<a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
    4.48 -
    4.49 -If you know what you are looking for, then try to find it under the
    4.50 -<a class="el" href="modules.html">Modules</a> section.
    4.51 -
    4.52 -If you are a user of the old (0.x) series of LEMON, please check out the
    4.53 -\ref migration "Migration Guide" for the backward incompatibilities.
    4.54 -*/
     5.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     5.2 +++ b/doc/mainpage.dox.in	Fri Mar 04 10:31:12 2011 +0100
     5.3 @@ -0,0 +1,51 @@
     5.4 +/* -*- mode: C++; indent-tabs-mode: nil; -*-
     5.5 + *
     5.6 + * This file is a part of LEMON, a generic C++ optimization library.
     5.7 + *
     5.8 + * Copyright (C) 2003-2009
     5.9 + * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
    5.10 + * (Egervary Research Group on Combinatorial Optimization, EGRES).
    5.11 + *
    5.12 + * Permission to use, modify and distribute this software is granted
    5.13 + * provided that this copyright notice appears in all copies. For
    5.14 + * precise terms see the accompanying LICENSE file.
    5.15 + *
    5.16 + * This software is provided "AS IS" with no warranty of any kind,
    5.17 + * express or implied, and with no claim as to its suitability for any
    5.18 + * purpose.
    5.19 + *
    5.20 + */
    5.21 +
    5.22 +/**
    5.23 +\mainpage @PACKAGE_NAME@ @PACKAGE_VERSION@ Documentation
    5.24 +
    5.25 +\section intro Introduction
    5.26 +
    5.27 +\subsection whatis What is LEMON
    5.28 +
    5.29 +LEMON stands for <b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling
    5.30 +and <b>O</b>ptimization in <b>N</b>etworks.
    5.31 +It is a C++ template
    5.32 +library aimed at combinatorial optimization tasks which
    5.33 +often involve in working
    5.34 +with graphs.
    5.35 +
    5.36 +<b>
    5.37 +LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    5.38 +project.
    5.39 +You are free to use it in your commercial or
    5.40 +non-commercial applications under very permissive
    5.41 +\ref license "license terms".
    5.42 +</b>
    5.43 +
    5.44 +\subsection howtoread How to read the documentation
    5.45 +
    5.46 +If you would like to get to know the library, see
    5.47 +<a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
    5.48 +
    5.49 +If you know what you are looking for, then try to find it under the
    5.50 +<a class="el" href="modules.html">Modules</a> section.
    5.51 +
    5.52 +If you are a user of the old (0.x) series of LEMON, please check out the
    5.53 +\ref migration "Migration Guide" for the backward incompatibilities.
    5.54 +*/