読者です 読者をやめる 読者になる 読者になる

doxygenのHTMLドキュメントでフッター(footer)とヘッダー(header)を指定する

doxygen

doxygenが生成するHTMLドキュメントにプロジェクトのURLやGoogle AdSenseなどのアフィリエイトを含めたい場合には、ドキュメントのヘッダーとフッターを指定してその中に記述します。
フッターファイルとヘッダーファイルは、Doxyfileの『HTML_HEADER』『HTML_FOOTER』それぞれにファイルのパスを指定します。

HTML_HEADER

HTML_HEADERで指定するファイルには〜の先頭までが含まれます。
標準のCSSやページタイトルなども記述する必要があります。

HTML_FOOTER

HTML_FOOTERで指定するファイルには〜までが含まれます。
と閉じる必要があります。

キーワード置換

フッターとヘッダーではキーワード置換が行えます。キーワード置換ではドキュメント生成時に特定のキーワードをDoxygenが書き換えてくれます。
ヘッダーに記述するページのタイトル()などは、ページごとに変わるので、この機能を使うことになります。

キーワードには次のものがあります。

キーワード 説明
$projectname Doxyfileの『PROJECT_NAME』 libpiyo
$projectnumber Doxyfileの『PROJECT_NUMBER』 1.0
$title ページのタイトル libpiyo: piyo_initialize
$date doxygen実行日付 10 Jun 2007
$datetime doxygen実行日時 Sun Jun 10 16:36:17 2007
$doxygenversion doxygenのバージョン 1.52

ヘッダーの例

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>APIリファレンス: $title</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<span style="font-size: 0.8em;">
	<a href="http://sourceforge.net/projects/$projectname">$projectname $projectnumber</a>
</span>
<hr/>

フッターの例

<hr/>
<div style="text-align:right;font-size: 0.8em;">
	このドキュメントは
	<a href="http://www.doxygen.org/index.html">Doxygen</a>
	$doxygenversionにより$datetimeに生成されました。<br/>
</div>
</body>
</html>