[Doxygen-develop] [PATCH] New output format
Brought to you by:
dimitri
From: Miguel <mig...@te...> - 2002-09-08 11:38:41
|
Hi. This is a patch against current CVS to add a new output format I've called "Perl". "Perl" is intended as an intermediate format that can be used to generate new and customized output formats without having to modify the Doxygen source. I think it can coexist with the XML intermediate format that it is currently being worked on; "Perl" is simpler and easier to use but not as standard and powerful as XML. The name "Perl" is because, you guessed it, the output consists of Perl code. When you activate the new GENERATE_PERL config option, a Perl module called "DoxyDocs.pm" is created in the user's OUTPUT_DIRECTORY. Then the user can run a custom Perl script using that Perl module to generate the desired output format. The contents of the Perl module is a single statement, assigning to the variable $doxydocs a reference to a tree-like structure composed of anonymous hashes and arrays. I think this method is at the same time flexible and easy to use. Also attached is an example Perl script that generates a simple human-readable text format using DoxyDocs.pm. Please note that the Perl output format is at the moment fairly incomplete and probably buggy. I'm sending it so I can get your comments and suggestions. If the feedback is positive I will try to complete it before the next Doxygen release. So, what do you think about it? -- Miguel |