doxypress icon indicating copy to clipboard operation
doxypress copied to clipboard

Invisible markdown labeled-headings

Open Sp3EdeR opened this issue 6 years ago • 5 comments
trafficstars

When adding a markdown heading with the header ID extension, the following issues are exhibited:

  • The generated HTML page contains empty text for the heading (the anchor is still generated)
  • The page tree does not contain the section index
    • Probably the same issue as the above, but no page documentation is created for pages that specify their title as a level-1 heading with an ID.

This is a regression issue, version 1.2.10 worked fine, master (1.3.5) shows this issue.

Sp3EdeR avatar Oct 16 '19 11:10 Sp3EdeR

I have started debugging this issue...

Sp3EdeR avatar Oct 16 '19 11:10 Sp3EdeR

Warnings generated:

C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:1: Warning: Multiple use of section label '', (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)
C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:1: Warning: Multiple use of section label 'guides_core_threading_btm' while adding section, (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)
C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:4: Warning: Multiple use of section label 'autotoc_md171' while adding section, (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)
C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:17: Warning: Multiple use of section label 'guides_core_threading_btm_scheduling' while adding section, (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)
C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:24: Warning: Multiple use of section label 'autotoc_md172' while adding section, (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)
C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:38: Warning: Multiple use of section label 'autotoc_md173' while adding section, (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)
C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:42: Warning: Multiple use of section label 'autotoc_md174' while adding section, (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)
C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:55: Warning: Multiple use of section label 'guides_core_threading_btm_scheduling' while adding section, (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)
C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:62: Warning: Multiple use of section label 'autotoc_md175' while adding section, (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)
C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md:76: Warning: Multiple use of section label 'autotoc_md176' while adding section, (first occurrence: C:/Projects/product_config/engine/modules/core/mod_core/doc/guides/internal/btm/btm.md, line 1)

For document structure:

Background Task Manager {#guides_core_threading_btm}
=======================

# What is the Background Task Manager?

## What are the tasks like?

# Scheduling {#guides_core_threading_btm_scheduling}

# BTM Extensions

## Background Task Queue

## Async++ BTM Scheduler

# Guide Topics

Sp3EdeR avatar Oct 16 '19 13:10 Sp3EdeR

I've found the reason why the titles got emptied and provided a workaround that I think looks better than the original code. There is still something fishy going on in the background however, since the expression QStringView(title.constBegin(), match.capturedStart()) results in an empty string. Unfortunately with next to no debugging functionality in my current environment, I do not see the root cause.

I'm testing with CopperSpice prebuilt 1.6 release and a compiled version of master/1.3.5 Doxypress on Windows. The issue seems to be in CopperSpice to me.

Markdown sections and .md pages are still missing from the page tree (but do exist as generated content/files).

Sp3EdeR avatar Oct 16 '19 16:10 Sp3EdeR

As far as I can test it, this issue seems all-fixed now on my fork.

Sp3EdeR avatar Oct 18 '19 14:10 Sp3EdeR

Thanks, we will look at this over the weekend.

bgeller avatar Oct 18 '19 16:10 bgeller