FAQ: [Q] how to generate doxygen documentation for tradelink

[Dmitry Shevkoplyas]

hi all,

[A] to generate doxygen docs for tradelink we'd:

1) on fresh ubuntu 12.04 do:

   sudo apt-get -y install doxygen graphviz

2) cd to project folder and run:

   doxygent -g 

   to generate default doxygen config (Doxyfile)

3) modify Doxyfile (see diffs below or use attached config file)

4) run: doxygen

5) enjoy your docs (notice folder 'http' created) !

or take ready-to-go hot docs from my "drive through" place :)  here:

https://github.com/shevkoplyas/tradelink

choose file:

       File: tradelink.documentation.generated-by-doxygen.latest-r3754.tgz  (LATEST!)
Description: Huray! The latest docs generated using doxygen + revision 3754!

I felt necessity to generate latest docs because the one I found before (as a part of old wiki soft of) was generated in Apr 21 17:35:03 2009! 4 yrs ago!

Temporarily I put browsable preview of generated docs here for couple days:

http://54.221.231.186:8081/dmitry/html/index.html

# 1st file is default one, 2nd Doxyfile.dima is working one:

diff Doxyfile Doxyfile.dima

35c35

< PROJECT_NAME           = "My Project"

---

> PROJECT_NAME           = "tradelink.afterlife"

399c399

< EXTRACT_ALL            = NO

---

> EXTRACT_ALL            = YES

507c507

< FORCE_LOCAL_INCLUDES   = NO

---

> FORCE_LOCAL_INCLUDES   = YES

763c763

< RECURSIVE              = NO

---

> RECURSIVE              = YES

1346c1346

< GENERATE_TREEVIEW      = NO

---

> GENERATE_TREEVIEW      = YES

2043c2043

< HAVE_DOT               = NO

---

> HAVE_DOT               = YES

2109c2109

< UML_LOOK               = NO

---

> UML_LOOK               = YES

everyone have a good one,

cheers,

--
с ч.гл.ув.,
Дима Ш.