#19 Doxygenfy Script

closed-accepted
nobody
None
4
2010-03-28
2010-03-20
Eibriel
No

Hi Okan!
I've created a Python script that easily converts descriptions and comments to Doxygen readable without sacrificing human readability.

Usage:
Make a copy of the source code as backup. You must apply Doxygenfy will DIRECTLY MODIFY each file and CAN NOT GENERATE BACKUPS, that's cause the complexity of the code + .svn files.
Copy doxygenfy.py to Trunk folder.
Run in terminal, and put the source location (./src)
On a second must override all the source.
Install Doxygen
Put Doxygen file on Trunk folder, and in terminal go to that folder and run: doxygen
Doxygen will generate a folder into doc: doc/doxygen/html
There is the documentation

You can compile to verify all work fine.

Some comments (a few) will be displaced and need manual correction.

The scripts modify from:
///////////////////////////////////////////////////////////////////////
//
// File : rndr.cpp
// Classes : -
// Description : rib parser
//
////////////////////////////////////////////////////////////////////////

to:

///////////////////////////////////////////////////////////////////////
//
// File : rndr.cpp
// Classes : -
// Description :
/// \brief rib parser
//
////////////////////////////////////////////////////////////////////////

With the correspondent tabulations.

Please let me know if it work on your code and if you apply it closing the Patch. If you can't apply let me know as well.

Regards,
Eibriel

Discussion

  • Eibriel
    Eibriel
    2010-03-20

    Doxy Utils

     
    Attachments
  • Eibriel
    Eibriel
    2010-03-20

    override = modify

     
  • Eibriel
    Eibriel
    2010-03-20

    • priority: 5 --> 4
     
  • Eibriel
    Eibriel
    2010-03-28

    • status: open --> closed-accepted