我注意到有doxygen的1.8.2一个奇怪的问题。 包括标题标签使头标题从输出HTML消失。
用下面的降价文件:
Title {#title}
=====
Section 1 {#section1}
---------
Text for section 1
我得到的输出:
标题
文字部分1
但是,如果我删除{#section1}
从降价文件标签,我得到正确的输出:
标题
第1节
文字部分1
什么是我在这里做了错误?
编辑我观察到以下警告,当我标记一个部分:
warning: found subsection command outside of section context!
经过一番调查,我已经决定了,这似乎是一个错误,但只是因为它是稍微反直观。
考虑以下:
The Main Section {#the_main_section}
================
Subsection One {#first}
--------------
Something highly interesting...
该文件与1级头开始(如描述这里 )等Doxygen的解析“一节中”作为名称和页面标题。 标题和标签{#the_main_section}
似乎被忽略,一旦头部已被改造成一个页面名称。
然后,该处理移动到文件的其余部分,当它达到“小节一号”,它认为没有父“节”为“子”(如“部分”转化为页面名称),这是它扼流圈。
更具体地,丢弃第(头),因为它认为,有没有父“部分”是。 所有其他的文本仍然存在,但被视为“页”(无父节)的一部分。
在“修正”是最初的“级别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!
在版本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]标签,从内容表中删除它。
我使用Doxygen的1.8.14和我有同样的问题。 我想分享我如何解决这个问题。
作为建议http://svenax.net/site/2013/07/creating-user-documentation-with-doxygen/我设置USE_MDFILE_AS_MAINPAGE = mainpage.md,并且也取得了一定要标记所有章节和小节。
正如莱斯特提到的文件需要两个1级标题。 然而,使其工作的第一个用“=========”的风格和第二的“#”的风格。 像这样:
My main page {#mainpage}
============
# Introduction {#intro}
Text.....
## A sub section {#subsection1}
Text... and a reference to the [Introduction](#intro).
有了这个我Doxygen的主页是工作的罚款。 所有出现的标题和工作的参考。 希望能帮助到你! =)
我有麻烦控制在我的Doxygen页面降价的称号; 我结束了使用的实际Doxygen的@page命令:
@page pageLabel与这是我的页面的标题
这让我参考使用@ref pageLabel与网页,并在我的网页部分它显示为:“这是我的页面的标题。”
这对我来说,因为我希望我的标题有空格,这是不可能的Doxygen的使用文件名作为标题特别有用。