doc/mainpage.dox
author alpar
Tue, 06 Jul 2004 11:28:20 +0000
changeset 696 48aa9ace1d7d
parent 670 e45bf7830d8c
child 921 818510fa3d99
permissions -rw-r--r--
Example in the doc is corrected.
     1 /**
     2 \mainpage
     3 
     4 \section intro Introduction
     5 
     6 \subsection whatis What is HugoLib
     7 
     8 HugoLib stands for Hungarian Graph Optimization Library.
     9 It is a C++ template
    10 library aimed at combinatorial optimization tasks which
    11 often involve in working
    12 with graphs. As the name also suggests, its development was started by
    13 Hungarian people.
    14 
    15 \subsection howtoread How to read this document
    16 
    17 Graph structures play central role in HugoLib, so if you are new to it,
    18 you probably should start \ref graphs "here".
    19 You can also find this page along with others under
    20 <a href="pages.html"> Related Pages </a>
    21 (left-hand
    22 side frame).
    23 
    24 If you are more
    25 interested in details about data structures and algorithms then
    26 you should browse the reference manual part of the documentation.
    27 Section <a href="modules.html"> Modules </a>
    28  is a good starting point for this.
    29 
    30 */