ldoc icon indicating copy to clipboard operation
ldoc copied to clipboard

Blank summaries in table of examples in index page

Open GrahamHannington opened this issue 11 years ago • 1 comments
trafficstars

The default template generates a project-level index page that contains a two-column table for each kind of module, such as topics ("Manual"), code modules, and examples. The columns contain the module name and summary.

I'd hoped that the table of examples would pick up the first comment line from each example, and use that as the summary, but instead, the summary column is blank for examples. Am I missing something, or does LDoc simply not populate the summary property of examples from the example source code? I've looked at the LDoc source code, and I can't see anything that does this; but that doesn't mean it's not there. :grin: For now, I'm going to suppress the table of examples from the index page.

P.S. In config.ld, I'm specifying use_markdown_titles=true, a field that is not currently documented in Fields allowed in config.ld. This causes the navigation pane (<div id="navigation">) to display the # heading text from the .md files, rather than the .md file names without their .md extensions. So the table of Manual topics in the index page is effectively redundant, and I'm suppressing it.

GrahamHannington avatar Sep 04 '14 06:09 GrahamHannington

As best as I can tell this is still an issue, but it is pretty hard to tell without an MWE. If anybody is still interested in this I could help facilitate any PR contributions, but also commenting here with a full MWE showing the problem situation would help move this along.

alerque avatar May 03 '23 10:05 alerque