pxDoc Language renderer

The pxDoc language renderer is useful to render properly the code of a Generator or Module in your documentation. Typically, we used it to produce our Reference Guide,! (Have a look at the pxManual tool, we allow to produce documentation in both Word, HTML and Eclipse.documentation formats at once!

Installation

The pxDoc renderer is included in the pxDoc package.

Quick Start

To include pxDoccontent in your Generator, use the language keyword, as shown in the Reference Guide.

 

Extend the language renderer

All language renderers can be extended according to your needs. Check out the Reference Guide or this website to get soon a description on how to extend or develop new language renderers.

 

An example of extension is provided with the Capella enabler. It aims to:

  • Fine tune bullet list rendering
  • Add new types of hyperlinks (Capella defines hyperlinks starting with hlink:// in the description of items...)

You can find the source code of this language extension on GitLab.

Find the project on GitLab

You can find the source project on GitLab, in the pxdoc-plugins folder