Started to change documentation with excellent new ideas!!!
authorathos
Tue, 22 Feb 2005 10:29:21 +0000
changeset 11698b06fbd5712c
parent 1168 66400041ef2a
child 1170 fb0159aa582d
Started to change documentation with excellent new ideas!!!
doc/demoprograms.dox
doc/mainpage.dox
doc/mainpage1.dox
doc/quicktour.dox
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/demoprograms.dox	Tue Feb 22 10:29:21 2005 +0000
     1.3 @@ -0,0 +1,3 @@
     1.4 +/**
     1.5 +
     1.6 +*/
     1.7 \ No newline at end of file
     2.1 --- a/doc/mainpage.dox	Tue Feb 22 10:23:32 2005 +0000
     2.2 +++ b/doc/mainpage.dox	Tue Feb 22 10:29:21 2005 +0000
     2.3 @@ -10,7 +10,7 @@
     2.4  and <b>O</b>ptimization in <b>N</b>etworks.
     2.5  It is a C++ template
     2.6  library aimed at combinatorial optimization tasks which
     2.7 -often involve in working
     2.8 +often involve working
     2.9  with graphs.
    2.10  
    2.11  <b>
    2.12 @@ -21,18 +21,20 @@
    2.13  \ref license "license terms".
    2.14  </b>
    2.15  
    2.16 -\subsection howtoread How to read this document
    2.17 +\subsection howtoread How to read the documentation
    2.18  
    2.19 -\ref graphs "Graph structures"
    2.20 -play central role in LEMON, so if you are new to it,
    2.21 -you probably should start \ref graphs "here".
    2.22 -You can also find this page along with others under
    2.23 -<a class="el" href="pages.html"> Related Pages </a>.
    2.24 +If you want to get a quick start and see the most important features then 
    2.25 +take a look at our \ref quicktour
    2.26 +"Quick Tour to LEMON" which will guide you along.
    2.27  
    2.28 -If you are 
    2.29 -interested about data structures and algorithms in more details, then
    2.30 -you should browse the reference manual part of the documentation.
    2.31 -Section <a class="el" href="modules.html"> Modules </a>
    2.32 - is a good starting point for this.
    2.33 +If you 
    2.34 +want to see how LEMON works, see 
    2.35 +some \ref demoprograms demo programs!
    2.36 +
    2.37 +If you are looking for a specific thing then try to find it in the index or 
    2.38 +in the contents.
    2.39 +If you know what you are looking for then try to find it in the index or 
    2.40 +in the table of contents.
    2.41 +
    2.42  
    2.43  */
     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/doc/mainpage1.dox	Tue Feb 22 10:29:21 2005 +0000
     3.3 @@ -0,0 +1,37 @@
     3.4 +/**
     3.5 +\mainpage LEMON Documentation
     3.6 +
     3.7 +\section intro Introduction
     3.8 +
     3.9 +\subsection whatis What is LEMON
    3.10 +
    3.11 +LEMON stands for
    3.12 +<b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels
    3.13 +and <b>O</b>ptimization in <b>N</b>etworks.
    3.14 +It is a C++ template
    3.15 +library aimed at combinatorial optimization tasks which
    3.16 +often involve in working with graphs.
    3.17 +
    3.18 +<b>
    3.19 +LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    3.20 +project.
    3.21 +You are free to use it in your commercial or
    3.22 +non-commercial applications under very permissive
    3.23 +\ref license "license terms".
    3.24 +</b>
    3.25 +
    3.26 +\subsection howtoread How to read this document
    3.27 +
    3.28 +\ref graphs "Graph structures"
    3.29 +play central role in LEMON, so if you are new to it,
    3.30 +you probably should start \ref graphs "here".
    3.31 +You can also find this page along with others under
    3.32 +<a class="el" href="pages.html"> Related Pages </a>.
    3.33 +
    3.34 +If you are 
    3.35 +interested in data structures and algorithms in more details, then
    3.36 +you should browse the reference manual part of the documentation.
    3.37 +Section <a class="el" href="modules.html"> Modules </a>
    3.38 + is a good starting point for this.
    3.39 +
    3.40 +*/
     4.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.2 +++ b/doc/quicktour.dox	Tue Feb 22 10:29:21 2005 +0000
     4.3 @@ -0,0 +1,14 @@
     4.4 +/**
     4.5 +
     4.6 +\ref graphs "Graph structures"
     4.7 +play a central role in LEMON, so if you are new to it,
     4.8 +you probably should start \ref graphs "here".
     4.9 +You can also find that page along with others under
    4.10 +<a class="el" href="pages.html"> Related Pages </a>.
    4.11 +
    4.12 +If you are 
    4.13 +interested in data structures and algorithms in more details, then
    4.14 +you should browse the reference manual part of the documentation.
    4.15 +Section <a class="el" href="modules.html"> Modules </a>
    4.16 + is a good starting point for this.
    4.17 +*/
    4.18 \ No newline at end of file