Sun Mar 12 20:40:48 CET 2006

doxygen and our licenses

Hello everybody.
After a short time without any blog activity, I would like to write a short entry about doxygen and our licenses (GNU GPL, GNU FDL and GNU LGPL).

First of all the intention to write this: I saw a lot of people on Savananh.GNU.org who have got a doxygen documentation without any license notices. But everytime I bugged them about this, they wrote to me that the documentation is auto generated and that they couldn't include any notices into it.

On the last weekend I had a look at doxygen because my pi-calculator needs a documentation and I found the doxygen option for HTML (for other output formats look at our own doxygen config): 

	HTML_HEADER            =

So I wrote there a <PATH>/doc/html/header.html.

Then I had to write into the file the default doxygen statements: 

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>__PROJECT__<title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>

<body>

I wrote above this doxygen header my copyright and license statement(s).
Have an additional look at our pages for help with the copyright notices and license notices (GPL, LGPL).

So in the end you have got an auto generated documentation but with a copyright and license header. You can follow this instructions for any other formats than HTML, too.

Thanks for reading my blog. Good night.


Posted by Sebastian Wieseler | Categories: general |