- Move template.h to doc/.
authoralpar
Sun, 14 Nov 2004 13:15:46 +0000
changeset 991e619a466ca5d
parent 990 407e4d47fdd3
child 992 10d378f2821c
- Move template.h to doc/.
- Insert the license terms into the documentation.
- template.h now appears under the coding style documentation.
doc/Doxyfile
doc/coding_style.dox
doc/mainpage.dox
doc/template.h
src/lemon/template.h
     1.1 --- a/doc/Doxyfile	Sun Nov 14 11:16:36 2004 +0000
     1.2 +++ b/doc/Doxyfile	Sun Nov 14 13:15:46 2004 +0000
     1.3 @@ -430,6 +430,7 @@
     1.4                           coding_style.dox \
     1.5                           groups.dox \
     1.6                           namespaces.dox \
     1.7 +			 license.dox \
     1.8                           ../src/lemon \
     1.9                           ../src/lemon/concept \
    1.10                           ../src/test/test_tools.h
    1.11 @@ -470,7 +471,7 @@
    1.12  # directories that contain example code fragments that are included (see 
    1.13  # the \include command).
    1.14  
    1.15 -EXAMPLE_PATH           = ../src/demo
    1.16 +EXAMPLE_PATH           = ../src/demo ../LICENSE .
    1.17  
    1.18  # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
    1.19  # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
     2.1 --- a/doc/coding_style.dox	Sun Nov 14 11:16:36 2004 +0000
     2.2 +++ b/doc/coding_style.dox	Sun Nov 14 13:15:46 2004 +0000
     2.3 @@ -77,4 +77,10 @@
     2.4  ClassNameEndsWithException
     2.5  \endcode
     2.6  
     2.7 +\section header-template Template Header File
     2.8 +
     2.9 +Each Lemon header file should look like this:
    2.10 +
    2.11 +\include template.h
    2.12 +
    2.13  */
     3.1 --- a/doc/mainpage.dox	Sun Nov 14 11:16:36 2004 +0000
     3.2 +++ b/doc/mainpage.dox	Sun Nov 14 13:15:46 2004 +0000
     3.3 @@ -11,8 +11,14 @@
     3.4  It is a C++ template
     3.5  library aimed at combinatorial optimization tasks which
     3.6  often involve in working
     3.7 -with graphs. As the name also suggests, its development was started by
     3.8 -Hungarian people.
     3.9 +with graphs.
    3.10 +
    3.11 +<b>
    3.12 +LEMON is an <a href="http://opensource.org/">open source</a> project.
    3.13 +You are free to use it in your commertial or
    3.14 +non-commertial applications under very permissive
    3.15 +\ref license "license terms".
    3.16 +</b>
    3.17  
    3.18  \subsection howtoread How to read this document
    3.19  
     4.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.2 +++ b/doc/template.h	Sun Nov 14 13:15:46 2004 +0000
     4.3 @@ -0,0 +1,20 @@
     4.4 +/* -*- C++ -*-
     4.5 + * src/lemon/template.h - Part of LEMON, a generic C++ optimization library
     4.6 + *
     4.7 + * Copyright (C) 2004 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     4.8 + * (Egervary Combinatorial Optimization Research Group, EGRES).
     4.9 + *
    4.10 + * Permission to use, modify and distribute this software is granted
    4.11 + * provided that this copyright notice appears in all copies. For
    4.12 + * precise terms see the accompanying LICENSE file.
    4.13 + *
    4.14 + * This software is provided "AS IS" with no warranty of any kind,
    4.15 + * express or implied, and with no claim as to its suitability for any
    4.16 + * purpose.
    4.17 + *
    4.18 + */
    4.19 +
    4.20 +#ifndef LEMON_TEMPLATE_H
    4.21 +#define LEMON_TEMPLATE_H
    4.22 +
    4.23 +#endif // LEMON_TEMPLATE_H
     5.1 --- a/src/lemon/template.h	Sun Nov 14 11:16:36 2004 +0000
     5.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     5.3 @@ -1,20 +0,0 @@
     5.4 -/* -*- C++ -*-
     5.5 - * src/lemon/template.h - Part of LEMON, a generic C++ optimization library
     5.6 - *
     5.7 - * Copyright (C) 2004 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     5.8 - * (Egervary Combinatorial Optimization Research Group, EGRES).
     5.9 - *
    5.10 - * Permission to use, modify and distribute this software is granted
    5.11 - * provided that this copyright notice appears in all copies. For
    5.12 - * precise terms see the accompanying LICENSE file.
    5.13 - *
    5.14 - * This software is provided "AS IS" with no warranty of any kind,
    5.15 - * express or implied, and with no claim as to its suitability for any
    5.16 - * purpose.
    5.17 - *
    5.18 - */
    5.19 -
    5.20 -#ifndef LEMON_TEMPLATE_H
    5.21 -#define LEMON_TEMPLATE_H
    5.22 -
    5.23 -#endif // LEMON_TEMPLATE_H