markdown - comment - doxygen python example
etiqueta de encabezado en la página de rebaja de doxygen hace desaparecer el título del encabezado (3)
Después de algunas investigaciones, he decidido que esto parece ser un error, pero solo porque es ligeramente contraintuitivo.
Considera lo siguiente:
The Main Section {#the_main_section}
================
Subsection One {#first}
--------------
Something highly interesting...
El documento comienza con un encabezado de nivel 1 (como se describe here ) y Doxygen analiza "La sección principal" como el nombre y el título de la página. El encabezado y la etiqueta {#the_main_section} parecen no tenerse en cuenta una vez que el encabezado se ha convertido en un nombre de página.
Luego, el procesamiento pasa al resto del documento y cuando llega a la "Subsección Uno", cree que no hay una "Sección" principal para la "subsección" (ya que la "Sección" se convirtió en un nombre de página) y esto es donde se ahoga.
Más específicamente, descarta la subsección (encabezado) ya que cree que no hay una "sección" principal. Todo el resto del texto permanece, pero se trata como parte de la "página" (sin la sección principal).
La "solución" es agregar otro "encabezado de nivel 1" después del "encabezado de nivel 1" inicial, por ejemplo,
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!
Noto un extraño problema con el doxygen 1.8.2. La inclusión de una etiqueta de encabezado hace que el título del encabezado desaparezca del código HTML de salida.
Con el siguiente archivo de rebajas:
Title {#title}
=====
Section 1 {#section1}
---------
Text for section 1
Obtengo la salida como:
Título
Texto para la sección 1
Pero, si {#section1} etiqueta {#section1} del archivo markdown, obtengo la salida correcta como:
Título
Sección 1
Texto para la sección 1
¿Cuál es el error que estoy cometiendo aquí?
Editar Observé la siguiente advertencia cuando etiqueté una sección:
warning: found subsection command outside of section context!
Estoy usando Doxygen 1.8.14 y tuve el mismo problema. Quiero compartir cómo lo resuelvo.
Como se sugirió en svenax.net/site/2013/07/… Establecí USE_MDFILE_AS_MAINPAGE = mainpage.md, y también me aseguré de etiquetar todas las secciones y subsecciones.
Como lo mencionó Lester Burnham, el documento necesita dos encabezados de nivel 1. Sin embargo, para que funcione, el primero con el estilo "=========" y el segundo con el estilo "#". Me gusta esto:
My main page {#mainpage}
============
# Introduction {#intro}
Text.....
## A sub section {#subsection1}
Text... and a reference to the [Introduction](#intro).
Con esto mi página principal de Doxygen está funcionando bien. Aparecen todos los encabezados y las referencias funcionando. ¡Espero eso ayude! =)
Mismo problema en la versión 1.8.9.1. Puedes evitarlo usando # tags en lugar de ---.
Por ejemplo:
[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
trabajará. Incluso puede poner la etiqueta [TOC] debajo de la definición de Título de la página para eliminarla de la tabla de contenido.