Create table of contents (a preliminary version)
authorPeter Kovacs <kpeter@inf.elte.hu>
Sat, 11 Oct 2008 11:29:12 +0200
changeset 29388ccf86294
parent 1 264baaa990e1
child 3 0cf8882c7e7c
Create table of contents (a preliminary version)
Doxyfile
mainpage.dox
     1.1 --- a/Doxyfile	Sat Jul 12 22:38:15 2008 +0100
     1.2 +++ b/Doxyfile	Sat Oct 11 11:29:12 2008 +0200
     1.3 @@ -1,4 +1,4 @@
     1.4 -# Doxyfile 1.5.5
     1.5 +# Doxyfile 1.5.7.1
     1.6  
     1.7  #---------------------------------------------------------------------------
     1.8  # Project related configuration options
     1.9 @@ -21,7 +21,6 @@
    1.10  JAVADOC_AUTOBRIEF      = NO
    1.11  QT_AUTOBRIEF           = NO
    1.12  MULTILINE_CPP_IS_BRIEF = NO
    1.13 -DETAILS_AT_TOP         = YES
    1.14  INHERIT_DOCS           = NO
    1.15  SEPARATE_MEMBER_PAGES  = NO
    1.16  TAB_SIZE               = 8
    1.17 @@ -33,9 +32,11 @@
    1.18  BUILTIN_STL_SUPPORT    = YES
    1.19  CPP_CLI_SUPPORT        = NO
    1.20  SIP_SUPPORT            = NO
    1.21 +IDL_PROPERTY_SUPPORT   = YES
    1.22  DISTRIBUTE_GROUP_DOC   = NO
    1.23  SUBGROUPING            = YES
    1.24  TYPEDEF_HIDES_STRUCT   = NO
    1.25 +SYMBOL_CACHE_SIZE      = 0
    1.26  #---------------------------------------------------------------------------
    1.27  # Build related configuration options
    1.28  #---------------------------------------------------------------------------
    1.29 @@ -64,9 +65,12 @@
    1.30  GENERATE_DEPRECATEDLIST= YES
    1.31  ENABLED_SECTIONS       = 
    1.32  MAX_INITIALIZER_LINES  = 5
    1.33 -SHOW_USED_FILES        = YES
    1.34 -SHOW_DIRECTORIES       = YES
    1.35 +SHOW_USED_FILES        = NO
    1.36 +SHOW_DIRECTORIES       = NO
    1.37 +SHOW_FILES             = NO
    1.38 +SHOW_NAMESPACES        = NO
    1.39  FILE_VERSION_FILTER    = 
    1.40 +LAYOUT_FILE            = 
    1.41  #---------------------------------------------------------------------------
    1.42  # configuration options related to warning and progress messages
    1.43  #---------------------------------------------------------------------------
    1.44 @@ -75,12 +79,12 @@
    1.45  WARN_IF_UNDOCUMENTED   = YES
    1.46  WARN_IF_DOC_ERROR      = YES
    1.47  WARN_NO_PARAMDOC       = NO
    1.48 -WARN_FORMAT            = "$file:$line: $text  "
    1.49 +WARN_FORMAT            = "$file:$line: $text"
    1.50  WARN_LOGFILE           = doxygen.log
    1.51  #---------------------------------------------------------------------------
    1.52  # configuration options related to the input files
    1.53  #---------------------------------------------------------------------------
    1.54 -INPUT                  = . \
    1.55 +INPUT                  = ./ \
    1.56                           ./demo
    1.57  INPUT_ENCODING         = UTF-8
    1.58  FILE_PATTERNS          = *.h \
    1.59 @@ -91,12 +95,11 @@
    1.60  EXCLUDE_SYMLINKS       = NO
    1.61  EXCLUDE_PATTERNS       = 
    1.62  EXCLUDE_SYMBOLS        = 
    1.63 -EXAMPLE_PATH           = ./demo \
    1.64 -                         ./doc
    1.65 +EXAMPLE_PATH           = ./demo
    1.66  EXAMPLE_PATTERNS       = 
    1.67  EXAMPLE_RECURSIVE      = NO
    1.68  IMAGE_PATH             = ./images \
    1.69 -		       	 ./gen-images
    1.70 +                         ./gen-images
    1.71  INPUT_FILTER           = 
    1.72  FILTER_PATTERNS        = 
    1.73  FILTER_SOURCE_FILES    = NO
    1.74 @@ -127,20 +130,27 @@
    1.75  HTML_FOOTER            = 
    1.76  HTML_STYLESHEET        = 
    1.77  HTML_ALIGN_MEMBERS     = YES
    1.78 -GENERATE_HTMLHELP      = NO
    1.79 +HTML_DYNAMIC_SECTIONS  = NO
    1.80  GENERATE_DOCSET        = NO
    1.81  DOCSET_FEEDNAME        = "Doxygen generated docs"
    1.82  DOCSET_BUNDLE_ID       = org.doxygen.Project
    1.83 -HTML_DYNAMIC_SECTIONS  = NO
    1.84 +GENERATE_HTMLHELP      = NO
    1.85  CHM_FILE               = 
    1.86  HHC_LOCATION           = 
    1.87  GENERATE_CHI           = NO
    1.88 +CHM_INDEX_ENCODING     = 
    1.89  BINARY_TOC             = NO
    1.90  TOC_EXPAND             = NO
    1.91 +GENERATE_QHP           = NO
    1.92 +QCH_FILE               = 
    1.93 +QHP_NAMESPACE          = org.doxygen.Project
    1.94 +QHP_VIRTUAL_FOLDER     = doc
    1.95 +QHG_LOCATION           = 
    1.96  DISABLE_INDEX          = NO
    1.97  ENUM_VALUES_PER_LINE   = 4
    1.98  GENERATE_TREEVIEW      = NO
    1.99  TREEVIEW_WIDTH         = 250
   1.100 +FORMULA_FONTSIZE       = 10
   1.101  #---------------------------------------------------------------------------
   1.102  # configuration options related to the LaTeX output
   1.103  #---------------------------------------------------------------------------
   1.104 @@ -208,7 +218,7 @@
   1.105  # Configuration::additions related to external references   
   1.106  #---------------------------------------------------------------------------
   1.107  TAGFILES               = "./doc/libstdc++.tag = http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/ " \
   1.108 -		         "./lemon.tag = http://lemon.cs.elte.hu/pub/doc/latest/ "
   1.109 +                         "./lemon.tag = http://lemon.cs.elte.hu/pub/doc/latest/ "
   1.110  GENERATE_TAGFILE       = 
   1.111  ALLEXTERNALS           = NO
   1.112  EXTERNAL_GROUPS        = NO
   1.113 @@ -220,6 +230,9 @@
   1.114  MSCGEN_PATH            = 
   1.115  HIDE_UNDOC_RELATIONS   = YES
   1.116  HAVE_DOT               = YES
   1.117 +DOT_FONTNAME           = FreeSans
   1.118 +DOT_FONTSIZE           = 10
   1.119 +DOT_FONTPATH           = 
   1.120  CLASS_GRAPH            = YES
   1.121  COLLABORATION_GRAPH    = NO
   1.122  GROUP_GRAPHS           = NO
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/mainpage.dox	Sat Oct 11 11:29:12 2008 +0200
     2.3 @@ -0,0 +1,96 @@
     2.4 +/* -*- mode: C++; indent-tabs-mode: nil; -*-
     2.5 + *
     2.6 + * This file is a part of LEMON, a generic C++ optimization library.
     2.7 + *
     2.8 + * Copyright (C) 2003-2008
     2.9 + * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
    2.10 + * (Egervary Research Group on Combinatorial Optimization, EGRES).
    2.11 + *
    2.12 + * Permission to use, modify and distribute this software is granted
    2.13 + * provided that this copyright notice appears in all copies. For
    2.14 + * precise terms see the accompanying LICENSE file.
    2.15 + *
    2.16 + * This software is provided "AS IS" with no warranty of any kind,
    2.17 + * express or implied, and with no claim as to its suitability for any
    2.18 + * purpose.
    2.19 + *
    2.20 + */
    2.21 +
    2.22 +namespace lemon {
    2.23 +/**
    2.24 +\mainpage LEMON Tutorial
    2.25 +
    2.26 +<h2>Table of Contents</h2>
    2.27 +
    2.28 +<ol>
    2.29 +  <li>\ref intro "Introduction"</li>
    2.30 +  <li>\ref getting_started "Getting Started"</li>
    2.31 +  <ul>
    2.32 +    <li>\ref hello_lemon "Compile Your First Code"</li>
    2.33 +    <ul>
    2.34 +      <li>\ref hello_lemon_system "If LEMON is Installed System-Wide"</li>
    2.35 +      <li>\ref hello_lemon_user "If LEMON is Installed User-Local"</li>
    2.36 +      <ul>
    2.37 +        <li>\ref hello_lemon_pkg_config "Use pkg-config"</li>
    2.38 +      </ul>
    2.39 +    </ul>
    2.40 +  </ul>
    2.41 +  <li>\ref basic_concepts "Basic Concepts"</li>
    2.42 +  <ul>
    2.43 +    <li>\ref digraph_build "Build and Modify a Digraph"</li>
    2.44 +    <li>\ref digraph_iterate "Iterate Over the Elements"</li>
    2.45 +    <li>\ref standard_maps "Maps - Assign Data to Graphs"</li>
    2.46 +    <li>\ref algorithms "Algorithms"</li>
    2.47 +    <ul>
    2.48 +      <li>\ref alg_bfs_dfs "BFS, DFS - Graph Search"</li>
    2.49 +      <li>\ref alg_dijkstra "Dijkstra - Shorthest Path"</li>
    2.50 +      <li>\ref alg_kruskal "Kruskal - Minimum Spanning Tree"</li>
    2.51 +    </ul>
    2.52 +    <li>\ref undir_graphs "Undirected Graphs"</li>
    2.53 +  </ul>
    2.54 +  <li>\ref tools "Some Important Auxiliary Tools"</li>
    2.55 +  <ul>
    2.56 +    <li>\ref lgf "LEMON Graph Format"</li>
    2.57 +    <ul>
    2.58 +      <li>\ref glemon "gLemon - A Graph Editor for LEMON"</li>
    2.59 +    </ul>
    2.60 +    <li>\ref graph_to_eps "GraphToEps - Postscript Exporting"</li>
    2.61 +    <li>\ref time_count "Time Measuring and Counting"</li>
    2.62 +    <li>\ref random "Random Numbers"</li>
    2.63 +  </ul>
    2.64 +  <li>\ref advanced "Advanced Topics"</li>
    2.65 +  <ul>
    2.66 +    <li>\ref maps "Maps"</li>
    2.67 +    <ul>
    2.68 +      <li>\ref map_concepts "Read/Write/Reference Maps"</li>
    2.69 +      <li>\ref custom_maps "Custom Maps"</li>
    2.70 +      <li>\ref map_adaptors "Map Adaptors"</li>
    2.71 +      <li>\ref special_maps "Other Special Purpose Maps"</li>
    2.72 +    </ul>
    2.73 +    <li>\ref graphs "Graphs"</li>
    2.74 +    <ul>
    2.75 +      <li>\ref graph_adaptors "Graph Adaptors"</li>
    2.76 +      <li>\ref special_graphs "Special Graph Structures"</li>
    2.77 +    </ul>
    2.78 +    <li>\ref named_params "Named Parameters"</li>
    2.79 +    <ul>
    2.80 +      <li>\ref alg_named_params "Customizing Algorithms"</li>
    2.81 +    </ul>
    2.82 +  </ul>
    2.83 +  <li>\ref lp "LP and MIP Solvers"</li>
    2.84 +  <li>\ref appendix "Appendix"</li>
    2.85 +  <ul>
    2.86 +    <li>\ref install "Install LEMON"</li>
    2.87 +    <ul>
    2.88 +      <li>\ref install_system "Install System Wide"</li>
    2.89 +      <ul>
    2.90 +        <li>\ref install_system_source "From Source"</li>
    2.91 +        <li>\ref install_system_rpm "From rpm"</li>
    2.92 +      </ul>
    2.93 +      <li>\ref install_user "Install Locally to the User"</li>
    2.94 +    </ul>
    2.95 +  </ul>
    2.96 +</ol>
    2.97 +
    2.98 +*/
    2.99 +}