Since there is no real documentation about openQA's lib/ functions I wanted to kill two birds with one stone and write a parser in perl that extracts all function names (and maybe preceding comments) in said directory and improve my perl knowledge by doing this.

Possible additions:

  • use the script to setup some fancy online documentation

  • automatically trigger a refresh when one of the files is changed

  • create doxygen-like call graphs

Done in Hackweek 0x10:

  • Parser that collects all functions in the lib folder (still hardcoded) and the according comments

  • generating a JSON from this information

TODO for future:

  • make it more flexible

  • create HTML from JSON

  • ?

Project can be found here:

Looking for hackers with the skills:

Nothing? Add some keywords!

This project is part of:

Hack Week 16


  • okurz
    over 2 years ago by okurz | Reply

    Nice idea. You might want to take a look into the way that openQA does it:

    I recommend you take a look into and as well

  • ikapelyukhin
    over 2 years ago by ikapelyukhin | Reply

    Feel free to reach out to me if you need help with Perl. :-)

Similar Projects

This project is one of its kind!