COIN-OR::LEMON - Graph Library

Ticket #162: toc_9388ccf86294.patch

File toc_9388ccf86294.patch, 7.7 KB (added by Peter Kovacs, 12 years ago)
  • Doxyfile

    # HG changeset patch
    # User Peter Kovacs <kpeter@inf.elte.hu>
    # Date 1223717352 -7200
    # Node ID 9388ccf862943f75a0a3ef1f0486a77ea59ad180
    # Parent  264baaa990e105a7449954c154e74f79595b5d87
    Create table of contents (a preliminary version)
    
    diff --git a/Doxyfile b/Doxyfile
    a b  
    1 # Doxyfile 1.5.5
     1# Doxyfile 1.5.7.1
    22
    33#---------------------------------------------------------------------------
    44# Project related configuration options
     
    2121JAVADOC_AUTOBRIEF      = NO
    2222QT_AUTOBRIEF           = NO
    2323MULTILINE_CPP_IS_BRIEF = NO
    24 DETAILS_AT_TOP         = YES
    2524INHERIT_DOCS           = NO
    2625SEPARATE_MEMBER_PAGES  = NO
    2726TAB_SIZE               = 8
     
    3332BUILTIN_STL_SUPPORT    = YES
    3433CPP_CLI_SUPPORT        = NO
    3534SIP_SUPPORT            = NO
     35IDL_PROPERTY_SUPPORT   = YES
    3636DISTRIBUTE_GROUP_DOC   = NO
    3737SUBGROUPING            = YES
    3838TYPEDEF_HIDES_STRUCT   = NO
     39SYMBOL_CACHE_SIZE      = 0
    3940#---------------------------------------------------------------------------
    4041# Build related configuration options
    4142#---------------------------------------------------------------------------
     
    6465GENERATE_DEPRECATEDLIST= YES
    6566ENABLED_SECTIONS       =
    6667MAX_INITIALIZER_LINES  = 5
    67 SHOW_USED_FILES        = YES
    68 SHOW_DIRECTORIES       = YES
     68SHOW_USED_FILES        = NO
     69SHOW_DIRECTORIES       = NO
     70SHOW_FILES             = NO
     71SHOW_NAMESPACES        = NO
    6972FILE_VERSION_FILTER    =
     73LAYOUT_FILE            =
    7074#---------------------------------------------------------------------------
    7175# configuration options related to warning and progress messages
    7276#---------------------------------------------------------------------------
     
    7579WARN_IF_UNDOCUMENTED   = YES
    7680WARN_IF_DOC_ERROR      = YES
    7781WARN_NO_PARAMDOC       = NO
    78 WARN_FORMAT            = "$file:$line: $text  "
     82WARN_FORMAT            = "$file:$line: $text"
    7983WARN_LOGFILE           = doxygen.log
    8084#---------------------------------------------------------------------------
    8185# configuration options related to the input files
    8286#---------------------------------------------------------------------------
    83 INPUT                  = . \
     87INPUT                  = ./ \
    8488                         ./demo
    8589INPUT_ENCODING         = UTF-8
    8690FILE_PATTERNS          = *.h \
     
    9195EXCLUDE_SYMLINKS       = NO
    9296EXCLUDE_PATTERNS       =
    9397EXCLUDE_SYMBOLS        =
    94 EXAMPLE_PATH           = ./demo \
    95                          ./doc
     98EXAMPLE_PATH           = ./demo
    9699EXAMPLE_PATTERNS       =
    97100EXAMPLE_RECURSIVE      = NO
    98101IMAGE_PATH             = ./images \
    99                         ./gen-images
     102                        ./gen-images
    100103INPUT_FILTER           =
    101104FILTER_PATTERNS        =
    102105FILTER_SOURCE_FILES    = NO
     
    127130HTML_FOOTER            =
    128131HTML_STYLESHEET        =
    129132HTML_ALIGN_MEMBERS     = YES
    130 GENERATE_HTMLHELP      = NO
     133HTML_DYNAMIC_SECTIONS  = NO
    131134GENERATE_DOCSET        = NO
    132135DOCSET_FEEDNAME        = "Doxygen generated docs"
    133136DOCSET_BUNDLE_ID       = org.doxygen.Project
    134 HTML_DYNAMIC_SECTIONS  = NO
     137GENERATE_HTMLHELP      = NO
    135138CHM_FILE               =
    136139HHC_LOCATION           =
    137140GENERATE_CHI           = NO
     141CHM_INDEX_ENCODING     =
    138142BINARY_TOC             = NO
    139143TOC_EXPAND             = NO
     144GENERATE_QHP           = NO
     145QCH_FILE               =
     146QHP_NAMESPACE          = org.doxygen.Project
     147QHP_VIRTUAL_FOLDER     = doc
     148QHG_LOCATION           =
    140149DISABLE_INDEX          = NO
    141150ENUM_VALUES_PER_LINE   = 4
    142151GENERATE_TREEVIEW      = NO
    143152TREEVIEW_WIDTH         = 250
     153FORMULA_FONTSIZE       = 10
    144154#---------------------------------------------------------------------------
    145155# configuration options related to the LaTeX output
    146156#---------------------------------------------------------------------------
     
    208218# Configuration::additions related to external references   
    209219#---------------------------------------------------------------------------
    210220TAGFILES               = "./doc/libstdc++.tag = http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/ " \
    211                          "./lemon.tag = http://lemon.cs.elte.hu/pub/doc/latest/ "
     221                         "./lemon.tag = http://lemon.cs.elte.hu/pub/doc/latest/ "
    212222GENERATE_TAGFILE       =
    213223ALLEXTERNALS           = NO
    214224EXTERNAL_GROUPS        = NO
     
    220230MSCGEN_PATH            =
    221231HIDE_UNDOC_RELATIONS   = YES
    222232HAVE_DOT               = YES
     233DOT_FONTNAME           = FreeSans
     234DOT_FONTSIZE           = 10
     235DOT_FONTPATH           =
    223236CLASS_GRAPH            = YES
    224237COLLABORATION_GRAPH    = NO
    225238GROUP_GRAPHS           = NO
  • new file mainpage.dox

    diff --git a/mainpage.dox b/mainpage.dox
    new file mode 100644
    - +  
     1/* -*- mode: C++; indent-tabs-mode: nil; -*-
     2 *
     3 * This file is a part of LEMON, a generic C++ optimization library.
     4 *
     5 * Copyright (C) 2003-2008
     6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8 *
     9 * Permission to use, modify and distribute this software is granted
     10 * provided that this copyright notice appears in all copies. For
     11 * precise terms see the accompanying LICENSE file.
     12 *
     13 * This software is provided "AS IS" with no warranty of any kind,
     14 * express or implied, and with no claim as to its suitability for any
     15 * purpose.
     16 *
     17 */
     18
     19namespace lemon {
     20/**
     21\mainpage LEMON Tutorial
     22
     23<h2>Table of Contents</h2>
     24
     25<ol>
     26  <li>\ref intro "Introduction"</li>
     27  <li>\ref getting_started "Getting Started"</li>
     28  <ul>
     29    <li>\ref hello_lemon "Compile Your First Code"</li>
     30    <ul>
     31      <li>\ref hello_lemon_system "If LEMON is Installed System-Wide"</li>
     32      <li>\ref hello_lemon_user "If LEMON is Installed User-Local"</li>
     33      <ul>
     34        <li>\ref hello_lemon_pkg_config "Use pkg-config"</li>
     35      </ul>
     36    </ul>
     37  </ul>
     38  <li>\ref basic_concepts "Basic Concepts"</li>
     39  <ul>
     40    <li>\ref digraph_build "Build and Modify a Digraph"</li>
     41    <li>\ref digraph_iterate "Iterate Over the Elements"</li>
     42    <li>\ref standard_maps "Maps - Assign Data to Graphs"</li>
     43    <li>\ref algorithms "Algorithms"</li>
     44    <ul>
     45      <li>\ref alg_bfs_dfs "BFS, DFS - Graph Search"</li>
     46      <li>\ref alg_dijkstra "Dijkstra - Shorthest Path"</li>
     47      <li>\ref alg_kruskal "Kruskal - Minimum Spanning Tree"</li>
     48    </ul>
     49    <li>\ref undir_graphs "Undirected Graphs"</li>
     50  </ul>
     51  <li>\ref tools "Some Important Auxiliary Tools"</li>
     52  <ul>
     53    <li>\ref lgf "LEMON Graph Format"</li>
     54    <ul>
     55      <li>\ref glemon "gLemon - A Graph Editor for LEMON"</li>
     56    </ul>
     57    <li>\ref graph_to_eps "GraphToEps - Postscript Exporting"</li>
     58    <li>\ref time_count "Time Measuring and Counting"</li>
     59    <li>\ref random "Random Numbers"</li>
     60  </ul>
     61  <li>\ref advanced "Advanced Topics"</li>
     62  <ul>
     63    <li>\ref maps "Maps"</li>
     64    <ul>
     65      <li>\ref map_concepts "Read/Write/Reference Maps"</li>
     66      <li>\ref custom_maps "Custom Maps"</li>
     67      <li>\ref map_adaptors "Map Adaptors"</li>
     68      <li>\ref special_maps "Other Special Purpose Maps"</li>
     69    </ul>
     70    <li>\ref graphs "Graphs"</li>
     71    <ul>
     72      <li>\ref graph_adaptors "Graph Adaptors"</li>
     73      <li>\ref special_graphs "Special Graph Structures"</li>
     74    </ul>
     75    <li>\ref named_params "Named Parameters"</li>
     76    <ul>
     77      <li>\ref alg_named_params "Customizing Algorithms"</li>
     78    </ul>
     79  </ul>
     80  <li>\ref lp "LP and MIP Solvers"</li>
     81  <li>\ref appendix "Appendix"</li>
     82  <ul>
     83    <li>\ref install "Install LEMON"</li>
     84    <ul>
     85      <li>\ref install_system "Install System Wide"</li>
     86      <ul>
     87        <li>\ref install_system_source "From Source"</li>
     88        <li>\ref install_system_rpm "From rpm"</li>
     89      </ul>
     90      <li>\ref install_user "Install Locally to the User"</li>
     91    </ul>
     92  </ul>
     93</ol>
     94
     95*/
     96}