riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
coriolis/bootstrap/cpDox.sh

34 lines
1.1 KiB
Bash
Raw Permalink Normal View History

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 09:30:41 -05:00
#!/bin/sh
confFiles=""
Correction of SoC.css, adjust the look of the class index big letters.
2014-06-09 17:04:48 -05:00
#confFiles="${confFiles} open.png"
#confFiles="${confFiles} closed.png"
#confFiles="${confFiles} jquery.js"
#confFiles="${confFiles} dynsections.js"
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 09:30:41 -05:00
confFiles="${confFiles} SoC.css"
Correction of SoC.css, adjust the look of the class index big letters.
2014-06-09 17:04:48 -05:00
#confFiles="${confFiles} header.html"
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 09:30:41 -05:00
rootDir="${HOME}/coriolis-2.x/src/coriolis"
sourceToolDoc="${rootDir}/hurricane/doc/hurricane"
toolDocs=""
toolDocs="${toolDocs} ${rootDir}/hurricane/doc/viewer"
toolDocs="${toolDocs} ${rootDir}/crlcore/doc/crlcore"
toolDocs="${toolDocs} ${rootDir}/katabatic/doc"
toolDocs="${toolDocs} ${rootDir}/kite/doc"
toolDocs="${toolDocs} ${rootDir}/unicorn/doc/unicorn"
for toolDoc in $toolDocs; do
echo "- $toolDoc"
if [ -d "$toolDoc" ]; then
for file in $confFiles; do
cp "${sourceToolDoc}/${file}" "${toolDoc}/${file}"
done
else
echo "[ERROR] Tool <${toolDoc}> doesn't exist."
fi
done
echo "Do not forget to edit CMakeLists.txt, customSummary.html, header.html"
echo "& doxyfile then create a \\mainpage in the documentation."
echo " DISABLE_INDEX = NO"
exit 0