Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
doctypeproperty
overridefalse
Short DescriptionControls the rendering of documentation debug information.
NameDebug Mode
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
propertyAudience
hide
Tags

Tag List
names

heading-number

debug


Identifierprojectdoc.debug-mode

Component
Name List
doctypecomponent
propertyComponent

Mandatory
Data Typeboolean
Default Valuefalse
Value Rangetrue, false
Implementation
Iteration

Iteration
valuereleased

hide
Since4.12
Sort Keyhide
Section
show-titlefalse
titleDescription

The debug mode adds debug information regarding documentation issues.

This is a global property that is used by different tools.

Version Box
since4.13

Since version 4.13 the space property 

projectdoc-static-document-link-macro
documentDebug Access Mode
may impose additional constraints on whether or not debugging takes place.

projectdoc-section
titleSupporting Tools

The following tools support this mode.

Display Table
doctypeapp-macro, macro
selectName, Doctype|, Short Description
where$<Flags>=[debug-mode-support]

...

Section
titleResources

Display List
doctypeproperty
list-typedefinition
render-no-hits-as-blanktrue
render-short-descriptiontrue
uncapitalize-short-descriptiontrue
whereTags="heading-number"$<Tags>=[debug]