2012-11-30 2 views
17

doxygen 1.8.2에 이상한 문제가 있습니다. 머리글 레이블을 포함 시키면 머리글 제목이 출력 html에서 사라집니다. 내가 경우, 섹션 1doxygen markdown 페이지의 헤더 레이블이 헤더 제목을 사라지게합니다.

에 대한

텍스트

제목하지만 다음 가격 인하 파일로

:

Title   {#title} 
===== 

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

나는 같은 출력을 얻을삭제 Markdown을 파일에서라벨, I는 정확한 출력을 얻을 :

제목을

제 1

실수는 무엇인가 섹션 1

의 텍스트 I 여기 만들고 있니? 일부 조사 후

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에이 버그가 있습니다! 솔루션을 주셔서 감사합니다 Lester :) – 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] 태그를 페이지 제목 정의 아래에 두어 내용 표에서 태그를 제거 할 수도 있습니다.