Changes between Version 15 and Version 16 of user-directories


Ignore:
Timestamp:
Feb 13, 2011 9:34:04 AM (9 years ago)
Author:
stefan
Comment:

update directory structure of Clp; update to changes in doxydoc

Legend:

Unmodified
Added
Removed
Modified
  • user-directories

    v15 v16  
    2626 |
    2727 |---------- Data
    28  |            |--- Netlib
    29  |            |--- Samples
    30  |            |---  ...
     28 |            ---- Sample
    3129 |
    3230 |---------- ThirdParty
    33  |            |--- ASL
    34  |            |--- ...
     31 |            |--- Blas
     32 |            |--- Lapack
    3533 |
    3634 |---------- CoinUtils
     35 |            |--- doxydoc
     36 |            |--- inc
     37 |            |--- MSVisualStudio
    3738 |            |--- src
     39 |            |--- test
     40 |
     41 |---------- Osi
     42 |            |--- doxydoc
     43 |            |--- examples
    3844 |            |--- inc
    39  |            |--- test
    4045 |            |--- MSVisualStudio
    41  |                  |--- v6
    42  |                  |--- v7
    43  |                  ---- v8
    44  |            |--- [doc]      ([ ] means currently missing)
    45  |            ---- [examples]
     46 |            |--- src
     47 |            ---- test
    4648 |
    4749 |---------- Clp
     50 |            |--- doc
     51 |            |--- doxydoc
     52 |            |--- examples
     53 |            |--- inc
     54 |            |--- MSVisualStudio
     55 |            |     |--- v6
     56 |            |     |--- v7
     57 |            |     |--- v8
     58 |            |     |--- v9
     59 |            |     ---- v9alt
    4860 |            |--- src
    49  |            |--- inc
    50  |            |--- test
    51  |            |--- MSVisualStudio
    52  |                  |--- v6
    53  |                  |--- v7
    54  |                  ---- v8
    55  |            |--- [doc]
    56  |            ---- examples
     61 |            |     ---- OsiClp
     62 |            ---- test
    5763 |
    5864 ----------- doxydoc
     
    6874The '''!ThirdParty''' subdirectory (not present for all COIN-OR packages) contains further subdirectories, in which additional third party code can/has to be copied.  For more information check the packages documentation and read the {{{INSTALL}}} files in the subdirectories.
    6975
    70 Also, for packages containing C++ code, you will find a '''doxydoc''' subdirectory.  This contains a configuration script for the {{{doxygen}}} utility, which generates HTML documentation of the source code.  Once you have the package configured, you can create this documentation with {{{make doxydox}}} (assuming that you have {{{doxygen}}} installed).  The final documentation will be in {{{doxydoc/html}}}.
     76Also, for packages containing C/C++ code, you may find '''doxydoc''' subdirectories.  These contain configuration scripts for the {{{doxygen}}} utility, which generates HTML documentation of the source code.  Once you have the package configured, you can create this documentation with {{{make doxydoc}}} (assuming that you have {{{doxygen}}} installed).  The final documentation will be in {{{doxydoc/html}}}.
    7177
    72 For each COIN-OR project that is required to build the desired packages, you will find a '''project subdirectory''' in the base directory.  In the main subdirectory for each project (above {{{CoinUtils}}} and {{{Clp}}}) resides the configuration script for this project, as well as the main Makefile.  However, you should not run those configuration scripts from these subdirectories; use the configuration scripts from the base directory instead.  In the main directory for each project you find also package-specific information such as a README and AUTHORS file.
     78For each COIN-OR project that is required to build the desired packages, you will find a '''project subdirectory''' in the base directory.  In the main subdirectory for each project (above {{{CoinUtils}}}, {{{Clp}}}, and {{{Osi}}}) resides the configuration script for this project, as well as the main Makefile.  However, you should not run those configuration scripts from these subdirectories; use the configuration scripts from the base directory instead.  In the main directory for each project you find also package-specific information such as a README and AUTHORS file.
    7379
    7480If the project manager of a COIN-OR project follows our suggested directory structure, you will find the '''following subdirectories in the project's main subdirectory''' (e.g., in {{{Clp}}} or {{{CoinUtils}}} above):
     
    8086 * '''test''': We ask project maintainers to provide some test program(s) to be able to verify a successful compilation, so that a user can test that everything is working fine, before (s)he installs the libraries and other files.  The code and possibly some data files for this unit test are located here.
    8187
    82  * '''MSVisualStudio''': If present, the subdirectories contain project files for the MS Developer Studio.  The {{{v6}}}, {{{v7}}}, and {{{v8}}} subdirectories pertain to versions 6, 7, and 8 of the Developer Studio. For details on this, visit the [http://projects.coin-or.org/MSVisualStudio MSVisualStudio home page].
     88 * '''MSVisualStudio''': If present, the subdirectories contain project files for the MS Developer Studio.  The {{{v6}}}, {{{v7}}}, {{{v8}}}, {{{v9}}}, and {{{v9alt}}} subdirectories pertain to versions 6, 7, 8, 9, and 9 of the Developer Studio.
    8389
    8490 * '''doc''': If documentation is provided for this COIN-OR project, it should be found here.
     91
     92 * '''doxydoc''': If the project contains C/C++ code, the {{{doxygen}}} configuation file is used to generate HTML documentation of the source code. The documentation generated here is used by the package's {{{doxygen}}} to generate a documentation for the whole package.
    8593
    8694 * '''examples''': A package might contain some source code examples, for example to demonstrate how a user of a library can hook up his/her own code to the library.  The source files, an example Makefile, and further information for this can be found here.