2012-11-30 10 views
17

doxygen 1.8.2で奇妙な問題が発生しました。ヘッダーラベルを含めると、ヘッダーのタイトルが出力HTMLから消えます。doxygen markdownのヘッダー・ラベルでヘッダー・タイトルが消えます

次値下げファイルで

:I場合は、セクション1

ため

タイトル

テキストしかし、私のように出力を得る

Title   {#title} 
===== 

Section 1  {#section1} 
--------- 
Text for section 1 

を削除間違いが私である何セクション1

ため

タイトル

第1

テキスト:マークダウンファイルからラベルが、私は正しい出力を得ますここに作っていますか?

編集私はセクションラベルを付けたときに次の警告を観察:いくつかの調査の後

warning: found subsection command outside of section context! 
+0

Doxygen 1.8.2の既定の生成された構成ファイルを使用して簡単なテストケースでこの現象を再現することができませんでした。スタンドアローンのテストケースで、または大きなドキュメントセットの一部としてこの動作が見えますか?設定ファイルを含め、作業しているファイルの正確な内容を投稿する必要があるかもしれません。 – DRH

+0

1.8.8と同じ「問題」です。まったく同じことをしたREADME.mdがありましたが、一番上のヘッダーのラベルはありませんでした。 –

答えて

19

を、私はこのはバグに表示されますが、それは少し反直感的であるという理由だけで決めました。

は、以下を考慮してください

The Main Section {#the_main_section} 
================ 

Subsection One {#first} 
-------------- 

Something highly interesting... 

hereに記載されているように)ドキュメントはレベル1ヘッダで始まり、そうDoxygenのページの名前及びタイトルとして「メインセクション」を解析します。ヘッダーとラベル{#the_main_section}は、ヘッダーがページ名に変換されると無視されます。

処理は文書の残りの部分に移動し、「サブセクション1」に達すると、「サブセクション」の親「セクション」はないと考えられます(「セクション」がページに変換されたため名前)これはそれが窒息するところです。

具体的には、親「セクション」がないと考えられるので、サブセクション(ヘッダー)を破棄します。他のすべてのテキストは残りますが、セクションの親を持たない「ページ」の一部として扱われます。

「修正」は、最初の「レベル1ヘッダー」の後に別の「レベル1ヘッダー」を追加することです。

My Great Documentation (Which Becomes the Page Name) 
==================================================== 

The First Section 
================= 

Q. What? I already created a level 1 heading? 
A. Yup, but that was converted to a page name/title and discarded, so now 
    we have to create another level 1 heading for my first section. Don't 
    be fooled into thinking that the opening heading in this document is 
    still treated as an opening heading by Doxygen - it's not! 
+2

ラベルを削除すると、Markdownの外観が正しく動作するようになる理由は、これでも説明できません(また、わかりません)。ラベルを取り除いて '[TOC]'を文書に追加しようとするとTOCが生成されないので、 "出現を与える"と私は言います。上記の「回避策」を実装すると、解析されたドキュメントは正しく表示されます。**には、セクション/サブセクションの見出しへのリンクを含む目次が含まれます。 –

+0

ここに、あなたのコメントからのものを含むこれらの問題について説明するページがあります:http://svenax.net/site/2013/07/creating-user-documentation-with-doxygen/言及されていない唯一のことは、一番上のヘッダー(ページ名を除く)を含むセクションのすべてにラベルを付けないことは、目次だけでなくページ自体にまったく表示されないことです。 –

+1

** Google担当者への注意:** 2015年であり、doxygen 1.8.9.1にはまだこのバグがあります!ソリューションのおかげでレスター:) – MickyD

1

バージョン1.8.9.1と同じ問題です。 ---の代わりに#タグを使用することで回避できます。例えば

[TOC] 

Page Title {#pageTitle} 
========== 
Lorem ipsum dolor sit amet 

# section 1 {#section1} 
Lorem ipsum dolor sit amet 

## Section 1.1 {#section1-1} 
Lorem ipsum dolor sit amet 

# section 2 {#section2} 
Lorem ipsum dolor sit amet 

# section 3 {#section3} 
Lorem ipsum dolor sit amet 

## section 3.1 {#section3-1} 
Lorem ipsum dolor sit amet 

# section 4 {#section4} 
Lorem ipsum dolor sit amet 

が動作します。[TOC]タグをページのタイトル定義の下に配置して、コンテンツの表からタグを削除することもできます。

関連する問題