github.com/wfjm.w11
1
0
Fork 0
mirror of https://github.com/wfjm/w11.git synced 2026-01-13 15:37:43 +00:00
Code Issues Releases Wiki Activity
wfjm.w11/tools/dox
History
wfjm 9ca20e39ac get ready for V0.792 
- rtl/w11a/tb/
  - tbrun.yml: retire last tb_pdp11core_stim.dat based test
  - tb_pdp11core_stim.dat: remove file, now unused and obsolete
- tools/tcode/tcode.ecmd: ensure that unibus map window is not memory
- tools/dox/*.Doxyfile: up version
2022-10-25 09:25:36 +02:00
..
.gitignore
rename .cvsignore -> .gitignore
2016-12-17 16:28:37 +01:00
make_doxy
Doxygen support now for V1.9.4 [skip ci]
2022-05-14 11:42:33 +02:00
README.md
add missing man pages [skip ci]
2022-05-15 11:52:11 +02:00
w11_cpp.Doxyfile
get ready for V0.792
2022-10-25 09:25:36 +02:00
w11_vhd_all.Doxyfile
get ready for V0.792
2022-10-25 09:25:36 +02:00

README.md

This directory holds the doxygen setup files for VHDL and C++ documentation.

Currently there is not much real documentation included in the source files. The doxygen generated html output is nevertheless very useful to browse and navigate through the source code. C++ and Vhdl source are covered by setup files contained in this directory.

The doxygen generated source code view of the latest release is directly available from

To locally generate the html files use

  cd $RETROBASE/tools/dox
  export RETRODOXY <desired root of html documentation>
  ./make_doxy

If RETRODOXY is not defined /tmp is used. To view the top level of the generated doxygen output use

  firefox $RETRODOXY/w11/cpp/html/index.html &
  firefox $RETRODOXY/w11/vhd/html/index.html &

Better entry points for code navigation are

  firefox $RETRODOXY/w11/vhd/html/hierarchy.html
  firefox $RETRODOXY/w11/vhd/html/sys__w11a__arty_8vhd_source.html
  firefox $RETRODOXY/w11/cpp/html/hierarchy.html