Author Topic: Doxygen and XWorkplace  (Read 5063 times)

Martin Iturbide

  • OS2World NewsMaster
  • Global Moderator
  • Hero Member
  • *****
  • Posts: 4713
  • Karma: +41/-1
  • Your Friend Wil Declares...
    • View Profile
    • Martin's Personal Blog
Doxygen and XWorkplace
« on: August 27, 2014, 07:55:40 pm »
"Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D."

http://www.stack.nl/~dimitri/doxygen/

It is open source, there not an updated version for OS/2, and the GUI tool for OS/2 seems to only run on X11.
So I tried on Windows first and made a quick and dirty report from the XWorkplace code.

I really liked what the tool generated.

Martin Iturbide
OS2World NewsMaster
... just share the dream.

Mentore

  • Full Member
  • ***
  • Posts: 152
  • Karma: +4/-0
    • View Profile
Re: Doxygen and XWorkplace
« Reply #1 on: August 28, 2014, 09:00:23 am »
ISTR Doxygen is used to document a number of big projects, like OpenSG (I'm using it at work).

Still, it is a (albeit good) starting point: I feel that a real documentation needs to explain not only the class structures but many other things.

For one, the same OpenSG I'm using is thoroughly described by the Doxygen pages over the web, but still is poorly documented and fairly difficult to use.

Dave Yeo

  • Hero Member
  • *****
  • Posts: 4787
  • Karma: +99/-1
    • View Profile
Re: Doxygen and XWorkplace
« Reply #2 on: August 28, 2014, 04:31:48 pm »
Helps to have good doxygen compatible comments.