Commit Graph

14 Commits

Author SHA1 Message Date
Jean-Paul Chaput c5034a9156 Typo in CMakeLists.txt : AND instead of "and". 2018-06-06 23:22:18 +02:00
Jean-Paul Chaput 767407736d Add a fully generated documentation in the git repository.
* Change: In all tools supplying documentation, as we use some specific
    software to create the doc, they may not be available, or worse, be
    and incompatible version. So, by default, we install the files shipped
    with the git repository. To force a full doc rebuild, use the "--doc"
    flag of ccb.py.
2018-06-06 18:42:26 +02:00
Jean-Paul Chaput dda3f99fd8 Update documentation for compliance with doxygen 1.8.5.
When upgrading from doxygen 1.5.x to 1.8.5 the way the documentation
is generated has underwent many changes, particularly in the headers.
* Change: In <header.html>, must include the javascripts <jquery.js>
    and <dynsections.js>.
* In <CMakeLists.txt>, as the header is customized, doxygen seems not
    copy some files like the javascripts and some images (open.png,
    closed.png). So we copy them from doxygen installation and make
    the CMakeLists.txt install them. I hope they will not change too
    much in the future.
* In <doxyfile>, disable markdown support as it do not interpret
    correctly the formating we already adopted (with a left margin
    to put command into). Use HTML_EXTRA_STYLESHEET instead of
    HTML_STYLESHEET. Enable the index (DISABLE_INDEX=NO), for the
    top header. Enable dot for inheritance diagram. Set the
    EXAMPLE_PATH=. to include the synthetic hierarchy.
    Correct the tag inclusion (faulty path in some places).
* In <SoC.css>, create style for the new header generated by doxygen.
* In the documentation, move the synthetic hierarchy into a module.
2014-05-13 16:30:41 +02:00
Jean-Paul Chaput 5c593f4161 * ./vlsisapd/dtr:
- Change: Completly remove Name as std::string are shared, in library,
        boost::python, doxygen documentation & examples.
2012-03-26 15:39:08 +00:00
Damien Dupuis 052572a13d Adding documentation for placement tree. 2011-09-14 10:45:57 +00:00
Damien Dupuis 23d80412d5 Full documentation for spice parser / driver 2011-05-31 14:16:22 +00:00
Damien Dupuis eff3b09d2d Adding primary version of Spice parser/driver documentation. 2011-05-20 09:33:10 +00:00
Damien Dupuis a46c121d75 Problem of files' names generated on mac osx (case insensitive)
-> no more uppercase in pages' names
2011-04-04 11:19:04 +00:00
Damien Dupuis 4a5656041e Adding the OpenChams documentation (at last !)
Minor changes/corrections is other documentations.
2011-03-25 13:08:53 +00:00
Damien Dupuis c006a8d96b Name's operators are now available in python 2010-06-15 14:18:42 +00:00
Damien Dupuis c149c84b50 Forgot to document DTRException 2010-06-15 13:18:41 +00:00
Damien Dupuis 68ca57830b Adding DTR documentation 2010-06-15 13:12:13 +00:00
Damien Dupuis dd66d66741 Renaming examples executable (driveCif, driveAgds, driveCif.py ... instead of test in order to be able to differntiate driver vs parser) 2010-06-14 10:46:09 +00:00
Damien Dupuis f4537e017c CHANGES
* agds : 
       - all agds object now belong to AGDS namespace
       - 'Gds' has been removed from all filenames
     * cif
       - all cif objects now belong to CIF namespace
       - 'Cif' has been removed from all filenames
     * dtr
       - minor modifications in CMakeLists.txt since Boost Python is now used by other driver & parser

    ADDS
     * agds :
       - new python module
     * cif
       - new python module
     * doc
       - brand new doxygen documentation with 
           global presentation
           cif format (driver)
           agds format (driver)
           links & contacts
     * examples
       - examples files in C++ and Python for cif & agds drivers (others will follow)
2010-06-11 14:49:21 +00:00