Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 422354

Summary:	[generator.doc] check completeness with respect to escaping strings
Product:	[Modeling] eTrice	Reporter:	Henrik Rentz-Reichert <hrr>
Component:	Generators	Assignee:	Project Inbox <etrice.generators-inbox>
Status:	RESOLVED WONTFIX	QA Contact:
Severity:	minor
Priority:	P3	Keywords:	helpwanted
Version:	0.3.0
Target Milestone:	---
Hardware:	PC
OS:	Windows 7
Whiteboard:	consolidation

Description Henrik Rentz-Reichert

2013-11-22 11:38:06 EST

In LaTeX underscores are not allowed in non-math mode.
Therefore _ has to be escaped with \_ in those cases.

The documentation generator DocGen.xtend has a method escapedString which is used for this purpose.

There are two things to be checked:
* is the escaping applied everywhere but in generateDocText (because user documentation is supposed to be LaTeX compliant)?
* is the escaping complete or are there more characters and sequences that have to be escaped?

Comment 1 Henrik Rentz-Reichert

2013-11-22 11:51:12 EST

marked as helpwanted

Comment 2 Henrik Rentz-Reichert

2018-08-17 03:29:36 EDT

outdated bug - re-open if still relevant