Подтвердить что ты не робот

Заголовок заголовка на странице doxygen markdown приводит к исчезновению заголовка заголовка

Я замечаю странную проблему с 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!
4b9b3361

ОТВЕТЫ

Ответ 1

После некоторого расследования я решил, что это ошибка, но только потому, что она немного противоречит интуиции.

Рассмотрим следующее:

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

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

Something highly interesting...

Документ начинается с заголовка уровня 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 not!

Ответ 2

Такая же проблема в версии 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] под названием заголовка страницы, чтобы удалить его из таблицы содержимого.