Skip to content

AndrewOfC/doxyboiler

Repository files navigation

Overview

Python script to add 'boilerplate' Doxygen comments to header files en masse using the CppHeaderParser.

Comments are formatted using jinja2 templates.

Goal

Produce a pypi package installable via pip/virtualenv

Usage (proposal)

$ doxyboiler.py [options...] files
Option Value/Effect
-v increase verbosity.

Once, count of insertions
Twice, each insertion listed
Three, text of comments applied
--templates dir template file directory to use
--copy-templates dir copy default templates to dir

Templates may then be customized and used with the --templates option

Project Setup

$ git clone https://github.com/AndrewOfC/doxyboiler.git
$ cd doxyboiler
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt

Notes

Examples

Before&After

References

About

python script to add Doxygen boilerplate

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published